Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,5 +62,5 @@ docs/_build/
# PyBuilder
target/

#Ipython Notebook
# Ipython Notebook
.ipynb_checkpoints
95 changes: 75 additions & 20 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,6 @@ docs/AccountType.md
docs/AccountsApi.md
docs/AccountsResponse.md
docs/AccountsResponseData.md
docs/BudgetDetail.md
docs/BudgetDetailResponse.md
docs/BudgetDetailResponseData.md
docs/BudgetSettings.md
docs/BudgetSettingsResponse.md
docs/BudgetSettingsResponseData.md
docs/BudgetSummary.md
docs/BudgetSummaryResponse.md
docs/BudgetSummaryResponseData.md
docs/BudgetsApi.md
docs/BulkResponse.md
docs/BulkResponseData.md
docs/BulkResponseDataBulk.md
Expand All @@ -32,18 +22,28 @@ docs/CurrencyFormat.md
docs/DateFormat.md
docs/ErrorDetail.md
docs/ErrorResponse.md
docs/ExistingCategory.md
docs/ExistingTransaction.md
docs/HybridTransaction.md
docs/HybridTransactionsResponse.md
docs/HybridTransactionsResponseData.md
docs/MoneyMovement.md
docs/MoneyMovementGroup.md
docs/MoneyMovementGroupsResponse.md
docs/MoneyMovementGroupsResponseData.md
docs/MoneyMovementsApi.md
docs/MoneyMovementsResponse.md
docs/MoneyMovementsResponseData.md
docs/MonthDetail.md
docs/MonthDetailResponse.md
docs/MonthDetailResponseData.md
docs/MonthSummariesResponse.md
docs/MonthSummariesResponseData.md
docs/MonthSummary.md
docs/MonthsApi.md
docs/NewCategory.md
docs/NewTransaction.md
docs/PatchCategoryGroupWrapper.md
docs/PatchCategoryWrapper.md
docs/PatchMonthCategoryWrapper.md
docs/PatchPayeeWrapper.md
Expand All @@ -60,13 +60,28 @@ docs/PayeeResponseData.md
docs/PayeesApi.md
docs/PayeesResponse.md
docs/PayeesResponseData.md
docs/PlanDetail.md
docs/PlanDetailResponse.md
docs/PlanDetailResponseData.md
docs/PlanSettings.md
docs/PlanSettingsResponse.md
docs/PlanSettingsResponseData.md
docs/PlanSummary.md
docs/PlanSummaryResponse.md
docs/PlanSummaryResponseData.md
docs/PlansApi.md
docs/PostAccountWrapper.md
docs/PostCategoryGroupWrapper.md
docs/PostCategoryWrapper.md
docs/PostScheduledTransactionWrapper.md
docs/PostTransactionsWrapper.md
docs/PutScheduledTransactionWrapper.md
docs/PutTransactionWrapper.md
docs/SaveAccount.md
docs/SaveCategory.md
docs/SaveCategoryGroup.md
docs/SaveCategoryGroupResponse.md
docs/SaveCategoryGroupResponseData.md
docs/SaveCategoryResponse.md
docs/SaveCategoryResponseData.md
docs/SaveMonthCategory.md
Expand Down Expand Up @@ -108,15 +123,41 @@ pyproject.toml
requirements.txt
test-requirements.txt
test/__init__.py
test/test_existing_category.py
test/test_money_movement.py
test/test_money_movement_group.py
test/test_money_movement_groups_response.py
test/test_money_movement_groups_response_data.py
test/test_money_movements_api.py
test/test_money_movements_response.py
test/test_money_movements_response_data.py
test/test_new_category.py
test/test_patch_category_group_wrapper.py
test/test_plan_detail.py
test/test_plan_detail_response.py
test/test_plan_detail_response_data.py
test/test_plan_settings.py
test/test_plan_settings_response.py
test/test_plan_settings_response_data.py
test/test_plan_summary.py
test/test_plan_summary_response.py
test/test_plan_summary_response_data.py
test/test_plans_api.py
test/test_post_category_group_wrapper.py
test/test_post_category_wrapper.py
test/test_save_category_group.py
test/test_save_category_group_response.py
test/test_save_category_group_response_data.py
tox.ini
ynab/__init__.py
ynab/api/__init__.py
ynab/api/accounts_api.py
ynab/api/budgets_api.py
ynab/api/categories_api.py
ynab/api/money_movements_api.py
ynab/api/months_api.py
ynab/api/payee_locations_api.py
ynab/api/payees_api.py
ynab/api/plans_api.py
ynab/api/scheduled_transactions_api.py
ynab/api/transactions_api.py
ynab/api/user_api.py
Expand All @@ -131,15 +172,6 @@ ynab/models/account_response_data.py
ynab/models/account_type.py
ynab/models/accounts_response.py
ynab/models/accounts_response_data.py
ynab/models/budget_detail.py
ynab/models/budget_detail_response.py
ynab/models/budget_detail_response_data.py
ynab/models/budget_settings.py
ynab/models/budget_settings_response.py
ynab/models/budget_settings_response_data.py
ynab/models/budget_summary.py
ynab/models/budget_summary_response.py
ynab/models/budget_summary_response_data.py
ynab/models/bulk_response.py
ynab/models/bulk_response_data.py
ynab/models/bulk_response_data_bulk.py
Expand All @@ -155,17 +187,26 @@ ynab/models/currency_format.py
ynab/models/date_format.py
ynab/models/error_detail.py
ynab/models/error_response.py
ynab/models/existing_category.py
ynab/models/existing_transaction.py
ynab/models/hybrid_transaction.py
ynab/models/hybrid_transactions_response.py
ynab/models/hybrid_transactions_response_data.py
ynab/models/money_movement.py
ynab/models/money_movement_group.py
ynab/models/money_movement_groups_response.py
ynab/models/money_movement_groups_response_data.py
ynab/models/money_movements_response.py
ynab/models/money_movements_response_data.py
ynab/models/month_detail.py
ynab/models/month_detail_response.py
ynab/models/month_detail_response_data.py
ynab/models/month_summaries_response.py
ynab/models/month_summaries_response_data.py
ynab/models/month_summary.py
ynab/models/new_category.py
ynab/models/new_transaction.py
ynab/models/patch_category_group_wrapper.py
ynab/models/patch_category_wrapper.py
ynab/models/patch_month_category_wrapper.py
ynab/models/patch_payee_wrapper.py
Expand All @@ -180,13 +221,27 @@ ynab/models/payee_response.py
ynab/models/payee_response_data.py
ynab/models/payees_response.py
ynab/models/payees_response_data.py
ynab/models/plan_detail.py
ynab/models/plan_detail_response.py
ynab/models/plan_detail_response_data.py
ynab/models/plan_settings.py
ynab/models/plan_settings_response.py
ynab/models/plan_settings_response_data.py
ynab/models/plan_summary.py
ynab/models/plan_summary_response.py
ynab/models/plan_summary_response_data.py
ynab/models/post_account_wrapper.py
ynab/models/post_category_group_wrapper.py
ynab/models/post_category_wrapper.py
ynab/models/post_scheduled_transaction_wrapper.py
ynab/models/post_transactions_wrapper.py
ynab/models/put_scheduled_transaction_wrapper.py
ynab/models/put_transaction_wrapper.py
ynab/models/save_account.py
ynab/models/save_category.py
ynab/models/save_category_group.py
ynab/models/save_category_group_response.py
ynab/models/save_category_group_response_data.py
ynab/models/save_category_response.py
ynab/models/save_category_response_data.py
ynab/models/save_month_category.py
Expand Down
2 changes: 1 addition & 1 deletion .openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.14.0
7.20.0
2 changes: 1 addition & 1 deletion DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Setup

