ynab 4.4.0 → 4.5.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.
@@ -30,7 +30,7 @@ class CustomTransactionsApi extends TransactionsApi_1.TransactionsApi {
30
30
  * @memberof TransactionsApi
31
31
  */
32
32
  getTransactionsByType(budgetId, type, lastKnowledgeOfServer, options) {
33
- return this.getTransactions(budgetId, undefined, type, lastKnowledgeOfServer, options);
33
+ return this.getTransactions(budgetId, undefined, undefined, type, lastKnowledgeOfServer, options);
34
34
  }
35
35
  /**
36
36
  * Creates multiple transactions. Provide a body containing a 'transactions' array, multiple transactions will be created.
@@ -21,6 +21,7 @@ export interface GetTransactionByIdRequest {
21
21
  export interface GetTransactionsRequest {
22
22
  planId: string;
23
23
  sinceDate?: string;
24
+ untilDate?: string;
24
25
  type?: GetTransactionsTypeEnum;
25
26
  lastKnowledgeOfServer?: number;
26
27
  }
@@ -28,6 +29,7 @@ export interface GetTransactionsByAccountRequest {
28
29
  planId: string;
29
30
  accountId: string;
30
31
  sinceDate?: string;
32
+ untilDate?: string;
31
33
  type?: GetTransactionsByAccountTypeEnum;
32
34
  lastKnowledgeOfServer?: number;
33
35
  }
@@ -35,6 +37,7 @@ export interface GetTransactionsByCategoryRequest {
35
37
  planId: string;
36
38
  categoryId: string;
37
39
  sinceDate?: string;
40
+ untilDate?: string;
38
41
  type?: GetTransactionsByCategoryTypeEnum;
39
42
  lastKnowledgeOfServer?: number;
40
43
  }
@@ -42,6 +45,7 @@ export interface GetTransactionsByMonthRequest {
42
45
  planId: string;
43
46
  month: string;
44
47
  sinceDate?: string;
48
+ untilDate?: string;
45
49
  type?: GetTransactionsByMonthTypeEnum;
46
50
  lastKnowledgeOfServer?: number;
47
51
  }
@@ -49,6 +53,7 @@ export interface GetTransactionsByPayeeRequest {
49
53
  planId: string;
50
54
  payeeId: string;
51
55
  sinceDate?: string;
56
+ untilDate?: string;
52
57
  type?: GetTransactionsByPayeeTypeEnum;
53
58
  lastKnowledgeOfServer?: number;
54
59
  }
@@ -100,54 +105,54 @@ export declare class TransactionsApi extends runtime.BaseAPI {
100
105
  getTransactionById(planId: string, transactionId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionResponse>;
101
106
  /**
102
107
  * Returns plan transactions, excluding any pending transactions
103
- * Get all transactions
108
+ * Get transactions
104
109
  */
105
110
  getTransactionsRaw(requestParameters: GetTransactionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
106
111
  /**
107
112
  * Returns plan transactions, excluding any pending transactions
108
- * Get all transactions
113
+ * Get transactions
109
114
  */
110
- getTransactions(planId: string, sinceDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
115
+ getTransactions(planId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
111
116
  /**
112
117
  * Returns all transactions for a specified account, excluding any pending transactions
113
- * Get all account transactions
118
+ * Get account transactions
114
119
  */
115
120
  getTransactionsByAccountRaw(requestParameters: GetTransactionsByAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
116
121
  /**
117
122
  * Returns all transactions for a specified account, excluding any pending transactions
118
- * Get all account transactions
123
+ * Get account transactions
119
124
  */
120
- getTransactionsByAccount(planId: string, accountId: string, sinceDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
125
+ getTransactionsByAccount(planId: string, accountId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByAccountTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
121
126
  /**
122
127
  * Returns all transactions for a specified category, excluding any pending transactions
123
- * Get all category transactions
128
+ * Get category transactions
124
129
  */
125
130
  getTransactionsByCategoryRaw(requestParameters: GetTransactionsByCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
126
131
  /**
127
132
  * Returns all transactions for a specified category, excluding any pending transactions
128
- * Get all category transactions
133
+ * Get category transactions
129
134
  */
130
- getTransactionsByCategory(planId: string, categoryId: string, sinceDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
135
+ getTransactionsByCategory(planId: string, categoryId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByCategoryTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
131
136
  /**
132
137
  * Returns all transactions for a specified month, excluding any pending transactions
133
- * Get all plan month transactions
138
+ * Get plan month transactions
134
139
  */
135
140
  getTransactionsByMonthRaw(requestParameters: GetTransactionsByMonthRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TransactionsResponse>>;
136
141
  /**
137
142
  * Returns all transactions for a specified month, excluding any pending transactions
138
- * Get all plan month transactions
143
+ * Get plan month transactions
139
144
  */
140
- getTransactionsByMonth(planId: string, month: string, sinceDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
145
+ getTransactionsByMonth(planId: string, month: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByMonthTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TransactionsResponse>;
141
146
  /**
142
147
  * Returns all transactions for a specified payee, excluding any pending transactions
143
- * Get all payee transactions
148
+ * Get payee transactions
144
149
  */
145
150
  getTransactionsByPayeeRaw(requestParameters: GetTransactionsByPayeeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<HybridTransactionsResponse>>;
146
151
  /**
147
152
  * Returns all transactions for a specified payee, excluding any pending transactions
148
- * Get all payee transactions
153
+ * Get payee transactions
149
154
  */
150
- getTransactionsByPayee(planId: string, payeeId: string, sinceDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
155
+ getTransactionsByPayee(planId: string, payeeId: string, sinceDate?: string, untilDate?: string, type?: GetTransactionsByPayeeTypeEnum, lastKnowledgeOfServer?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<HybridTransactionsResponse>;
151
156
  /**
152
157
  * Imports available transactions on all linked accounts for the given plan. Linked accounts allow transactions to be imported directly from a specified financial institution and this endpoint initiates that import. Sending a request to this endpoint is the equivalent of clicking \"Import\" on each account in the web application or tapping the \"New Transactions\" banner in the mobile applications. The response for this endpoint contains the transaction ids that have been imported.
153
158
  * Import transactions
@@ -163,7 +163,7 @@ class TransactionsApi extends runtime.BaseAPI {
163
163
  }
164
164
  /**
165
165
  * Returns plan transactions, excluding any pending transactions
166
- * Get all transactions
166
+ * Get transactions
167
167
  */
168
168
  async getTransactionsRaw(requestParameters, initOverrides) {
169
169
  if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -173,6 +173,9 @@ class TransactionsApi extends runtime.BaseAPI {
173
173
  if (requestParameters.sinceDate !== undefined) {
174
174
  queryParameters['since_date'] = requestParameters.sinceDate;
175
175
  }
176
+ if (requestParameters.untilDate !== undefined) {
177
+ queryParameters['until_date'] = requestParameters.untilDate;
178
+ }
176
179
  if (requestParameters.type !== undefined) {
177
180
  queryParameters['type'] = requestParameters.type;
178
181
  }
@@ -198,15 +201,15 @@ class TransactionsApi extends runtime.BaseAPI {
198
201
  }
199
202
  /**
200
203
  * Returns plan transactions, excluding any pending transactions
201
- * Get all transactions
204
+ * Get transactions
202
205
  */
203
- async getTransactions(planId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
204
- const response = await this.getTransactionsRaw({ planId: planId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
206
+ async getTransactions(planId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
207
+ const response = await this.getTransactionsRaw({ planId: planId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
205
208
  return await response.value();
206
209
  }
207
210
  /**
208
211
  * Returns all transactions for a specified account, excluding any pending transactions
209
- * Get all account transactions
212
+ * Get account transactions
210
213
  */
211
214
  async getTransactionsByAccountRaw(requestParameters, initOverrides) {
212
215
  if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -219,6 +222,9 @@ class TransactionsApi extends runtime.BaseAPI {
219
222
  if (requestParameters.sinceDate !== undefined) {
220
223
  queryParameters['since_date'] = requestParameters.sinceDate;
221
224
  }
225
+ if (requestParameters.untilDate !== undefined) {
226
+ queryParameters['until_date'] = requestParameters.untilDate;
227
+ }
222
228
  if (requestParameters.type !== undefined) {
223
229
  queryParameters['type'] = requestParameters.type;
224
230
  }
@@ -244,15 +250,15 @@ class TransactionsApi extends runtime.BaseAPI {
244
250
  }
245
251
  /**
246
252
  * Returns all transactions for a specified account, excluding any pending transactions
247
- * Get all account transactions
253
+ * Get account transactions
248
254
  */
249
- async getTransactionsByAccount(planId, accountId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
250
- const response = await this.getTransactionsByAccountRaw({ planId: planId, accountId: accountId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
255
+ async getTransactionsByAccount(planId, accountId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
256
+ const response = await this.getTransactionsByAccountRaw({ planId: planId, accountId: accountId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
251
257
  return await response.value();
252
258
  }
253
259
  /**
254
260
  * Returns all transactions for a specified category, excluding any pending transactions
255
- * Get all category transactions
261
+ * Get category transactions
256
262
  */
257
263
  async getTransactionsByCategoryRaw(requestParameters, initOverrides) {
258
264
  if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -265,6 +271,9 @@ class TransactionsApi extends runtime.BaseAPI {
265
271
  if (requestParameters.sinceDate !== undefined) {
266
272
  queryParameters['since_date'] = requestParameters.sinceDate;
267
273
  }
274
+ if (requestParameters.untilDate !== undefined) {
275
+ queryParameters['until_date'] = requestParameters.untilDate;
276
+ }
268
277
  if (requestParameters.type !== undefined) {
269
278
  queryParameters['type'] = requestParameters.type;
270
279
  }
@@ -290,15 +299,15 @@ class TransactionsApi extends runtime.BaseAPI {
290
299
  }
291
300
  /**
292
301
  * Returns all transactions for a specified category, excluding any pending transactions
293
- * Get all category transactions
302
+ * Get category transactions
294
303
  */
295
- async getTransactionsByCategory(planId, categoryId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
296
- const response = await this.getTransactionsByCategoryRaw({ planId: planId, categoryId: categoryId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
304
+ async getTransactionsByCategory(planId, categoryId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
305
+ const response = await this.getTransactionsByCategoryRaw({ planId: planId, categoryId: categoryId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
297
306
  return await response.value();
298
307
  }
299
308
  /**
300
309
  * Returns all transactions for a specified month, excluding any pending transactions
301
- * Get all plan month transactions
310
+ * Get plan month transactions
302
311
  */
303
312
  async getTransactionsByMonthRaw(requestParameters, initOverrides) {
304
313
  if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -311,6 +320,9 @@ class TransactionsApi extends runtime.BaseAPI {
311
320
  if (requestParameters.sinceDate !== undefined) {
312
321
  queryParameters['since_date'] = requestParameters.sinceDate;
313
322
  }
323
+ if (requestParameters.untilDate !== undefined) {
324
+ queryParameters['until_date'] = requestParameters.untilDate;
325
+ }
314
326
  if (requestParameters.type !== undefined) {
315
327
  queryParameters['type'] = requestParameters.type;
316
328
  }
@@ -336,15 +348,15 @@ class TransactionsApi extends runtime.BaseAPI {
336
348
  }
337
349
  /**
338
350
  * Returns all transactions for a specified month, excluding any pending transactions
339
- * Get all plan month transactions
351
+ * Get plan month transactions
340
352
  */
341
- async getTransactionsByMonth(planId, month, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
342
- const response = await this.getTransactionsByMonthRaw({ planId: planId, month: month, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
353
+ async getTransactionsByMonth(planId, month, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
354
+ const response = await this.getTransactionsByMonthRaw({ planId: planId, month: month, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
343
355
  return await response.value();
344
356
  }
345
357
  /**
346
358
  * Returns all transactions for a specified payee, excluding any pending transactions
347
- * Get all payee transactions
359
+ * Get payee transactions
348
360
  */
349
361
  async getTransactionsByPayeeRaw(requestParameters, initOverrides) {
350
362
  if (requestParameters.planId === null || requestParameters.planId === undefined) {
@@ -357,6 +369,9 @@ class TransactionsApi extends runtime.BaseAPI {
357
369
  if (requestParameters.sinceDate !== undefined) {
358
370
  queryParameters['since_date'] = requestParameters.sinceDate;
359
371
  }
372
+ if (requestParameters.untilDate !== undefined) {
373
+ queryParameters['until_date'] = requestParameters.untilDate;
374
+ }
360
375
  if (requestParameters.type !== undefined) {
361
376
  queryParameters['type'] = requestParameters.type;
362
377
  }
@@ -382,10 +397,10 @@ class TransactionsApi extends runtime.BaseAPI {
382
397
  }
383
398
  /**
384
399
  * Returns all transactions for a specified payee, excluding any pending transactions
385
- * Get all payee transactions
400
+ * Get payee transactions
386
401
  */
387
- async getTransactionsByPayee(planId, payeeId, sinceDate, type, lastKnowledgeOfServer, initOverrides) {
388
- const response = await this.getTransactionsByPayeeRaw({ planId: planId, payeeId: payeeId, sinceDate: sinceDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
402
+ async getTransactionsByPayee(planId, payeeId, sinceDate, untilDate, type, lastKnowledgeOfServer, initOverrides) {
403
+ const response = await this.getTransactionsByPayeeRaw({ planId: planId, payeeId: payeeId, sinceDate: sinceDate, untilDate: untilDate, type: type, lastKnowledgeOfServer: lastKnowledgeOfServer }, initOverrides);
389
404
  return await response.value();
390
405
  }
391
406
  /**