increase 0.538.0 → 0.540.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 (99) hide show
  1. package/CHANGELOG.md +27 -0
  2. package/bin/cli +5 -12
  3. package/client.d.mts +6 -12
  4. package/client.d.mts.map +1 -1
  5. package/client.d.ts +6 -12
  6. package/client.d.ts.map +1 -1
  7. package/client.js +6 -12
  8. package/client.js.map +1 -1
  9. package/client.mjs +6 -12
  10. package/client.mjs.map +1 -1
  11. package/package.json +1 -1
  12. package/resources/check-deposits.d.mts +4 -3
  13. package/resources/check-deposits.d.mts.map +1 -1
  14. package/resources/check-deposits.d.ts +4 -3
  15. package/resources/check-deposits.d.ts.map +1 -1
  16. package/resources/inbound-mail-items.d.mts +19 -7
  17. package/resources/inbound-mail-items.d.mts.map +1 -1
  18. package/resources/inbound-mail-items.d.ts +19 -7
  19. package/resources/inbound-mail-items.d.ts.map +1 -1
  20. package/resources/index.d.mts +2 -4
  21. package/resources/index.d.mts.map +1 -1
  22. package/resources/index.d.ts +2 -4
  23. package/resources/index.d.ts.map +1 -1
  24. package/resources/index.js +6 -10
  25. package/resources/index.js.map +1 -1
  26. package/resources/index.mjs +2 -4
  27. package/resources/index.mjs.map +1 -1
  28. package/resources/lockbox-addresses.d.mts +184 -0
  29. package/resources/lockbox-addresses.d.mts.map +1 -0
  30. package/resources/lockbox-addresses.d.ts +184 -0
  31. package/resources/lockbox-addresses.d.ts.map +1 -0
  32. package/resources/lockbox-addresses.js +64 -0
  33. package/resources/lockbox-addresses.js.map +1 -0
  34. package/resources/lockbox-addresses.mjs +60 -0
  35. package/resources/lockbox-addresses.mjs.map +1 -0
  36. package/resources/lockbox-recipients.d.mts +202 -0
  37. package/resources/lockbox-recipients.d.mts.map +1 -0
  38. package/resources/lockbox-recipients.d.ts +202 -0
  39. package/resources/lockbox-recipients.d.ts.map +1 -0
  40. package/resources/lockbox-recipients.js +69 -0
  41. package/resources/lockbox-recipients.js.map +1 -0
  42. package/resources/lockbox-recipients.mjs +65 -0
  43. package/resources/lockbox-recipients.mjs.map +1 -0
  44. package/resources/simulations/inbound-mail-items.d.mts +9 -5
  45. package/resources/simulations/inbound-mail-items.d.mts.map +1 -1
  46. package/resources/simulations/inbound-mail-items.d.ts +9 -5
  47. package/resources/simulations/inbound-mail-items.d.ts.map +1 -1
  48. package/resources/simulations/inbound-mail-items.js +0 -1
  49. package/resources/simulations/inbound-mail-items.js.map +1 -1
  50. package/resources/simulations/inbound-mail-items.mjs +0 -1
  51. package/resources/simulations/inbound-mail-items.mjs.map +1 -1
  52. package/src/client.ts +34 -70
  53. package/src/resources/check-deposits.ts +4 -3
  54. package/src/resources/inbound-mail-items.ts +27 -7
  55. package/src/resources/index.ts +15 -30
  56. package/src/resources/lockbox-addresses.ts +235 -0
  57. package/src/resources/lockbox-recipients.ts +257 -0
  58. package/src/resources/simulations/inbound-mail-items.ts +12 -6
  59. package/src/version.ts +1 -1
  60. package/version.d.mts +1 -1
  61. package/version.d.ts +1 -1
  62. package/version.js +1 -1
  63. package/version.mjs +1 -1
  64. package/resources/bookkeeping-accounts.d.mts +0 -164
  65. package/resources/bookkeeping-accounts.d.mts.map +0 -1
  66. package/resources/bookkeeping-accounts.d.ts +0 -164
  67. package/resources/bookkeeping-accounts.d.ts.map +0 -1
  68. package/resources/bookkeeping-accounts.js +0 -71
  69. package/resources/bookkeeping-accounts.js.map +0 -1
  70. package/resources/bookkeeping-accounts.mjs +0 -67
  71. package/resources/bookkeeping-accounts.mjs.map +0 -1
  72. package/resources/bookkeeping-entries.d.mts +0 -74
  73. package/resources/bookkeeping-entries.d.mts.map +0 -1
  74. package/resources/bookkeeping-entries.d.ts +0 -74
  75. package/resources/bookkeeping-entries.d.ts.map +0 -1
  76. package/resources/bookkeeping-entries.js +0 -39
  77. package/resources/bookkeeping-entries.js.map +0 -1
  78. package/resources/bookkeeping-entries.mjs +0 -35
  79. package/resources/bookkeeping-entries.mjs.map +0 -1
  80. package/resources/bookkeeping-entry-sets.d.mts +0 -156
  81. package/resources/bookkeeping-entry-sets.d.mts.map +0 -1
  82. package/resources/bookkeeping-entry-sets.d.ts +0 -156
  83. package/resources/bookkeeping-entry-sets.d.ts.map +0 -1
  84. package/resources/bookkeeping-entry-sets.js +0 -67
  85. package/resources/bookkeeping-entry-sets.js.map +0 -1
  86. package/resources/bookkeeping-entry-sets.mjs +0 -63
  87. package/resources/bookkeeping-entry-sets.mjs.map +0 -1
  88. package/resources/lockboxes.d.mts +0 -217
  89. package/resources/lockboxes.d.mts.map +0 -1
  90. package/resources/lockboxes.d.ts +0 -217
  91. package/resources/lockboxes.d.ts.map +0 -1
  92. package/resources/lockboxes.js +0 -64
  93. package/resources/lockboxes.js.map +0 -1
  94. package/resources/lockboxes.mjs +0 -60
  95. package/resources/lockboxes.mjs.map +0 -1
  96. package/src/resources/bookkeeping-accounts.ts +0 -220
  97. package/src/resources/bookkeeping-entries.ts +0 -98
  98. package/src/resources/bookkeeping-entry-sets.ts +0 -198
  99. package/src/resources/lockboxes.ts +0 -273
