ynab 2.0.0 → 2.2.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 (90) hide show
  1. package/README.md +2 -2
  2. package/dist/apis/CategoriesApi.d.ts +16 -1
  3. package/dist/apis/CategoriesApi.js +42 -0
  4. package/dist/apis/CustomTransactionsApi.d.ts +1 -1
  5. package/dist/apis/TransactionsApi.d.ts +4 -4
  6. package/dist/apis/index.d.ts +0 -1
  7. package/dist/apis/index.js +5 -2
  8. package/dist/browser/ynab.js +1 -1
  9. package/dist/esm/apis/CategoriesApi.d.ts +16 -1
  10. package/dist/esm/apis/CategoriesApi.js +65 -1
  11. package/dist/esm/apis/CustomTransactionsApi.d.ts +1 -1
  12. package/dist/esm/apis/index.d.ts +0 -1
  13. package/dist/esm/apis/index.js +0 -1
  14. package/dist/esm/models/Category.d.ts +0 -1
  15. package/dist/esm/models/Category.js +0 -1
  16. package/dist/esm/models/CategoryGoalType.d.ts +25 -0
  17. package/dist/esm/models/CategoryGoalType.js +29 -0
  18. package/dist/esm/models/HybridTransaction.d.ts +9 -30
  19. package/dist/esm/models/HybridTransaction.js +7 -26
  20. package/dist/esm/models/PatchCategoryWrapper.d.ts +32 -0
  21. package/dist/esm/models/PatchCategoryWrapper.js +44 -0
  22. package/dist/esm/models/SaveCategory.d.ts +43 -0
  23. package/dist/esm/models/SaveCategory.js +47 -0
  24. package/dist/esm/models/SaveTransaction.d.ts +8 -28
  25. package/dist/esm/models/SaveTransaction.js +6 -24
  26. package/dist/esm/models/SaveTransactionWithId.d.ts +8 -28
  27. package/dist/esm/models/SaveTransactionWithId.js +6 -24
  28. package/dist/esm/models/SaveTransactionWithOptionalFields.d.ts +8 -28
  29. package/dist/esm/models/SaveTransactionWithOptionalFields.js +6 -24
  30. package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
  31. package/dist/esm/models/SaveTransactionWithOptionalFieldsFlagColor.js +29 -0
  32. package/dist/esm/models/ScheduledTransactionDetail.d.ts +4 -16
  33. package/dist/esm/models/ScheduledTransactionDetail.js +3 -14
  34. package/dist/esm/models/ScheduledTransactionSummary.d.ts +4 -16
  35. package/dist/esm/models/ScheduledTransactionSummary.js +3 -14
  36. package/dist/esm/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
  37. package/dist/esm/models/ScheduledTransactionSummaryFlagColor.js +29 -0
  38. package/dist/esm/models/TransactionClearedStatus.d.ts +24 -0
  39. package/dist/esm/models/TransactionClearedStatus.js +31 -0
  40. package/dist/esm/models/TransactionDetail.d.ts +9 -30
  41. package/dist/esm/models/TransactionDetail.js +7 -26
  42. package/dist/esm/models/TransactionFlagColor.d.ts +27 -0
  43. package/dist/esm/models/TransactionFlagColor.js +34 -0
  44. package/dist/esm/models/TransactionSummary.d.ts +9 -30
  45. package/dist/esm/models/TransactionSummary.js +7 -26
  46. package/dist/esm/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
  47. package/dist/esm/models/TransactionSummaryDebtTransactionType.js +29 -0
  48. package/dist/esm/models/index.d.ts +4 -0
  49. package/dist/esm/models/index.js +4 -0
  50. package/dist/index.js +5 -1
  51. package/dist/models/AccountType.d.ts +1 -1
  52. package/dist/models/Category.d.ts +1 -2
  53. package/dist/models/Category.js +0 -1
  54. package/dist/models/CategoryGoalType.d.ts +25 -0
  55. package/dist/models/CategoryGoalType.js +36 -0
  56. package/dist/models/HybridTransaction.d.ts +11 -32
  57. package/dist/models/HybridTransaction.js +8 -27
  58. package/dist/models/HybridTransactionAllOf.d.ts +1 -1
  59. package/dist/models/PatchCategoryWrapper.d.ts +32 -0
  60. package/dist/models/PatchCategoryWrapper.js +51 -0
  61. package/dist/models/SaveCategory.d.ts +43 -0
  62. package/dist/models/SaveCategory.js +54 -0
  63. package/dist/models/SaveTransaction.d.ts +8 -28
  64. package/dist/models/SaveTransaction.js +7 -25
  65. package/dist/models/SaveTransactionWithId.d.ts +8 -28
  66. package/dist/models/SaveTransactionWithId.js +7 -25
  67. package/dist/models/SaveTransactionWithOptionalFields.d.ts +8 -28
  68. package/dist/models/SaveTransactionWithOptionalFields.js +7 -25
  69. package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.d.ts +25 -0
  70. package/dist/models/SaveTransactionWithOptionalFieldsFlagColor.js +36 -0
  71. package/dist/models/ScheduledTransactionDetail.d.ts +5 -17
  72. package/dist/models/ScheduledTransactionDetail.js +4 -15
  73. package/dist/models/ScheduledTransactionSummary.d.ts +5 -17
  74. package/dist/models/ScheduledTransactionSummary.js +4 -15
  75. package/dist/models/ScheduledTransactionSummaryFlagColor.d.ts +25 -0
  76. package/dist/models/ScheduledTransactionSummaryFlagColor.js +36 -0
  77. package/dist/models/TransactionClearedStatus.d.ts +24 -0
  78. package/dist/models/TransactionClearedStatus.js +37 -0
  79. package/dist/models/TransactionDetail.d.ts +10 -31
  80. package/dist/models/TransactionDetail.js +8 -27
  81. package/dist/models/TransactionFlagColor.d.ts +27 -0
  82. package/dist/models/TransactionFlagColor.js +40 -0
  83. package/dist/models/TransactionSummary.d.ts +10 -31
  84. package/dist/models/TransactionSummary.js +8 -27
  85. package/dist/models/TransactionSummaryDebtTransactionType.d.ts +25 -0
  86. package/dist/models/TransactionSummaryDebtTransactionType.js +36 -0
  87. package/dist/models/index.d.ts +4 -0
  88. package/dist/models/index.js +9 -1
  89. package/dist/runtime.d.ts +9 -9
  90. package/package.json +6 -7
