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
@@ -1,217 +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 Lockboxes extends APIResource {
6
- /**
7
- * Create a Lockbox
8
- *
9
- * @example
10
- * ```ts
11
- * const lockbox = await client.lockboxes.create({
12
- * account_id: 'account_in71c4amph0vgo2qllky',
13
- * });
14
- * ```
15
- */
16
- create(body: LockboxCreateParams, options?: RequestOptions): APIPromise<Lockbox>;
17
- /**
18
- * Retrieve a Lockbox
19
- *
20
- * @example
21
- * ```ts
22
- * const lockbox = await client.lockboxes.retrieve(
23
- * 'lockbox_3xt21ok13q19advds4t5',
24
- * );
25
- * ```
26
- */
27
- retrieve(lockboxID: string, options?: RequestOptions): APIPromise<Lockbox>;
28
- /**
29
- * Update a Lockbox
30
- *
31
- * @example
32
- * ```ts
33
- * const lockbox = await client.lockboxes.update(
34
- * 'lockbox_3xt21ok13q19advds4t5',
35
- * );
36
- * ```
37
- */
38
- update(lockboxID: string, body: LockboxUpdateParams, options?: RequestOptions): APIPromise<Lockbox>;
39
- /**
40
- * List Lockboxes
41
- *
42
- * @example
43
- * ```ts
44
- * // Automatically fetches more pages as needed.
45
- * for await (const lockbox of client.lockboxes.list()) {
46
- * // ...
47
- * }
48
- * ```
49
- */
50
- list(query?: LockboxListParams | null | undefined, options?: RequestOptions): PagePromise<LockboxesPage, Lockbox>;
51
- }
52
- export type LockboxesPage = Page<Lockbox>;
53
- /**
54
- * Lockboxes are physical locations that can receive mail containing paper checks.
55
- * Increase will automatically create a Check Deposit for checks received this way.
56
- */
57
- export interface Lockbox {
58
- /**
59
- * The Lockbox identifier.
60
- */
61
- id: string;
62
- /**
63
- * The identifier for the Account checks sent to this lockbox will be deposited
64
- * into.
65
- */
66
- account_id: string;
67
- /**
68
- * The mailing address for the Lockbox.
69
- */
70
- address: Lockbox.Address;
71
- /**
72
- * Indicates if checks mailed to this lockbox will be deposited.
73
- *
74
- * - `enabled` - Checks mailed to this Lockbox will be deposited.
75
- * - `disabled` - Checks mailed to this Lockbox will not be deposited.
76
- * - `pend_for_processing` - Checks mailed to this Lockbox will be pending until
77
- * actioned.
78
- */
79
- check_deposit_behavior: 'enabled' | 'disabled' | 'pend_for_processing';
80
- /**
81
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
82
- * was created.
83
- */
84
- created_at: string;
85
- /**
86
- * The description you choose for the Lockbox.
87
- */
88
- description: string | null;
89
- /**
90
- * The idempotency key you chose for this object. This value is unique across
91
- * Increase and is used to ensure that a request is only processed once. Learn more
92
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
93
- */
94
- idempotency_key: string | null;
95
- /**
96
- * The recipient name you choose for the Lockbox.
97
- */
98
- recipient_name: string | null;
99
- /**
100
- * A constant representing the object's type. For this resource it will always be
101
- * `lockbox`.
102
- */
103
- type: 'lockbox';
104
- [k: string]: unknown;
105
- }
106
- export declare namespace Lockbox {
107
- /**
108
- * The mailing address for the Lockbox.
109
- */
110
- interface Address {
111
- /**
112
- * The city of the address.
113
- */
114
- city: string;
115
- /**
116
- * The first line of the address.
117
- */
118
- line1: string;
119
- /**
120
- * The second line of the address.
121
- */
122
- line2: string;
123
- /**
124
- * The postal code of the address.
125
- */
126
- postal_code: string;
127
- /**
128
- * The recipient line of the address. This will include the recipient name you
129
- * provide when creating the address, as well as an ATTN suffix to help route the
130
- * mail to your lockbox. Mail senders must include this ATTN line to receive mail
131
- * at this Lockbox.
132
- */
133
- recipient: string | null;
134
- /**
135
- * The two-letter United States Postal Service (USPS) abbreviation for the state of
136
- * the address.
137
- */
138
- state: string;
139
- }
140
- }
141
- export interface LockboxCreateParams {
142
- /**
143
- * The Account checks sent to this Lockbox should be deposited into.
144
- */
145
- account_id: string;
146
- /**
147
- * The description you choose for the Lockbox, for display purposes.
148
- */
149
- description?: string;
150
- /**
151
- * The name of the recipient that will receive mail at this location.
152
- */
153
- recipient_name?: string;
154
- [k: string]: unknown;
155
- }
156
- export interface LockboxUpdateParams {
157
- /**
158
- * This indicates if checks mailed to this lockbox will be deposited.
159
- *
160
- * - `enabled` - Checks mailed to this Lockbox will be deposited.
161
- * - `disabled` - Checks mailed to this Lockbox will not be deposited.
162
- * - `pend_for_processing` - Checks mailed to this Lockbox will be pending until
163
- * actioned.
164
- */
165
- check_deposit_behavior?: 'enabled' | 'disabled' | 'pend_for_processing';
166
- /**
167
- * The description you choose for the Lockbox.
168
- */
169
- description?: string;
170
- /**
171
- * The recipient name you choose for the Lockbox.
172
- */
173
- recipient_name?: string;
174
- [k: string]: unknown;
175
- }
176
- export interface LockboxListParams extends PageParams {
177
- /**
178
- * Filter Lockboxes to those associated with the provided Account.
179
- */
180
- account_id?: string;
181
- created_at?: LockboxListParams.CreatedAt;
182
- /**
183
- * Filter records to the one with the specified `idempotency_key` you chose for
184
- * that object. This value is unique across Increase and is used to ensure that a
185
- * request is only processed once. Learn more about
186
- * [idempotency](https://increase.com/documentation/idempotency-keys).
187
- */
188
- idempotency_key?: string;
189
- }
190
- export declare namespace LockboxListParams {
191
- interface CreatedAt {
192
- /**
193
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
194
- * timestamp.
195
- */
196
- after?: string;
197
- /**
198
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
199
- * timestamp.
200
- */
201
- before?: string;
202
- /**
203
- * Return results on or after this
204
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
205
- */
206
- on_or_after?: string;
207
- /**
208
- * Return results on or before this
209
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
210
- */
211
- on_or_before?: string;
212
- }
213
- }
214
- export declare namespace Lockboxes {
215
- export { type Lockbox as Lockbox, type LockboxesPage as LockboxesPage, type LockboxCreateParams as LockboxCreateParams, type LockboxUpdateParams as LockboxUpdateParams, type LockboxListParams as LockboxListParams, };
216
- }
217
- //# sourceMappingURL=lockboxes.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"lockboxes.d.ts","sourceRoot":"","sources":["../src/resources/lockboxes.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,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAIhF;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAI1E;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,OAAO,CAAC;IAInG;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,aAAa,EAAE,OAAO,CAAC;CAGvC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC;AAE1C;;;GAGG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC;IAEzB;;;;;;;OAOG;IACH,sBAAsB,EAAE,SAAS,GAAG,UAAU,GAAG,qBAAqB,CAAC;IAEvE;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAE3B;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;OAGG;IACH,IAAI,EAAE,SAAS,CAAC;IAEhB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,OAAO,CAAC;IACvB;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,KAAK,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;;;;WAKG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QAEzB;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;;;;;OAOG;IACH,sBAAsB,CAAC,EAAE,SAAS,GAAG,UAAU,GAAG,qBAAqB,CAAC;IAExE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,iBAAkB,SAAQ,UAAU;IACnD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB,UAAU,CAAC,EAAE,iBAAiB,CAAC,SAAS,CAAC;IAEzC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,iBAAiB,CAAC;IACjC,UAAiB,SAAS;QACxB;;;WAGG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;CACF;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,OAAO,IAAI,OAAO,EACvB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
@@ -1,64 +0,0 @@
1
- "use strict";
2
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
- Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.Lockboxes = void 0;
5
- const resource_1 = require("../core/resource.js");
6
- const pagination_1 = require("../core/pagination.js");
7
- const path_1 = require("../internal/utils/path.js");
8
- class Lockboxes extends resource_1.APIResource {
9
- /**
10
- * Create a Lockbox
11
- *
12
- * @example
13
- * ```ts
14
- * const lockbox = await client.lockboxes.create({
15
- * account_id: 'account_in71c4amph0vgo2qllky',
16
- * });
17
- * ```
18
- */
19
- create(body, options) {
20
- return this._client.post('/lockboxes', { body, ...options });
21
- }
22
- /**
23
- * Retrieve a Lockbox
24
- *
25
- * @example
26
- * ```ts
27
- * const lockbox = await client.lockboxes.retrieve(
28
- * 'lockbox_3xt21ok13q19advds4t5',
29
- * );
30
- * ```
31
- */
32
- retrieve(lockboxID, options) {
33
- return this._client.get((0, path_1.path) `/lockboxes/${lockboxID}`, options);
34
- }
35
- /**
36
- * Update a Lockbox
37
- *
38
- * @example
39
- * ```ts
40
- * const lockbox = await client.lockboxes.update(
41
- * 'lockbox_3xt21ok13q19advds4t5',
42
- * );
43
- * ```
44
- */
45
- update(lockboxID, body, options) {
46
- return this._client.patch((0, path_1.path) `/lockboxes/${lockboxID}`, { body, ...options });
47
- }
48
- /**
49
- * List Lockboxes
50
- *
51
- * @example
52
- * ```ts
53
- * // Automatically fetches more pages as needed.
54
- * for await (const lockbox of client.lockboxes.list()) {
55
- * // ...
56
- * }
57
- * ```
58
- */
59
- list(query = {}, options) {
60
- return this._client.getAPIList('/lockboxes', (pagination_1.Page), { query, ...options });
61
- }
62
- }
63
- exports.Lockboxes = Lockboxes;
64
- //# sourceMappingURL=lockboxes.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"lockboxes.js","sourceRoot":"","sources":["../src/resources/lockboxes.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,cAAc,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,iBAAa,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF;AA5DD,8BA4DC"}
@@ -1,60 +0,0 @@
1
- // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- import { APIResource } from "../core/resource.mjs";
3
- import { Page } from "../core/pagination.mjs";
4
- import { path } from "../internal/utils/path.mjs";
5
- export class Lockboxes extends APIResource {
6
- /**
7
- * Create a Lockbox
8
- *
9
- * @example
10
- * ```ts
11
- * const lockbox = await client.lockboxes.create({
12
- * account_id: 'account_in71c4amph0vgo2qllky',
13
- * });
14
- * ```
15
- */
16
- create(body, options) {
17
- return this._client.post('/lockboxes', { body, ...options });
18
- }
19
- /**
20
- * Retrieve a Lockbox
21
- *
22
- * @example
23
- * ```ts
24
- * const lockbox = await client.lockboxes.retrieve(
25
- * 'lockbox_3xt21ok13q19advds4t5',
26
- * );
27
- * ```
28
- */
29
- retrieve(lockboxID, options) {
30
- return this._client.get(path `/lockboxes/${lockboxID}`, options);
31
- }
32
- /**
33
- * Update a Lockbox
34
- *
35
- * @example
36
- * ```ts
37
- * const lockbox = await client.lockboxes.update(
38
- * 'lockbox_3xt21ok13q19advds4t5',
39
- * );
40
- * ```
41
- */
42
- update(lockboxID, body, options) {
43
- return this._client.patch(path `/lockboxes/${lockboxID}`, { body, ...options });
44
- }
45
- /**
46
- * List Lockboxes
47
- *
48
- * @example
49
- * ```ts
50
- * // Automatically fetches more pages as needed.
51
- * for await (const lockbox of client.lockboxes.list()) {
52
- * // ...
53
- * }
54
- * ```
55
- */
56
- list(query = {}, options) {
57
- return this._client.getAPIList('/lockboxes', (Page), { query, ...options });
58
- }
59
- }
60
- //# sourceMappingURL=lockboxes.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"lockboxes.mjs","sourceRoot":"","sources":["../src/resources/lockboxes.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,IAAI,EAAgC;OAEtC,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QAClD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,cAAc,SAAS,EAAE,EAAE,OAAO,CAAC,CAAC;IAClE,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CAAC,SAAiB,EAAE,IAAyB,EAAE,OAAwB;QAC3E,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,cAAc,SAAS,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA8C,EAAE,EAChD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,IAAa,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;CACF"}
@@ -1,220 +0,0 @@
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 BookkeepingAccounts extends APIResource {
10
- /**
11
- * Create a Bookkeeping Account
12
- *
13
- * @example
14
- * ```ts
15
- * const bookkeepingAccount =
16
- * await client.bookkeepingAccounts.create({
17
- * name: 'New Account!',
18
- * });
19
- * ```
20
- */
21
- create(body: BookkeepingAccountCreateParams, options?: RequestOptions): APIPromise<BookkeepingAccount> {
22
- return this._client.post('/bookkeeping_accounts', { body, ...options });
23
- }
24
-
25
- /**
26
- * Update a Bookkeeping Account
27
- *
28
- * @example
29
- * ```ts
30
- * const bookkeepingAccount =
31
- * await client.bookkeepingAccounts.update(
32
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
33
- * { name: 'Deprecated Account' },
34
- * );
35
- * ```
36
- */
37
- update(
38
- bookkeepingAccountID: string,
39
- body: BookkeepingAccountUpdateParams,
40
- options?: RequestOptions,
41
- ): APIPromise<BookkeepingAccount> {
42
- return this._client.patch(path`/bookkeeping_accounts/${bookkeepingAccountID}`, { body, ...options });
43
- }
44
-
45
- /**
46
- * List Bookkeeping Accounts
47
- *
48
- * @example
49
- * ```ts
50
- * // Automatically fetches more pages as needed.
51
- * for await (const bookkeepingAccount of client.bookkeepingAccounts.list()) {
52
- * // ...
53
- * }
54
- * ```
55
- */
56
- list(
57
- query: BookkeepingAccountListParams | null | undefined = {},
58
- options?: RequestOptions,
59
- ): PagePromise<BookkeepingAccountsPage, BookkeepingAccount> {
60
- return this._client.getAPIList('/bookkeeping_accounts', Page<BookkeepingAccount>, { query, ...options });
61
- }
62
-
63
- /**
64
- * Retrieve a Bookkeeping Account Balance
65
- *
66
- * @example
67
- * ```ts
68
- * const bookkeepingBalanceLookup =
69
- * await client.bookkeepingAccounts.balance(
70
- * 'bookkeeping_account_e37p1f1iuocw5intf35v',
71
- * );
72
- * ```
73
- */
74
- balance(
75
- bookkeepingAccountID: string,
76
- query: BookkeepingAccountBalanceParams | null | undefined = {},
77
- options?: RequestOptions,
78
- ): APIPromise<BookkeepingBalanceLookup> {
79
- return this._client.get(path`/bookkeeping_accounts/${bookkeepingAccountID}/balance`, {
80
- query,
81
- ...options,
82
- });
83
- }
84
- }
85
-
86
- export type BookkeepingAccountsPage = Page<BookkeepingAccount>;
87
-
88
- /**
89
- * Accounts are T-accounts. They can store accounting entries. Your compliance
90
- * setup might require annotating money movements using this API. Learn more in our
91
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
92
- */
93
- export interface BookkeepingAccount {
94
- /**
95
- * The account identifier.
96
- */
97
- id: string;
98
-
99
- /**
100
- * The API Account associated with this bookkeeping account.
101
- */
102
- account_id: string | null;
103
-
104
- /**
105
- * The compliance category of the account.
106
- *
107
- * - `commingled_cash` - A cash in an commingled Increase Account.
108
- * - `customer_balance` - A customer balance.
109
- */
110
- compliance_category: 'commingled_cash' | 'customer_balance' | null;
111
-
112
- /**
113
- * The Entity associated with this bookkeeping account.
114
- */
115
- entity_id: string | null;
116
-
117
- /**
118
- * The idempotency key you chose for this object. This value is unique across
119
- * Increase and is used to ensure that a request is only processed once. Learn more
120
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
121
- */
122
- idempotency_key: string | null;
123
-
124
- /**
125
- * The name you choose for the account.
126
- */
127
- name: string;
128
-
129
- /**
130
- * A constant representing the object's type. For this resource it will always be
131
- * `bookkeeping_account`.
132
- */
133
- type: 'bookkeeping_account';
134
- }
135
-
136
- /**
137
- * Represents a request to lookup the balance of a Bookkeeping Account at a given
138
- * point in time.
139
- */
140
- export interface BookkeepingBalanceLookup {
141
- /**
142
- * The Bookkeeping Account's current balance, representing the sum of all
143
- * Bookkeeping Entries on the Bookkeeping Account.
144
- */
145
- balance: number;
146
-
147
- /**
148
- * The identifier for the account for which the balance was queried.
149
- */
150
- bookkeeping_account_id: string;
151
-
152
- /**
153
- * A constant representing the object's type. For this resource it will always be
154
- * `bookkeeping_balance_lookup`.
155
- */
156
- type: 'bookkeeping_balance_lookup';
157
- }
158
-
159
- export interface BookkeepingAccountCreateParams {
160
- /**
161
- * The name you choose for the account.
162
- */
163
- name: string;
164
-
165
- /**
166
- * The account, if `compliance_category` is `commingled_cash`.
167
- */
168
- account_id?: string;
169
-
170
- /**
171
- * The account compliance category.
172
- *
173
- * - `commingled_cash` - A cash in an commingled Increase Account.
174
- * - `customer_balance` - A customer balance.
175
- */
176
- compliance_category?: 'commingled_cash' | 'customer_balance';
177
-
178
- /**
179
- * The entity, if `compliance_category` is `customer_balance`.
180
- */
181
- entity_id?: string;
182
-
183
- [k: string]: unknown;
184
- }
185
-
186
- export interface BookkeepingAccountUpdateParams {
187
- /**
188
- * The name you choose for the account.
189
- */
190
- name: string;
191
- }
192
-
193
- export interface BookkeepingAccountListParams extends PageParams {
194
- /**
195
- * Filter records to the one with the specified `idempotency_key` you chose for
196
- * that object. This value is unique across Increase and is used to ensure that a
197
- * request is only processed once. Learn more about
198
- * [idempotency](https://increase.com/documentation/idempotency-keys).
199
- */
200
- idempotency_key?: string;
201
- }
202
-
203
- export interface BookkeepingAccountBalanceParams {
204
- /**
205
- * The moment to query the balance at. If not set, returns the current balances.
206
- */
207
- at_time?: string;
208
- }
209
-
210
- export declare namespace BookkeepingAccounts {
211
- export {
212
- type BookkeepingAccount as BookkeepingAccount,
213
- type BookkeepingBalanceLookup as BookkeepingBalanceLookup,
214
- type BookkeepingAccountsPage as BookkeepingAccountsPage,
215
- type BookkeepingAccountCreateParams as BookkeepingAccountCreateParams,
216
- type BookkeepingAccountUpdateParams as BookkeepingAccountUpdateParams,
217
- type BookkeepingAccountListParams as BookkeepingAccountListParams,
218
- type BookkeepingAccountBalanceParams as BookkeepingAccountBalanceParams,
219
- };
220
- }
@@ -1,98 +0,0 @@
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 BookkeepingEntries extends APIResource {
10
- /**
11
- * Retrieve a Bookkeeping Entry
12
- *
13
- * @example
14
- * ```ts
15
- * const bookkeepingEntry =
16
- * await client.bookkeepingEntries.retrieve(
17
- * 'bookkeeping_entry_ctjpajsj3ks2blx10375',
18
- * );
19
- * ```
20
- */
21
- retrieve(bookkeepingEntryID: string, options?: RequestOptions): APIPromise<BookkeepingEntry> {
22
- return this._client.get(path`/bookkeeping_entries/${bookkeepingEntryID}`, options);
23
- }
24
-
25
- /**
26
- * List Bookkeeping Entries
27
- *
28
- * @example
29
- * ```ts
30
- * // Automatically fetches more pages as needed.
31
- * for await (const bookkeepingEntry of client.bookkeepingEntries.list()) {
32
- * // ...
33
- * }
34
- * ```
35
- */
36
- list(
37
- query: BookkeepingEntryListParams | null | undefined = {},
38
- options?: RequestOptions,
39
- ): PagePromise<BookkeepingEntriesPage, BookkeepingEntry> {
40
- return this._client.getAPIList('/bookkeeping_entries', Page<BookkeepingEntry>, { query, ...options });
41
- }
42
- }
43
-
44
- export type BookkeepingEntriesPage = Page<BookkeepingEntry>;
45
-
46
- /**
47
- * Entries are T-account entries recording debits and credits. Your compliance
48
- * setup might require annotating money movements using this API. Learn more in our
49
- * [guide to Bookkeeping](https://increase.com/documentation/bookkeeping#bookkeeping).
50
- */
51
- export interface BookkeepingEntry {
52
- /**
53
- * The entry identifier.
54
- */
55
- id: string;
56
-
57
- /**
58
- * The identifier for the Account the Entry belongs to.
59
- */
60
- account_id: string;
61
-
62
- /**
63
- * The Entry amount in the minor unit of its currency. For dollars, for example,
64
- * this is cents.
65
- */
66
- amount: number;
67
-
68
- /**
69
- * When the entry set was created.
70
- */
71
- created_at: string;
72
-
73
- /**
74
- * The identifier for the Entry Set the Entry belongs to.
75
- */
76
- entry_set_id: string;
77
-
78
- /**
79
- * A constant representing the object's type. For this resource it will always be
80
- * `bookkeeping_entry`.
81
- */
82
- type: 'bookkeeping_entry';
83
- }
84
-
85
- export interface BookkeepingEntryListParams extends PageParams {
86
- /**
87
- * The identifier for the Bookkeeping Account to filter by.
88
- */
89
- account_id?: string;
90
- }
91
-
92
- export declare namespace BookkeepingEntries {
93
- export {
94
- type BookkeepingEntry as BookkeepingEntry,
95
- type BookkeepingEntriesPage as BookkeepingEntriesPage,
96
- type BookkeepingEntryListParams as BookkeepingEntryListParams,
97
- };
98
- }