- Install Poetry: `pip install poetry`
- Install Poetry: `pipx install poetry`
- Install dependencies: `poetry install`
- Install [OpenAPI Generator](https://openapi-generator.tech/) (on macOS: `brew install openapi-generator`)
- Run tests: `poetry run pytest`
Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ configuration = ynab.Configuration(

with ynab.ApiClient(configuration) as api_client:
budgets_api = ynab.BudgetsApi(api_client)
budgets_response = budgets_api.get_budgets()
budgets_response = budgets_api.get_plans()
budgets = budgets_response.data.budgets

for budget in budgets:
Expand All @@ -57,16 +57,16 @@ Class | Method | Description
**AccountsApi** | [**create_account**](docs/AccountsApi.md#create_account) | Create a new account
  | [**get_account_by_id**](docs/AccountsApi.md#get_account_by_id) | Single account
  | [**get_accounts**](docs/AccountsApi.md#get_accounts) | Account list
**BudgetsApi** | [**get_budget_by_id**](docs/BudgetsApi.md#get_budget_by_id) | Single budget
  | [**get_budget_settings_by_id**](docs/BudgetsApi.md#get_budget_settings_by_id) | Budget Settings
  | [**get_budgets**](docs/BudgetsApi.md#get_budgets) | List budgets
**BudgetsApi** | [**get_plan_by_id**](docs/BudgetsApi.md#get_plan_by_id) | Single plan
  | [**get_plan_settings_by_id**](docs/BudgetsApi.md#get_plan_settings_by_id) | Plan Settings
  | [**get_plans**](docs/BudgetsApi.md#get_plans) | List plans
**CategoriesApi** | [**get_categories**](docs/CategoriesApi.md#get_categories) | List categories
  | [**get_category_by_id**](docs/CategoriesApi.md#get_category_by_id) | Single category
  | [**get_month_category_by_id**](docs/CategoriesApi.md#get_month_category_by_id) | Single category for a specific budget month
  | [**get_month_category_by_id**](docs/CategoriesApi.md#get_month_category_by_id) | Single category for a specific plan month
  | [**update_category**](docs/CategoriesApi.md#update_category) | Update a category
  | [**update_month_category**](docs/CategoriesApi.md#update_month_category) | Update a category for a specific month
**MonthsApi** | [**get_budget_month**](docs/MonthsApi.md#get_budget_month) | Single budget month
  | [**get_budget_months**](docs/MonthsApi.md#get_budget_months) | List budget months
  | [**update_month_category**](docs/CategoriesApi.md#update_month_category) | Update a category for a specific plan month
**MonthsApi** | [**get_plan_month**](docs/MonthsApi.md#get_plan_month) | Single plan month
  | [**get_plan_months**](docs/MonthsApi.md#get_plan_months) | List plan months
**PayeeLocationsApi** | [**get_payee_location_by_id**](docs/PayeeLocationsApi.md#get_payee_location_by_id) | Single payee location
  | [**get_payee_locations**](docs/PayeeLocationsApi.md#get_payee_locations) | List payee locations
  | [**get_payee_locations_by_payee**](docs/PayeeLocationsApi.md#get_payee_locations_by_payee) | List locations for a payee
Expand Down Expand Up @@ -96,6 +96,6 @@ The version of this client is defined in the `pyproject.toml` file and follows [

## License

Copyright (c) 2025 You Need A Budget, LLC
Copyright (c) 2025 YNAB

Licensed under the Apache-2.0 license
10 changes: 5 additions & 5 deletions docs/Account.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,20 @@

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | |
**id** | **UUID** | |
**name** | **str** | |
**type** | [**AccountType**](AccountType.md) | |
**on_budget** | **bool** | Whether this account is on budget or not |
**on_budget** | **bool** | Whether this account is \"on budget\" or not |
**closed** | **bool** | Whether this account is closed or not |
**note** | **str** | | [optional]
**balance** | **int** | The current balance of the account in milliunits format |
**balance** | **int** | The current available balance of the account in milliunits format |
**cleared_balance** | **int** | The current cleared balance of the account in milliunits format |
**uncleared_balance** | **int** | The current uncleared balance of the account in milliunits format |
**transfer_payee_id** | **str** | The payee id which should be used when transferring to this account |
**transfer_payee_id** | **UUID** | The payee id which should be used when transferring to this account |
**direct_import_linked** | **bool** | Whether or not the account is linked to a financial institution for automatic transaction import. | [optional]
**direct_import_in_error** | **bool** | If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true. | [optional]
**last_reconciled_at** | **datetime** | A date/time specifying when the account was last reconciled. | [optional]
**debt_original_balance** | **int** | The original debt/loan account balance, specified in milliunits format. | [optional]
**debt_original_balance** | **int** | This field is deprecated and will always be null. | [optional]
**debt_interest_rates** | **Dict[str, int]** | | [optional]
**debt_minimum_payments** | **Dict[str, int]** | | [optional]
**debt_escrow_amounts** | **Dict[str, int]** | | [optional]
Expand Down
Loading
Loading