@@ -13,28 +13,10 @@
13
13
  * Do not edit the class manually.
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.TransactionSummaryToJSON = exports.TransactionSummaryFromJSONTyped = exports.TransactionSummaryFromJSON = exports.instanceOfTransactionSummary = exports.TransactionSummaryDebtTransactionTypeEnum = exports.TransactionSummaryFlagColorEnum = exports.TransactionSummaryClearedEnum = void 0;
16
+ exports.TransactionSummaryToJSON = exports.TransactionSummaryFromJSONTyped = exports.TransactionSummaryFromJSON = exports.instanceOfTransactionSummary = exports.TransactionSummaryDebtTransactionTypeEnum = void 0;
17
17
  const runtime_1 = require("../runtime");
18
- /**
19
- * @export
20
- */
21
- exports.TransactionSummaryClearedEnum = {
22
- Cleared: 'cleared',
23
- Uncleared: 'uncleared',
24
- Reconciled: 'reconciled'
25
- };
26
- /**
27
- * @export
28
- */
29
- exports.TransactionSummaryFlagColorEnum = {
30
- Red: 'red',
31
- Orange: 'orange',
32
- Yellow: 'yellow',
33
- Green: 'green',
34
- Blue: 'blue',
35
- Purple: 'purple',
36
- Null: 'null'
37
- };
18
+ const TransactionClearedStatus_1 = require("./TransactionClearedStatus");
19
+ const TransactionFlagColor_1 = require("./TransactionFlagColor");
38
20
  /**
39
21
  * @export
40
22
  */