@@ -0,0 +1,257 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../core/resource';
4
+ import { APIPromise } from '../core/api-promise';
5
+ import { Page, type PageParams, PagePromise } from '../core/pagination';
6
+ import { RequestOptions } from '../internal/request-options';
7
+ import { path } from '../internal/utils/path';
8
+
9
+ export class LockboxRecipients extends APIResource {
10
+ /**
11
+ * Create a Lockbox Recipient
12
+ *
13
+ * @example
14
+ * ```ts
15
+ * const lockboxRecipient =
16
+ * await client.lockboxRecipients.create({
17
+ * account_id: 'account_in71c4amph0vgo2qllky',
18
+ * lockbox_address_id:
19
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
20
+ * });
21
+ * ```
22
+ */
23
+ create(body: LockboxRecipientCreateParams, options?: RequestOptions): APIPromise<LockboxRecipient> {
24
+ return this._client.post('/lockbox_recipients', { body, ...options });
25
+ }
26
+
27
+ /**
28
+ * Retrieve a Lockbox Recipient
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const lockboxRecipient =
33
+ * await client.lockboxRecipients.retrieve(
34
+ * 'lockbox_3xt21ok13q19advds4t5',
35
+ * );
36
+ * ```
37
+ */
38
+ retrieve(lockboxRecipientID: string, options?: RequestOptions): APIPromise<LockboxRecipient> {
39
+ return this._client.get(path`/lockbox_recipients/${lockboxRecipientID}`, options);
40
+ }
41
+
42
+ /**
43
+ * Update a Lockbox Recipient
44
+ *
45
+ * @example
46
+ * ```ts
47
+ * const lockboxRecipient =
48
+ * await client.lockboxRecipients.update(
49
+ * 'lockbox_3xt21ok13q19advds4t5',
50
+ * );
51
+ * ```
52
+ */
53
+ update(
54
+ lockboxRecipientID: string,
55
+ body: LockboxRecipientUpdateParams,
56
+ options?: RequestOptions,
57
+ ): APIPromise<LockboxRecipient> {
58
+ return this._client.patch(path`/lockbox_recipients/${lockboxRecipientID}`, { body, ...options });
59
+ }
60
+
61
+ /**
62
+ * List Lockbox Recipients
63
+ *
64
+ * @example
65
+ * ```ts
66
+ * // Automatically fetches more pages as needed.
67
+ * for await (const lockboxRecipient of client.lockboxRecipients.list()) {
68
+ * // ...
69
+ * }
70
+ * ```
71
+ */
72
+ list(
73
+ query: LockboxRecipientListParams | null | undefined = {},
74
+ options?: RequestOptions,
75
+ ): PagePromise<LockboxRecipientsPage, LockboxRecipient> {
76
+ return this._client.getAPIList('/lockbox_recipients', Page<LockboxRecipient>, { query, ...options });
77
+ }
78
+ }
79
+
80
+ export type LockboxRecipientsPage = Page<LockboxRecipient>;
81
+
82
+ /**
83
+ * Lockbox Recipients represent an inbox at a Lockbox Address. Checks received for
84
+ * a Lockbox Recipient are deposited into its associated Account.
85
+ */
86
+ export interface LockboxRecipient {
87
+ /**
88
+ * The Lockbox Recipient identifier.
89
+ */
90
+ id: string;
91
+
92
+ /**
93
+ * The identifier for the Account that checks sent to this Lockbox Recipient will
94
+ * be deposited into.
95
+ */
96
+ account_id: string;
97
+
98
+ /**
99
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
100
+ * Recipient was created.
101
+ */
102
+ created_at: string;
103
+
104
+ /**
105
+ * The description of the Lockbox Recipient.
106
+ */
107
+ description: string | null;
108
+
109
+ /**
110
+ * The idempotency key you chose for this object. This value is unique across
111
+ * Increase and is used to ensure that a request is only processed once. Learn more
112
+ * about [idempotency](https://increase.com/documentation/idempotency-keys).
113
+ */
114
+ idempotency_key: string | null;
115
+
116
+ /**
117
+ * The identifier for the Lockbox Address where this Lockbox Recipient may receive
118
+ * physical mail.
119
+ */
120
+ lockbox_address_id: string;
121
+
122
+ /**
123
+ * The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox
124
+ * Address. It should be included in the mailing address intended for this Lockbox
125
+ * Recipient.
126
+ */
127
+ mail_stop_code: string;
128
+
129
+ /**
130
+ * The name of the Lockbox Recipient.
131
+ */
132
+ recipient_name: string | null;
133
+
134
+ /**
135
+ * The status of the Lockbox Recipient.
136
+ *
137
+ * - `active` - This Lockbox Recipient is active.
138
+ * - `disabled` - This Lockbox Recipient is disabled. Checks mailed to this Lockbox
139
+ * Recipient will be rejected.
140
+ * - `canceled` - This Lockbox Recipient is canceled and cannot be modified. Checks
141
+ * mailed to this Lockbox Recipient will be rejected.
142
+ */
143
+ status: 'active' | 'disabled' | 'canceled' | null;
144
+
145
+ /**
146
+ * A constant representing the object's type. For this resource it will always be
147
+ * `lockbox_recipient`.
148
+ */
149
+ type: 'lockbox_recipient';
150
+ }
151
+
152
+ export interface LockboxRecipientCreateParams {
153
+ /**
154
+ * The Account that checks sent to this Lockbox Recipient should be deposited into.
155
+ */
156
+ account_id: string;
157
+
158
+ /**
159
+ * The Lockbox Address where this Lockbox Recipient may receive mail.
160
+ */
161
+ lockbox_address_id: string;
162
+
163
+ /**
164
+ * The description you choose for the Lockbox Recipient.
165
+ */
166
+ description?: string;
167
+
168
+ /**
169
+ * The name of the Lockbox Recipient
170
+ */
171
+ recipient_name?: string;
172
+
173
+ [k: string]: unknown;
174
+ }
175
+
176
+ export interface LockboxRecipientUpdateParams {
177
+ /**
178
+ * The description you choose for the Lockbox Recipient.
179
+ */
180
+ description?: string;
181
+
182
+ /**
183
+ * The name of the Lockbox Recipient.
184
+ */
185
+ recipient_name?: string;
186
+
187
+ /**
188
+ * The status of the Lockbox Recipient.
189
+ *
190
+ * - `active` - This Lockbox Recipient is active.
191
+ * - `disabled` - This Lockbox Recipient is disabled. Checks mailed to this Lockbox
192
+ * Recipient will be rejected.
193
+ * - `canceled` - This Lockbox Recipient is canceled and cannot be modified. Checks
194
+ * mailed to this Lockbox Recipient will be rejected.
195
+ */
196
+ status?: 'active' | 'disabled' | 'canceled';
197
+ }
198
+
199
+ export interface LockboxRecipientListParams extends PageParams {
200
+ /**
201
+ * Filter Lockbox Recipients to those associated with the provided Account.
202
+ */
203
+ account_id?: string;
204
+
205
+ created_at?: LockboxRecipientListParams.CreatedAt;
206
+
207
+ /**
208
+ * Filter records to the one with the specified `idempotency_key` you chose for
209
+ * that object. This value is unique across Increase and is used to ensure that a
210
+ * request is only processed once. Learn more about
211
+ * [idempotency](https://increase.com/documentation/idempotency-keys).
212
+ */
213
+ idempotency_key?: string;
214
+
215
+ /**
216
+ * Filter Lockbox Recipients to those associated with the provided Lockbox Address.
217
+ */
218
+ lockbox_address_id?: string;
219
+ }
220
+
221
+ export namespace LockboxRecipientListParams {
222
+ export interface CreatedAt {
223
+ /**
224
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
225
+ * timestamp.
226
+ */
227
+ after?: string;
228
+
229
+ /**
230
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
231
+ * timestamp.
232
+ */
233
+ before?: string;
234
+
235
+ /**
236
+ * Return results on or after this
237
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
238
+ */
239
+ on_or_after?: string;
240
+
241
+ /**
242
+ * Return results on or before this
243
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
244
+ */
245
+ on_or_before?: string;
246
+ }
247
+ }
248
+
249
+ export declare namespace LockboxRecipients {
250
+ export {
251
+ type LockboxRecipient as LockboxRecipient,
252
+ type LockboxRecipientsPage as LockboxRecipientsPage,
253
+ type LockboxRecipientCreateParams as LockboxRecipientCreateParams,
254
+ type LockboxRecipientUpdateParams as LockboxRecipientUpdateParams,
255
+ type LockboxRecipientListParams as LockboxRecipientListParams,
256
+ };
257
+ }
@@ -15,7 +15,6 @@ export class InboundMailItems extends APIResource {
15
15
  * const inboundMailItem =
16
16
  * await client.simulations.inboundMailItems.create({
17
17
  * amount: 1000,
18
- * lockbox_id: 'lockbox_3xt21ok13q19advds4t5',
19
18
  * });
20
19
  * ```
21
20
  */
@@ -33,16 +32,23 @@ export interface InboundMailItemCreateParams {
33
32
  */
34
33
  amount: number;
35
34
 
36
- /**
37
- * The identifier of the Lockbox to simulate inbound mail to.
38
- */
39
- lockbox_id: string;
40
-
41
35
  /**
42
36
  * The file containing the PDF contents. If not present, a default check image file
43
37
  * will be used.
44
38
  */
45
39
  contents_file_id?: string;
40
+
41
+ /**
42
+ * The identifier of the Lockbox Address to simulate inbound mail to.
43
+ */
44
+ lockbox_address_id?: string;
45
+
46
+ /**
47
+ * The identifier of the Lockbox Recipient to simulate inbound mail to.
48
+ */
49
+ lockbox_recipient_id?: string;
50
+
51
+ [k: string]: unknown;
46
52
  }
47
53
 
48
54
  export declare namespace InboundMailItems {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.538.0'; // x-release-please-version
1
+ export const VERSION = '0.540.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.538.0";
1
+ export declare const VERSION = "0.540.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.538.0";
1
+ export declare const VERSION = "0.540.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.538.0'; // x-release-please-version
4
+ exports.VERSION = '0.540.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.538.0'; // x-release-please-version
1
+ export const VERSION = '0.540.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map
@@ -1,164 +0,0 @@
1
- import { APIResource } from "../core/resource.mjs";
2
- import { APIPromise } from "../core/api-promise.mjs";
3
- import { Page, type PageParams, PagePromise } from "../core/pagination.mjs";
4
- import { RequestOptions } from "../internal/request-options.mjs";
5
- export declare class BookkeepingAccounts extends APIResource {
6
- /**
7
- * Create a Bookkeeping Account
8
- *
9
- * @example
10
- * ```ts
11
- * const bookkeepingAccount =
12
- * await client.bookkeepingAccounts.create({
13
- * name: 'New Account!',
14
- * });
15
- * ```
16
- */
17
- create(body: BookkeepingAccountCreateParams, options?: RequestOptions): APIPromise<BookkeepingAccount>;
18
- /**
19
- * Update a Bookkeeping Account
20
- *
21
- * @example
22
- * ```ts
23
- * const bookkeepingAccount =
24
- * await client.bookkeepingAccounts.update(
25
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
26
- * { name: 'Deprecated Account' },
27
- * );
28
- * ```
29
- */
30
- update(bookkeepingAccountID: string, body: BookkeepingAccountUpdateParams, options?: RequestOptions): APIPromise<BookkeepingAccount>;
31
- /**
32
- * List Bookkeeping Accounts
33
- *
34
- * @example
35
- * ```ts
36
- * // Automatically fetches more pages as needed.
37
- * for await (const bookkeepingAccount of client.bookkeepingAccounts.list()) {
38
- * // ...
39
- * }
40
- * ```
41
- */
42
- list(query?: BookkeepingAccountListParams | null | undefined, options?: RequestOptions): PagePromise<BookkeepingAccountsPage, BookkeepingAccount>;
43
- /**
44
- * Retrieve a Bookkeeping Account Balance
45
- *
46
- * @example
47
- * ```ts
48
- * const bookkeepingBalanceLookup =
49
- * await client.bookkeepingAccounts.balance(
50
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
51
- * );
52
- * ```
53
- */
54
- balance(bookkeepingAccountID: string, query?: BookkeepingAccountBalanceParams | null | undefined, options?: RequestOptions): APIPromise<BookkeepingBalanceLookup>;
55
- }
56
- export type BookkeepingAccountsPage = Page<BookkeepingAccount>;
57
- /**
58
- * Accounts are T-accounts. They can store accounting entries. Your compliance
59
- * setup might require annotating money movements using this API. Learn more in our
60
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
61
- */
62
- export interface BookkeepingAccount {
63
- /**
64
- * The account identifier.
65
- */
66
- id: string;
67
- /**
68
- * The API Account associated with this bookkeeping account.
69
- */
70
- account_id: string | null;
71
- /**
72
- * The compliance category of the account.
73
- *
74
- * - `commingled_cash` - A cash in an commingled Increase Account.
75
- * - `customer_balance` - A customer balance.
76
- */
77
- compliance_category: 'commingled_cash' | 'customer_balance' | null;
78
- /**
79
- * The Entity associated with this bookkeeping account.
80
- */
81
- entity_id: string | null;
82
- /**
83
- * The idempotency key you chose for this object. This value is unique across
84
- * Increase and is used to ensure that a request is only processed once. Learn more
85
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
86
- */
87
- idempotency_key: string | null;
88
- /**
89
- * The name you choose for the account.
90
- */
91
- name: string;
92
- /**
93
- * A constant representing the object's type. For this resource it will always be
94
- * `bookkeeping_account`.
95
- */
96
- type: 'bookkeeping_account';
97
- }
98
- /**
99
- * Represents a request to lookup the balance of a Bookkeeping Account at a given
100
- * point in time.
101
- */
102
- export interface BookkeepingBalanceLookup {
103
- /**
104
- * The Bookkeeping Account's current balance, representing the sum of all
105
- * Bookkeeping Entries on the Bookkeeping Account.
106
- */
107
- balance: number;
108
- /**
109
- * The identifier for the account for which the balance was queried.
110
- */
111
- bookkeeping_account_id: string;
112
- /**
113
- * A constant representing the object's type. For this resource it will always be
114
- * `bookkeeping_balance_lookup`.
115
- */
116
- type: 'bookkeeping_balance_lookup';
117
- }
118
- export interface BookkeepingAccountCreateParams {
119
- /**
120
- * The name you choose for the account.
121
- */
122
- name: string;
123
- /**
124
- * The account, if `compliance_category` is `commingled_cash`.
125
- */
126
- account_id?: string;
127
- /**
128
- * The account compliance category.
129
- *
130
- * - `commingled_cash` - A cash in an commingled Increase Account.
131
- * - `customer_balance` - A customer balance.
132
- */
133
- compliance_category?: 'commingled_cash' | 'customer_balance';
134
- /**
135
- * The entity, if `compliance_category` is `customer_balance`.
136
- */
137
- entity_id?: string;
138
- [k: string]: unknown;
139
- }
140
- export interface BookkeepingAccountUpdateParams {
141
- /**
142
- * The name you choose for the account.
143
- */
144
- name: string;
145
- }
146
- export interface BookkeepingAccountListParams extends PageParams {
147
- /**
148
- * Filter records to the one with the specified `idempotency_key` you chose for
149
- * that object. This value is unique across Increase and is used to ensure that a
150
- * request is only processed once. Learn more about
151
- * [idempotency](https://increase.com/documentation/idempotency-keys).
152
- */
153
- idempotency_key?: string;
154
- }
155
- export interface BookkeepingAccountBalanceParams {
156
- /**
157
- * The moment to query the balance at. If not set, returns the current balances.
158
- */
159
- at_time?: string;
160
- }
161
- export declare namespace BookkeepingAccounts {
162
- export { type BookkeepingAccount as BookkeepingAccount, type BookkeepingBalanceLookup as BookkeepingBalanceLookup, type BookkeepingAccountsPage as BookkeepingAccountsPage, type BookkeepingAccountCreateParams as BookkeepingAccountCreateParams, type BookkeepingAccountUpdateParams as BookkeepingAccountUpdateParams, type BookkeepingAccountListParams as BookkeepingAccountListParams, type BookkeepingAccountBalanceParams as BookkeepingAccountBalanceParams, };
163
- }
164
- //# sourceMappingURL=bookkeeping-accounts.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bookkeeping-accounts.d.mts","sourceRoot":"","sources":["../src/resources/bookkeeping-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE;OACtC,EAAE,cAAc,EAAE;AAGzB,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,8BAA8B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAI3D;;;;;;;;;;OAUG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAMxC;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,mBAAmB,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;IAE7D;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}
@@ -1,164 +0,0 @@
1
- import { APIResource } from "../core/resource.js";
2
- import { APIPromise } from "../core/api-promise.js";
3
- import { Page, type PageParams, PagePromise } from "../core/pagination.js";
4
- import { RequestOptions } from "../internal/request-options.js";
5
- export declare class BookkeepingAccounts extends APIResource {
6
- /**
7
- * Create a Bookkeeping Account
8
- *
9
- * @example
10
- * ```ts
11
- * const bookkeepingAccount =
12
- * await client.bookkeepingAccounts.create({
13
- * name: 'New Account!',
14
- * });
15
- * ```
16
- */
17
- create(body: BookkeepingAccountCreateParams, options?: RequestOptions): APIPromise<BookkeepingAccount>;
18
- /**
19
- * Update a Bookkeeping Account
20
- *
21
- * @example
22
- * ```ts
23
- * const bookkeepingAccount =
24
- * await client.bookkeepingAccounts.update(
25
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
26
- * { name: 'Deprecated Account' },
27
- * );
28
- * ```
29
- */
30
- update(bookkeepingAccountID: string, body: BookkeepingAccountUpdateParams, options?: RequestOptions): APIPromise<BookkeepingAccount>;
31
- /**
32
- * List Bookkeeping Accounts
33
- *
34
- * @example
35
- * ```ts
36
- * // Automatically fetches more pages as needed.
37
- * for await (const bookkeepingAccount of client.bookkeepingAccounts.list()) {
38
- * // ...
39
- * }
40
- * ```
41
- */
42
- list(query?: BookkeepingAccountListParams | null | undefined, options?: RequestOptions): PagePromise<BookkeepingAccountsPage, BookkeepingAccount>;
43
- /**
44
- * Retrieve a Bookkeeping Account Balance
45
- *
46
- * @example
47
- * ```ts
48
- * const bookkeepingBalanceLookup =
49
- * await client.bookkeepingAccounts.balance(
50
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
51
- * );
52
- * ```
53
- */
54
- balance(bookkeepingAccountID: string, query?: BookkeepingAccountBalanceParams | null | undefined, options?: RequestOptions): APIPromise<BookkeepingBalanceLookup>;
55
- }
56
- export type BookkeepingAccountsPage = Page<BookkeepingAccount>;
57
- /**
58
- * Accounts are T-accounts. They can store accounting entries. Your compliance
59
- * setup might require annotating money movements using this API. Learn more in our
60
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
61
- */
62
- export interface BookkeepingAccount {
63
- /**
64
- * The account identifier.
65
- */
66
- id: string;
67
- /**
68
- * The API Account associated with this bookkeeping account.
69
- */
70
- account_id: string | null;
71
- /**
72
- * The compliance category of the account.
73
- *
74
- * - `commingled_cash` - A cash in an commingled Increase Account.
75
- * - `customer_balance` - A customer balance.
76
- */
77
- compliance_category: 'commingled_cash' | 'customer_balance' | null;
78
- /**
79
- * The Entity associated with this bookkeeping account.
80
- */
81
- entity_id: string | null;
82
- /**
83
- * The idempotency key you chose for this object. This value is unique across
84
- * Increase and is used to ensure that a request is only processed once. Learn more
85
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
86
- */
87
- idempotency_key: string | null;
88
- /**
89
- * The name you choose for the account.
90
- */
91
- name: string;
92
- /**
93
- * A constant representing the object's type. For this resource it will always be
94
- * `bookkeeping_account`.
95
- */
96
- type: 'bookkeeping_account';
97
- }
98
- /**
99
- * Represents a request to lookup the balance of a Bookkeeping Account at a given
100
- * point in time.
101
- */
102
- export interface BookkeepingBalanceLookup {
103
- /**
104
- * The Bookkeeping Account's current balance, representing the sum of all
105
- * Bookkeeping Entries on the Bookkeeping Account.
106
- */
107
- balance: number;
108
- /**
109
- * The identifier for the account for which the balance was queried.
110
- */
111
- bookkeeping_account_id: string;
112
- /**
113
- * A constant representing the object's type. For this resource it will always be
114
- * `bookkeeping_balance_lookup`.
115
- */
116
- type: 'bookkeeping_balance_lookup';
117
- }
118
- export interface BookkeepingAccountCreateParams {
119
- /**
120
- * The name you choose for the account.
121
- */
122
- name: string;
123
- /**
124
- * The account, if `compliance_category` is `commingled_cash`.
125
- */
126
- account_id?: string;
127
- /**
128
- * The account compliance category.
129
- *
130
- * - `commingled_cash` - A cash in an commingled Increase Account.
131
- * - `customer_balance` - A customer balance.
132
- */
133
- compliance_category?: 'commingled_cash' | 'customer_balance';
134
- /**
135
- * The entity, if `compliance_category` is `customer_balance`.
136
- */
137
- entity_id?: string;
138
- [k: string]: unknown;
139
- }
140
- export interface BookkeepingAccountUpdateParams {
141
- /**
142
- * The name you choose for the account.
143
- */
144
- name: string;
145
- }
146
- export interface BookkeepingAccountListParams extends PageParams {
147
- /**
148
- * Filter records to the one with the specified `idempotency_key` you chose for
149
- * that object. This value is unique across Increase and is used to ensure that a
150
- * request is only processed once. Learn more about
151
- * [idempotency](https://increase.com/documentation/idempotency-keys).
152
- */
153
- idempotency_key?: string;
154
- }
155
- export interface BookkeepingAccountBalanceParams {
156
- /**
157
- * The moment to query the balance at. If not set, returns the current balances.
158
- */
159
- at_time?: string;
160
- }
161
- export declare namespace BookkeepingAccounts {
162
- export { type BookkeepingAccount as BookkeepingAccount, type BookkeepingBalanceLookup as BookkeepingBalanceLookup, type BookkeepingAccountsPage as BookkeepingAccountsPage, type BookkeepingAccountCreateParams as BookkeepingAccountCreateParams, type BookkeepingAccountUpdateParams as BookkeepingAccountUpdateParams, type BookkeepingAccountListParams as BookkeepingAccountListParams, type BookkeepingAccountBalanceParams as BookkeepingAccountBalanceParams, };
163
- }
164
- //# sourceMappingURL=bookkeeping-accounts.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"bookkeeping-accounts.d.ts","sourceRoot":"","sources":["../src/resources/bookkeeping-accounts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,IAAI,EAAE,KAAK,UAAU,EAAE,WAAW,EAAE;OACtC,EAAE,cAAc,EAAE;AAGzB,qBAAa,mBAAoB,SAAQ,WAAW;IAClD;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,8BAA8B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAItG;;;;;;;;;;;OAWG;IACH,MAAM,CACJ,oBAAoB,EAAE,MAAM,EAC5B,IAAI,EAAE,8BAA8B,EACpC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;IAIjC;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,4BAA4B,GAAG,IAAI,GAAG,SAAc,EAC3D,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;IAI3D;;;;;;;;;;OAUG;IACH,OAAO,CACL,oBAAoB,EAAE,MAAM,EAC5B,KAAK,GAAE,+BAA+B,GAAG,IAAI,GAAG,SAAc,EAC9D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;CAMxC;AAED,MAAM,MAAM,uBAAuB,GAAG,IAAI,CAAC,kBAAkB,CAAC,CAAC;AAE/D;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,mBAAmB,EAAE,iBAAiB,GAAG,kBAAkB,GAAG,IAAI,CAAC;IAEnE;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,IAAI,EAAE,qBAAqB,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,sBAAsB,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,4BAA4B,CAAC;CACpC;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,iBAAiB,GAAG,kBAAkB,CAAC;IAE7D;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,4BAA6B,SAAQ,UAAU;IAC9D;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,+BAA+B;IAC9C;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,mBAAmB,CAAC;IAC3C,OAAO,EACL,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,+BAA+B,IAAI,+BAA+B,GACxE,CAAC;CACH"}