ynab 1.42.0 → 1.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/README.md +33 -32
  2. package/dist/api.d.ts +432 -247
  3. package/dist/api.js +663 -329
  4. package/dist/browser/ynab.js +1 -2
  5. package/dist/esm/api.d.ts +432 -247
  6. package/dist/esm/api.js +566 -253
  7. package/dist/esm/configuration.js +1 -1
  8. package/dist/esm/transactionsApi.d.ts +1 -1
  9. package/dist/esm/transactionsApi.js +3 -1
  10. package/dist/esm/utils.js +1 -1
  11. package/dist/index.js +1 -1
  12. package/dist/transactionsApi.d.ts +1 -1
  13. package/package.json +3 -4
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # YNAB API JavaScript Library
2
2
 
3
- [![Build Status](https://travis-ci.org/ynab/ynab-sdk-js.svg?branch=master)](https://travis-ci.org/ynab/ynab-sdk-js)
3
+ [![Build Status](https://travis-ci.org/ynab/ynab-sdk-js.svg?branch=main)](https://travis-ci.org/ynab/ynab-sdk-js)
4
4
  [![npm version](https://badge.fury.io/js/ynab.svg)](https://badge.fury.io/js/ynab)
5
5
 
6
6
  Please read the [YNAB API documentation](https://api.youneedabudget.com) for an overview of using the API and a complete list of available resources.
@@ -120,44 +120,45 @@ console.log(budgetsResponse.rateLimit); // ex: "36/200"
120
120
 
121
121
  ## Examples
122
122
 
123
- See the [examples](https://github.com/ynab/ynab-sdk-js/tree/master/examples)
123
+ See the [examples](https://github.com/ynab/ynab-sdk-js/tree/main/examples)
124
124
  folder for example usage scenarios.
125
125
 
126
126
  ## Methods
127
127
 
128
- The following methods are available in this library. For more details on parameters and usage, the [TypeScript declaration file](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) can be referenced.
128
+ The following methods are available in this library. For more details on parameters and usage, the [TypeScript declaration file](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) can be referenced.
129
129
 
130
130
  | | Method | Description |
131
131
  |----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
132
- | **User** | [user.getUser()](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns authenticated user information |
133
- | **Budgets** | [budgets.getBudgets()](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns budgets list with summary information |
134
- | | [budgets.getBudgetById(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single budget with all related entities |
135
- | | [budgets.getBudgetSettingsById(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns settings for a budget |
136
- | **Accounts** | [accounts.getAccounts(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all accounts |
137
- | | [accounts.getAccountById(budget_id, account_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single account |
138
- | **Categories** | [categories.getCategories(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all categories grouped by category group. |
139
- | | [categories.getCategoryById(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single category |
140
- | | [categories.updateMonthCategory(budget_id, month, category_id, month_category)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts#L2629) | Update an existing month category |
141
- | **Payees** | [payees.getPayees(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all payees |
142
- | | [payees.getPayeeById(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns single payee |
143
- | **Payee Locations** | [payee_locations.getPayeeLocations(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all payee locations |
144
- | | [payee_locations.getPayeeLocationById(budget_id, payee_location_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single payee location |
145
- | | [payee_locations.getPayeeLocationsByPayee(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all payee locations for the specified payee |
146
- | **Months** | [months.getBudgetMonths(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all budget months |
147
- | | [months.getBudgetMonth(budget_id, month)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single budget month |
148
- | | [months.getMonthCategory_by_id(budget_id, month, category_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single category for a specific budget month |
149
- | **Transactions** | [transactions.getTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns budget transactions |
150
- | | [transactions.getTransactionsByAccount(budget_id, account_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all transactions for a specified account |
151
- | | [transactions.getTransactionsByCategory(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all transactions for a specified category |
152
- | | [transactions.getTransactionsByType(budget_id, type)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/transactionsApi.d.ts) | Returns all transactions of a specified type ("unapproved" or "uncategorized") |
153
- | | [transactions.getTransactionById(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single transaction |
154
- | | [transactions.createTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Creates a single transaction |
155
- | | [transactions.createTransactions(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/transactionsApi.d.ts) | Creates multiple transactions |
156
- | | [transactions.updateTransaction(budget_id, transaction_id, data)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Updates a single transaction |
157
- | | [transactions.updateTransactions(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Updates multiple transactions |
158
- | | [transactions.importTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Imports transactions |
159
- | **Scheduled Transactions** | [scheduled_transactions.getScheduledTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns all scheduled transactions |
160
- | | [scheduled_transactions.getScheduledTransactionById(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts#L2936) | Returns a single scheduled transaction |
132
+ | **User** | [user.getUser()](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns authenticated user information |
133
+ | **Budgets** | [budgets.getBudgets()](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns budgets list with summary information |
134
+ | | [budgets.getBudgetById(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single budget with all related entities |
135
+ | | [budgets.getBudgetSettingsById(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns settings for a budget |
136
+ | **Accounts** | [accounts.getAccounts(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all accounts |
137
+ | | [accounts.getAccountById(budget_id, account_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single account |
138
+ | **Categories** | [categories.getCategories(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all categories grouped by category group. |
139
+ | | [categories.getCategoryById(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single category |
140
+ | | [categories.updateMonthCategory(budget_id, month, category_id, month_category)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts#L2629) | Update an existing month category |
141
+ | **Payees** | [payees.getPayees(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all payees |
142
+ | | [payees.getPayeeById(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns single payee |
143
+ | **Payee Locations** | [payee_locations.getPayeeLocations(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all payee locations |
144
+ | | [payee_locations.getPayeeLocationById(budget_id, payee_location_id)](https://github.com/ynab/ynab-sdk-js/blob/master/dist/api.d.ts) | Returns a single payee location |
145
+ | | [payee_locations.getPayeeLocationsByPayee(budget_id, payee_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all payee locations for the specified payee |
146
+ | **Months** | [months.getBudgetMonths(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all budget months |
147
+ | | [months.getBudgetMonth(budget_id, month)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single budget month |
148
+ | | [months.getMonthCategory_by_id(budget_id, month, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single category for a specific budget month |
149
+ | **Transactions** | [transactions.getTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns budget transactions |
150
+ | | [transactions.getTransactionsByAccount(budget_id, account_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all transactions for a specified account |
151
+ | | [transactions.getTransactionsByCategory(budget_id, category_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all transactions for a specified category |
152
+ | | [transactions.getTransactionsByType(budget_id, type)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/transactionsApi.d.ts) | Returns all transactions of a specified type ("unapproved" or "uncategorized") |
153
+ | | [transactions.getTransactionById(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns a single transaction |
154
+ | | [transactions.createTransaction(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Creates a single transaction |
155
+ | | [transactions.createTransactions(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/transactionsApi.d.ts) | Creates multiple transactions |
156
+ | | [transactions.updateTransaction(budget_id, transaction_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Updates a single transaction |
157
+ | | [transactions.updateTransactions(budget_id, data)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Updates multiple transactions |
158
+ | | [transactions.deleteTransaction(budget_id, transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Deletes a transaction |
159
+ | | [transactions.importTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Imports transactions |
160
+ | **Scheduled Transactions** | [scheduled_transactions.getScheduledTransactions(budget_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts) | Returns all scheduled transactions |
161
+ | | [scheduled_transactions.getScheduledTransactionById(budget_id, scheduled_transaction_id)](https://github.com/ynab/ynab-sdk-js/blob/main/dist/api.d.ts#L2936) | Returns a single scheduled transaction |
161
162
 
162
163
  ### Utilities
163
164