@@ -44,10 +26,9 @@ exports.TransactionSummaryDebtTransactionTypeEnum = {
44
26
  Fee: 'fee',
45
27
  Interest: 'interest',
46
28
  Escrow: 'escrow',
47
- BalancedAdjustment: 'balancedAdjustment',
29
+ BalanceAdjustment: 'balanceAdjustment',
48
30
  Credit: 'credit',
49
31
  Charge: 'charge',
50
- Null: 'null'
51
32
  };
52
33
  /**
53
34
  * Check if a given object implements the TransactionSummary interface.
@@ -77,9 +58,9 @@ function TransactionSummaryFromJSONTyped(json, ignoreDiscriminator) {
77
58
  'date': json['date'],
78
59
  'amount': json['amount'],
79
60
  'memo': !(0, runtime_1.exists)(json, 'memo') ? undefined : json['memo'],
80
- 'cleared': json['cleared'],
61
+ 'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusFromJSON)(json['cleared']),
81
62
  'approved': json['approved'],
82
- 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : json['flag_color'],
63
+ 'flag_color': !(0, runtime_1.exists)(json, 'flag_color') ? undefined : (0, TransactionFlagColor_1.TransactionFlagColorFromJSON)(json['flag_color']),
83
64
  'account_id': json['account_id'],
84
65
  'payee_id': !(0, runtime_1.exists)(json, 'payee_id') ? undefined : json['payee_id'],
85
66
  'category_id': !(0, runtime_1.exists)(json, 'category_id') ? undefined : json['category_id'],
@@ -106,9 +87,9 @@ function TransactionSummaryToJSON(value) {
106
87
  'date': value.date,
107
88
  'amount': value.amount,
108
89
  'memo': value.memo,
109
- 'cleared': value.cleared,
90
+ 'cleared': (0, TransactionClearedStatus_1.TransactionClearedStatusToJSON)(value.cleared),
110
91
  'approved': value.approved,
111
- 'flag_color': value.flag_color,
92
+ 'flag_color': (0, TransactionFlagColor_1.TransactionFlagColorToJSON)(value.flag_color),
112
93
  'account_id': value.account_id,
113
94
  'payee_id': value.payee_id,
114
95
  'category_id': value.category_id,
@@ -0,0 +1,25 @@
1
+ /**
2
+ * YNAB API Endpoints
3
+ * Our 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.ynab.com
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * If the transaction is a debt/loan account transaction, the type of transaction
14
+ * @export
15
+ * @interface TransactionSummaryDebtTransactionType
16
+ */
17
+ export interface TransactionSummaryDebtTransactionType {
18
+ }
19
+ /**
20
+ * Check if a given object implements the TransactionSummaryDebtTransactionType interface.
21
+ */
22
+ export declare function instanceOfTransactionSummaryDebtTransactionType(value: object): boolean;
23
+ export declare function TransactionSummaryDebtTransactionTypeFromJSON(json: any): TransactionSummaryDebtTransactionType;
24
+ export declare function TransactionSummaryDebtTransactionTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): TransactionSummaryDebtTransactionType;
25
+ export declare function TransactionSummaryDebtTransactionTypeToJSON(value?: TransactionSummaryDebtTransactionType | null): any;
@@ -0,0 +1,36 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * YNAB API Endpoints
6
+ * Our 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.ynab.com
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.TransactionSummaryDebtTransactionTypeToJSON = exports.TransactionSummaryDebtTransactionTypeFromJSONTyped = exports.TransactionSummaryDebtTransactionTypeFromJSON = exports.instanceOfTransactionSummaryDebtTransactionType = void 0;
17
+ /**
18
+ * Check if a given object implements the TransactionSummaryDebtTransactionType interface.
19
+ */
20
+ function instanceOfTransactionSummaryDebtTransactionType(value) {
21
+ let isInstance = true;
22
+ return isInstance;
23
+ }
24
+ exports.instanceOfTransactionSummaryDebtTransactionType = instanceOfTransactionSummaryDebtTransactionType;
25
+ function TransactionSummaryDebtTransactionTypeFromJSON(json) {
26
+ return TransactionSummaryDebtTransactionTypeFromJSONTyped(json, false);
27
+ }
28
+ exports.TransactionSummaryDebtTransactionTypeFromJSON = TransactionSummaryDebtTransactionTypeFromJSON;
29
+ function TransactionSummaryDebtTransactionTypeFromJSONTyped(json, ignoreDiscriminator) {
30
+ return json;
31
+ }
32
+ exports.TransactionSummaryDebtTransactionTypeFromJSONTyped = TransactionSummaryDebtTransactionTypeFromJSONTyped;
33
+ function TransactionSummaryDebtTransactionTypeToJSON(value) {
34
+ return value;
35
+ }
36
+ exports.TransactionSummaryDebtTransactionTypeToJSON = TransactionSummaryDebtTransactionTypeToJSON;
@@ -41,6 +41,7 @@ export * from './MonthDetailResponseData';
41
41
  export * from './MonthSummariesResponse';
