{ "info": { "author": "Gordon Chiam", "author_email": "gordon.chiam@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 3" ], "description": "# YNAB API v1 Python Client\nOur API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body. API Documentation is at https://api.youneedabudget.com\n\nThis Python package is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:\n\n- API version: 1.0.0\n- Build package: io.swagger.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 2.7 and 3.4+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on Github, you can install directly from Github\n\n```sh\npip install ynab-client\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/gchiam/ynab-client-python.git`)\n\nThen import the package:\n```python\nimport ynab_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport ynab_client\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nfrom __future__ import print_function\nimport time\nimport ynab_client\nfrom ynab_client.rest import ApiException\nfrom pprint import pprint\n\n# Configure API key authorization: bearer\nconfiguration = ynab_client.Configuration()\nconfiguration.api_key_prefix['Authorization'] = 'Bearer'\nconfiguration.api_key['Authorization'] = 'YOUR_API_KEY'\n\n# create an instance of the API class\napi_instance = ynab_client.BudgetsApi()\n\ntry:\n api_response = api_instance.get_budgets()\n pprint(api_response)\nexcept ApiException as e:\n print(\"Exception when calling BudgetApi->get_budgets: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.youneedabudget.com/v1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*AccountsApi* | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | **GET** /budgets/{budget_id}/accounts/{account_id} | Single account\n*AccountsApi* | [**get_accounts**](docs/AccountsApi.md#get_accounts) | **GET** /budgets/{budget_id}/accounts | Account list\n*BudgetsApi* | [**get_budget_by_id**](docs/BudgetsApi.md#get_budget_by_id) | **GET** /budgets/{budget_id} | Single budget\n*BudgetsApi* | [**get_budget_settings_by_id**](docs/BudgetsApi.md#get_budget_settings_by_id) | **GET** /budgets/{budget_id}/settings | Budget Settings\n*BudgetsApi* | [**get_budgets**](docs/BudgetsApi.md#get_budgets) | **GET** /budgets | List budgets\n*CategoriesApi* | [**get_categories**](docs/CategoriesApi.md#get_categories) | **GET** /budgets/{budget_id}/categories | List categories\n*CategoriesApi* | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | **GET** /budgets/{budget_id}/categories/{category_id} | Single category\n*MonthsApi* | [**get_budget_month**](docs/MonthsApi.md#get_budget_month) | **GET** /budgets/{budget_id}/months/{month} | Single budget month\n*MonthsApi* | [**get_budget_months**](docs/MonthsApi.md#get_budget_months) | **GET** /budgets/{budget_id}/months | List budget months\n*PayeeLocationsApi* | [**get_payee_location_by_id**](docs/PayeeLocationsApi.md#get_payee_location_by_id) | **GET** /budgets/{budget_id}/payee_locations/{payee_location_id} | Single payee location\n*PayeeLocationsApi* | [**get_payee_locations**](docs/PayeeLocationsApi.md#get_payee_locations) | **GET** /budgets/{budget_id}/payee_locations | List payee locations\n*PayeeLocationsApi* | [**get_payee_locations_by_payee**](docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/payee_locations | List locations for a payee\n*PayeesApi* | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | **GET** /budgets/{budget_id}/payees/{payee_id} | Single payee\n*PayeesApi* | [**get_payees**](docs/PayeesApi.md#get_payees) | **GET** /budgets/{budget_id}/payees | List payees\n*ScheduledTransactionsApi* | [**get_scheduled_transaction_by_id**](docs/ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **GET** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction\n*ScheduledTransactionsApi* | [**get_scheduled_transactions**](docs/ScheduledTransactionsApi.md#get_scheduled_transactions) | **GET** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions\n*TransactionsApi* | [**bulk_create_transactions**](docs/TransactionsApi.md#bulk_create_transactions) | **POST** /budgets/{budget_id}/transactions/bulk | Bulk create transactions\n*TransactionsApi* | [**create_transaction**](docs/TransactionsApi.md#create_transaction) | **POST** /budgets/{budget_id}/transactions | Create new transaction\n*TransactionsApi* | [**get_transactions**](docs/TransactionsApi.md#get_transactions) | **GET** /budgets/{budget_id}/transactions | List transactions\n*TransactionsApi* | [**get_transactions_by_account**](docs/TransactionsApi.md#get_transactions_by_account) | **GET** /budgets/{budget_id}/accounts/{account_id}/transactions | List account transactions\n*TransactionsApi* | [**get_transactions_by_category**](docs/TransactionsApi.md#get_transactions_by_category) | **GET** /budgets/{budget_id}/categories/{category_id}/transactions | List category transactions\n*TransactionsApi* | [**get_transactions_by_id**](docs/TransactionsApi.md#get_transactions_by_id) | **GET** /budgets/{budget_id}/transactions/{transaction_id} | Single transaction\n*TransactionsApi* | [**get_transactions_by_payee**](docs/TransactionsApi.md#get_transactions_by_payee) | **GET** /budgets/{budget_id}/payees/{payee_id}/transactions | List payee transactions\n*TransactionsApi* | [**update_transaction**](docs/TransactionsApi.md#update_transaction) | **PUT** /budgets/{budget_id}/transactions/{transaction_id} | Updates an existing transaction\n*UserApi* | [**get_user**](docs/UserApi.md#get_user) | **GET** /user | User info\n\n\n## Documentation For Models\n\n - [Account](docs/Account.md)\n - [AccountResponse](docs/AccountResponse.md)\n - [AccountWrapper](docs/AccountWrapper.md)\n - [AccountsResponse](docs/AccountsResponse.md)\n - [AccountsWrapper](docs/AccountsWrapper.md)\n - [BudgetDetailResponse](docs/BudgetDetailResponse.md)\n - [BudgetDetailWrapper](docs/BudgetDetailWrapper.md)\n - [BudgetSettings](docs/BudgetSettings.md)\n - [BudgetSettingsResponse](docs/BudgetSettingsResponse.md)\n - [BudgetSettingsWrapper](docs/BudgetSettingsWrapper.md)\n - [BudgetSummary](docs/BudgetSummary.md)\n - [BudgetSummaryResponse](docs/BudgetSummaryResponse.md)\n - [BudgetSummaryWrapper](docs/BudgetSummaryWrapper.md)\n - [BulkIdWrapper](docs/BulkIdWrapper.md)\n - [BulkIds](docs/BulkIds.md)\n - [BulkResponse](docs/BulkResponse.md)\n - [BulkTransactions](docs/BulkTransactions.md)\n - [CategoriesResponse](docs/CategoriesResponse.md)\n - [Category](docs/Category.md)\n - [CategoryGroup](docs/CategoryGroup.md)\n - [CategoryGroupsWrapper](docs/CategoryGroupsWrapper.md)\n - [CategoryResponse](docs/CategoryResponse.md)\n - [CategoryWrapper](docs/CategoryWrapper.md)\n - [CurrencyFormat](docs/CurrencyFormat.md)\n - [DateFormat](docs/DateFormat.md)\n - [ErrorDetail](docs/ErrorDetail.md)\n - [ErrorResponse](docs/ErrorResponse.md)\n - [HybridTransactionsResponse](docs/HybridTransactionsResponse.md)\n - [HybridTransactionsWrapper](docs/HybridTransactionsWrapper.md)\n - [MonthDetailResponse](docs/MonthDetailResponse.md)\n - [MonthDetailWrapper](docs/MonthDetailWrapper.md)\n - [MonthSummariesResponse](docs/MonthSummariesResponse.md)\n - [MonthSummariesWrapper](docs/MonthSummariesWrapper.md)\n - [MonthSummary](docs/MonthSummary.md)\n - [Payee](docs/Payee.md)\n - [PayeeLocation](docs/PayeeLocation.md)\n - [PayeeLocationResponse](docs/PayeeLocationResponse.md)\n - [PayeeLocationWrapper](docs/PayeeLocationWrapper.md)\n - [PayeeLocationsResponse](docs/PayeeLocationsResponse.md)\n - [PayeeLocationsWrapper](docs/PayeeLocationsWrapper.md)\n - [PayeeResponse](docs/PayeeResponse.md)\n - [PayeeWrapper](docs/PayeeWrapper.md)\n - [PayeesResponse](docs/PayeesResponse.md)\n - [PayeesWrapper](docs/PayeesWrapper.md)\n - [SaveTransaction](docs/SaveTransaction.md)\n - [SaveTransactionWrapper](docs/SaveTransactionWrapper.md)\n - [ScheduledSubTransaction](docs/ScheduledSubTransaction.md)\n - [ScheduledTransactionResponse](docs/ScheduledTransactionResponse.md)\n - [ScheduledTransactionSummary](docs/ScheduledTransactionSummary.md)\n - [ScheduledTransactionWrapper](docs/ScheduledTransactionWrapper.md)\n - [ScheduledTransactionsResponse](docs/ScheduledTransactionsResponse.md)\n - [ScheduledTransactionsWrapper](docs/ScheduledTransactionsWrapper.md)\n - [SubTransaction](docs/SubTransaction.md)\n - [TransactionResponse](docs/TransactionResponse.md)\n - [TransactionSummary](docs/TransactionSummary.md)\n - [TransactionWrapper](docs/TransactionWrapper.md)\n - [TransactionsResponse](docs/TransactionsResponse.md)\n - [TransactionsWrapper](docs/TransactionsWrapper.md)\n - [User](docs/User.md)\n - [UserResponse](docs/UserResponse.md)\n - [UserWrapper](docs/UserWrapper.md)\n - [BudgetDetail](docs/BudgetDetail.md)\n - [CategoryGroupWithCategories](docs/CategoryGroupWithCategories.md)\n - [HybridTransaction](docs/HybridTransaction.md)\n - [MonthDetail](docs/MonthDetail.md)\n - [ScheduledTransactionDetail](docs/ScheduledTransactionDetail.md)\n - [TransactionDetail](docs/TransactionDetail.md)\n\n\n## Documentation For Authorization\n\n\n## bearer\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/gchiam/ynab-client-python", "keywords": "", "license": "Apache2", "maintainer": "", "maintainer_email": "", "name": "ynab-client", "package_url": "https://pypi.org/project/ynab-client/", "platform": "", "project_url": "https://pypi.org/project/ynab-client/", "project_urls": { "Homepage": "https://github.com/gchiam/ynab-client-python" }, "release_url": "https://pypi.org/project/ynab-client/0.1.8/", "requires_dist": [ "urllib3 (>=1.15)", "six (>=1.10)", "certifi", "python-dateutil" ], "requires_python": "", "summary": "YNAB API v1 Python Client", "version": "0.1.8" }, "last_serial": 4089191, "releases": { "0.1.5": [ { "comment_text": "", "digests": { "md5": "f166c0632a21638c0085910fcee07e2b", "sha256": "8f57c75fd1a87baa5900b1420af302d80233f8a4a8d42daf29c156d42f638f3b" }, "downloads": -1, "filename": "ynab_client-0.1.5-py3-none-any.whl", "has_sig": false, "md5_digest": "f166c0632a21638c0085910fcee07e2b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 193016, "upload_time": "2018-07-21T19:54:48", "url": "https://files.pythonhosted.org/packages/bb/3c/cdc098a06e7a7a76817f0d42ea0636bebdb10fb913a11e5d84ce6b3d74af/ynab_client-0.1.5-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "dc6f23f05bbfbff5428480e1fadbed8e", "sha256": "b9f4f480dce828922d9d4f61bd823a79a02c2a29b47e6c29f44b657847a1b0f5" }, "downloads": -1, "filename": "ynab_client-0.1.5.tar.gz", "has_sig": false, "md5_digest": "dc6f23f05bbfbff5428480e1fadbed8e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45779, "upload_time": "2018-07-21T19:54:49", "url": "https://files.pythonhosted.org/packages/fb/c8/3b103b8008b310315f981162a143b55d13107970fcb5aa58f0a1da57ee2d/ynab_client-0.1.5.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "10c84aa241b28e163e5b36a0cf889e4d", "sha256": "3a8428c49c778a399ab5305bc2c40ec4cec1ea7fb390a74aa66398d942b56457" }, "downloads": -1, "filename": "ynab_client-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "10c84aa241b28e163e5b36a0cf889e4d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 193043, "upload_time": "2018-07-21T20:03:55", "url": "https://files.pythonhosted.org/packages/5d/37/6f89621f45e36d59d7c474e08a7f4202d0521912e40a2859786cf8d69a9c/ynab_client-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d7a2b11d009f3acdf24a50b0b0990934", "sha256": "21abac3114ee7852ccee8418db627265a123478046caa3fcd8eb8449fca19a19" }, "downloads": -1, "filename": "ynab_client-0.1.6.tar.gz", "has_sig": false, "md5_digest": "d7a2b11d009f3acdf24a50b0b0990934", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45845, "upload_time": "2018-07-21T20:03:57", "url": "https://files.pythonhosted.org/packages/12/65/a987b55692bddcb1504aa902196d26b027e2c159044432fb2bbd465849ab/ynab_client-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "8837a7093ed97dea47aec934c1bdb442", "sha256": "ffda8f1b8ffaf565e67bcdd1f69f8f4c973bf0989552d61f637db7b0cc4f8463" }, "downloads": -1, "filename": "ynab_client-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "8837a7093ed97dea47aec934c1bdb442", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 193034, "upload_time": "2018-07-21T20:06:04", "url": "https://files.pythonhosted.org/packages/e8/f2/db90e6120b34210b08772e3347283cd6abbea4caeed0100f6e3ecba8b0c0/ynab_client-0.1.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "8355b19c121723e673b6c5cc05b0dce4", "sha256": "e9882996abaa62f026ddec46014b8af1f419adaba53555c672f65d24e7010928" }, "downloads": -1, "filename": "ynab_client-0.1.7.tar.gz", "has_sig": false, "md5_digest": "8355b19c121723e673b6c5cc05b0dce4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45822, "upload_time": "2018-07-21T20:06:05", "url": "https://files.pythonhosted.org/packages/78/46/482ab92accd46d43f1385da4fa2069c559fbdbe902711e2715e81de66cab/ynab_client-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "5bc5d18ca05fb5dd932f4f65bfbbcbcb", "sha256": "7301eeaf7ef8836d9faf63c65c03703f7acfc432b5babe94ea207f68e282b0a7" }, "downloads": -1, "filename": "ynab_client-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "5bc5d18ca05fb5dd932f4f65bfbbcbcb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 193028, "upload_time": "2018-07-21T20:10:20", "url": "https://files.pythonhosted.org/packages/9f/77/81dfbddab86d71c753fa2283f02ae1fbaddbbfc9d346bb25d13836a93929/ynab_client-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "144e4988299d03f923e81d1c3498a29f", "sha256": "d6289c5d3c80c2a35698e5953cdebd7d007c9e38821b61cf8c699e48b9a4f0e7" }, "downloads": -1, "filename": "ynab_client-0.1.8.tar.gz", "has_sig": false, "md5_digest": "144e4988299d03f923e81d1c3498a29f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45823, "upload_time": "2018-07-21T20:10:23", "url": "https://files.pythonhosted.org/packages/d3/b7/7472bcdc6bd57b00509c15c5745345e588412c1376b289fb240ddaf11c8b/ynab_client-0.1.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5bc5d18ca05fb5dd932f4f65bfbbcbcb", "sha256": "7301eeaf7ef8836d9faf63c65c03703f7acfc432b5babe94ea207f68e282b0a7" }, "downloads": -1, "filename": "ynab_client-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "5bc5d18ca05fb5dd932f4f65bfbbcbcb", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 193028, "upload_time": "2018-07-21T20:10:20", "url": "https://files.pythonhosted.org/packages/9f/77/81dfbddab86d71c753fa2283f02ae1fbaddbbfc9d346bb25d13836a93929/ynab_client-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "144e4988299d03f923e81d1c3498a29f", "sha256": "d6289c5d3c80c2a35698e5953cdebd7d007c9e38821b61cf8c699e48b9a4f0e7" }, "downloads": -1, "filename": "ynab_client-0.1.8.tar.gz", "has_sig": false, "md5_digest": "144e4988299d03f923e81d1c3498a29f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 45823, "upload_time": "2018-07-21T20:10:23", "url": "https://files.pythonhosted.org/packages/d3/b7/7472bcdc6bd57b00509c15c5745345e588412c1376b289fb240ddaf11c8b/ynab_client-0.1.8.tar.gz" } ] }