42
42
  export * from './MonthSummariesResponseData';
43
43
  export * from './MonthSummary';
44
+ export * from './PatchCategoryWrapper';
44
45
  export * from './PatchMonthCategoryWrapper';
45
46
  export * from './PatchTransactionsWrapper';
46
47
  export * from './Payee';
@@ -57,6 +58,7 @@ export * from './PostAccountWrapper';
57
58
  export * from './PostTransactionsWrapper';
58
59
  export * from './PutTransactionWrapper';
59
60
  export * from './SaveAccount';
61
+ export * from './SaveCategory';
60
62
  export * from './SaveCategoryResponse';
61
63
  export * from './SaveCategoryResponseData';
62
64
  export * from './SaveMonthCategory';
@@ -76,8 +78,10 @@ export * from './ScheduledTransactionSummary';
76
78
  export * from './ScheduledTransactionsResponse';
77
79
  export * from './ScheduledTransactionsResponseData';
78
80
  export * from './SubTransaction';
81
+ export * from './TransactionClearedStatus';
79
82
  export * from './TransactionDetail';
80
83
  export * from './TransactionDetailAllOf';
84
+ export * from './TransactionFlagColor';
81
85
  export * from './TransactionResponse';
82
86
  export * from './TransactionResponseData';
83
87
  export * from './TransactionSummary';
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -55,6 +59,7 @@ __exportStar(require("./MonthDetailResponseData"), exports);
55
59
  __exportStar(require("./MonthSummariesResponse"), exports);
56
60
  __exportStar(require("./MonthSummariesResponseData"), exports);
57
61
  __exportStar(require("./MonthSummary"), exports);
62
+ __exportStar(require("./PatchCategoryWrapper"), exports);
58
63
  __exportStar(require("./PatchMonthCategoryWrapper"), exports);
59
64
  __exportStar(require("./PatchTransactionsWrapper"), exports);
60
65
  __exportStar(require("./Payee"), exports);
@@ -71,6 +76,7 @@ __exportStar(require("./PostAccountWrapper"), exports);
71
76
  __exportStar(require("./PostTransactionsWrapper"), exports);
72
77
  __exportStar(require("./PutTransactionWrapper"), exports);
73
78
  __exportStar(require("./SaveAccount"), exports);
79
+ __exportStar(require("./SaveCategory"), exports);
74
80
  __exportStar(require("./SaveCategoryResponse"), exports);
75
81
  __exportStar(require("./SaveCategoryResponseData"), exports);
76
82
  __exportStar(require("./SaveMonthCategory"), exports);
@@ -90,8 +96,10 @@ __exportStar(require("./ScheduledTransactionSummary"), exports);
90
96
  __exportStar(require("./ScheduledTransactionsResponse"), exports);
91
97
  __exportStar(require("./ScheduledTransactionsResponseData"), exports);
92
98
  __exportStar(require("./SubTransaction"), exports);
99
+ __exportStar(require("./TransactionClearedStatus"), exports);
93
100
  __exportStar(require("./TransactionDetail"), exports);
94
101
  __exportStar(require("./TransactionDetailAllOf"), exports);
102
+ __exportStar(require("./TransactionFlagColor"), exports);
95
103
  __exportStar(require("./TransactionResponse"), exports);
96
104
  __exportStar(require("./TransactionResponseData"), exports);
97
105
  __exportStar(require("./TransactionSummary"), exports);
package/dist/runtime.d.ts CHANGED
@@ -90,24 +90,24 @@ export declare const COLLECTION_FORMATS: {
90
90
  tsv: string;
91
91
  pipes: string;
92
92
  };
93
- export declare type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
94
- export declare type Json = any;
95
- export declare type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
96
- export declare type HTTPHeaders = {
93
+ export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
94
+ export type Json = any;
95
+ export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
96
+ export type HTTPHeaders = {
97
97
  [key: string]: string;
98
98
  };
99
- export declare type HTTPQuery = {
99
+ export type HTTPQuery = {
100
100
  [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
101
101
  };
102
- export declare type HTTPBody = Json | FormData | URLSearchParams;
103
- export declare type HTTPRequestInit = {
102
+ export type HTTPBody = Json | FormData | URLSearchParams;
103
+ export type HTTPRequestInit = {
104
104
  headers?: HTTPHeaders;
105
105
  method: HTTPMethod;
106
106
  credentials?: RequestCredentials;
107
107
  body?: HTTPBody;
108
108
  };
109
- export declare type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
110
- export declare type InitOverrideFunction = (requestContext: {
109
+ export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
110
+ export type InitOverrideFunction = (requestContext: {
111
111
  init: HTTPRequestInit;
112
112
  context: RequestOpts;
113
113
  }) => Promise<RequestInit>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ynab",
3
- "version": "2.0.0",
3
+ "version": "2.2.0",
4
4
  "description": "YNAB API Javascript (Node) Library",
5
5
  "author": "YNAB",
6
6
  "email": "api@ynab.com",
@@ -25,11 +25,10 @@
25
25
  "url": "https://github.com/ynab/ynab-sdk-js.git"
26
26
  },
27
27
  "engines": {
28
- "node": "<=18"
28
+ "node": ">=14"
29
29
  },
30
30
  "scripts": {
31
- "generate": "openapi-generator generate -i ./open_api_spec.yaml -g \"typescript-fetch\" --type-mappings Date=string --additional-properties=modelPropertyNaming=original,useSingleRequestParameter=false -t ./templates -o src",
32
- "download_lastest_spec": "wget https://api.ynab.com/papi/open_api_spec.yaml -O open_api_spec.yaml",
31
+ "generate": "./scripts/generate.mjs",
33
32
  "build": "tsc -b src/ test/ examples/ && tsc -b src/tsconfig.esm.json && webpack --mode production && npm run build_examples",
34
33
  "build_examples": "tsc -b examples/",
35
34
  "test": "TS_NODE_PROJECT=./test/tsconfig.json mocha --reporter spec --require ts-node/register/type-check 'test/**/*.ts'"
@@ -41,11 +40,11 @@
41
40
  "@types/node": "^14.0.27",
42
41
  "chai": "^4.2.0",
43
42
  "fetch-mock": "^9.10.6",
44
- "jsh": "0.34.0",
43
+ "jsh": "0.55.0",
45
44
  "mocha": "^10.2.0",
46
45
  "ts-loader": "^8.0.2",
47
- "ts-node": "^8.10.2",
48
- "typescript": "4.5.5",
46
+ "ts-node": "10.9.1",
47
+ "typescript": "5.2.2",
49
48
  "url": "^0.11.0",
50
49
  "webpack": "^5.74.0",
51
50
  "webpack-cli": "^5.0.1"