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 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,mBAAmB,GAKpB;OACM,EACL,YAAY,GAKb;OACM,EACL,cAAc,GAMf;OACM,EACL,iBAAiB,GAIlB;OACM,EACL,gBAAgB,GAKjB;OACM,EACL,QAAQ,GAQT;OACM,EACL,gBAAgB,GAMjB;OACM,EACL,mBAAmB,GAQpB;OACM,EACL,kBAAkB,GAInB;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,YAAY,GAOb;OACM,EACL,YAAY,GAIb;OACM,EACL,uBAAuB,GAIxB;OACM,EACL,iBAAiB,GAKlB;OACM,EACL,UAAU,GAKX;OACM,EACL,eAAe,GAKhB;OACM,EACL,KAAK,GAUN;OACM,EACL,aAAa,GAKd;OACM,EACL,cAAc,GAMf;OACM,EACL,oBAAoB,GAIrB;OACM,EACL,mBAAmB,GAMpB;OACM,EACL,mBAAmB,GAIpB;OACM,EACL,QAAQ,GAMT;OACM,EACL,wBAAwB,GAKzB;OACM,EACL,kBAAkB,GAMnB;OACM,EAAE,MAAM,EAA8E;OACtF,EACL,OAAO,GAKR;OACM,EACL,gBAAgB,GAMjB;OACM,EACL,eAAe,GAKhB;OACM,EAAE,SAAS,EAA4C;OACvD,EAAE,KAAK,EAAyE;OAChF,EAAE,MAAM,EAAc;OACtB,EACL,mBAAmB,GAOpB;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,sBAAsB,GAIvB;OACM,EACL,gBAAgB,GAKjB;OACM,EACL,gCAAgC,GAIjC;OACM,EACL,2BAA2B,GAI5B;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,yBAAyB,GAK1B;OACM,EAAE,eAAe,EAAuB;OACxC,EACL,iBAAiB,GAKlB;OACM,EACL,SAAS,GAMV;OACM,EACL,iBAAiB,GAIlB;OACM,EACL,gBAAgB,GAIjB;OACM,EAAE,WAAW,EAAgD;OAC7D,EACL,mBAAmB,GAKpB;OACM,EACL,oBAAoB,GAMrB;OACM,EACL,aAAa,GAMd;OACM,EAAE,QAAQ,EAA2D;OACrE,EACL,iBAAiB,GAGlB;OACM,EACL,yBAAyB,GAK1B;OACM,EACL,cAAc,GAIf;OACM,EAAE,WAAW,EAAE;OACf,EACL,qBAAqB,GAKtB;OACM,EACL,cAAc,GAKf;OACM,EACL,YAAY,GAIb;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,aAAa,GAKd"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,mBAAmB,GAKpB;OACM,EACL,YAAY,GAKb;OACM,EACL,cAAc,GAMf;OACM,EACL,iBAAiB,GAIlB;OACM,EACL,gBAAgB,GAKjB;OACM,EACL,QAAQ,GAQT;OACM,EACL,gBAAgB,GAMjB;OACM,EACL,YAAY,GAOb;OACM,EACL,YAAY,GAIb;OACM,EACL,uBAAuB,GAIxB;OACM,EACL,iBAAiB,GAKlB;OACM,EACL,UAAU,GAKX;OACM,EACL,eAAe,GAKhB;OACM,EACL,KAAK,GAUN;OACM,EACL,aAAa,GAKd;OACM,EACL,cAAc,GAMf;OACM,EACL,oBAAoB,GAIrB;OACM,EACL,mBAAmB,GAMpB;OACM,EACL,mBAAmB,GAIpB;OACM,EACL,QAAQ,GAMT;OACM,EACL,wBAAwB,GAKzB;OACM,EACL,kBAAkB,GAMnB;OACM,EAAE,MAAM,EAA8E;OACtF,EACL,OAAO,GAKR;OACM,EACL,gBAAgB,GAMjB;OACM,EACL,eAAe,GAKhB;OACM,EAAE,SAAS,EAA4C;OACvD,EAAE,KAAK,EAAyE;OAChF,EAAE,MAAM,EAAc;OACtB,EACL,mBAAmB,GAOpB;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,sBAAsB,GAIvB;OACM,EACL,gBAAgB,GAKjB;OACM,EACL,gCAAgC,GAIjC;OACM,EACL,2BAA2B,GAI5B;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,yBAAyB,GAK1B;OACM,EAAE,eAAe,EAAuB;OACxC,EACL,iBAAiB,GAKlB;OACM,EACL,gBAAgB,GAMjB;OACM,EACL,iBAAiB,GAMlB;OACM,EACL,iBAAiB,GAIlB;OACM,EACL,gBAAgB,GAIjB;OACM,EAAE,WAAW,EAAgD;OAC7D,EACL,mBAAmB,GAKpB;OACM,EACL,oBAAoB,GAMrB;OACM,EACL,aAAa,GAMd;OACM,EAAE,QAAQ,EAA2D;OACrE,EACL,iBAAiB,GAGlB;OACM,EACL,yBAAyB,GAK1B;OACM,EACL,cAAc,GAIf;OACM,EAAE,WAAW,EAAE;OACf,EACL,qBAAqB,GAKtB;OACM,EACL,cAAc,GAKf;OACM,EACL,YAAY,GAIb;OACM,EACL,oBAAoB,GAKrB;OACM,EACL,aAAa,GAKd"}
@@ -0,0 +1,184 @@
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 LockboxAddresses extends APIResource {
6
+ /**
7
+ * Create a Lockbox Address
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const lockboxAddress =
12
+ * await client.lockboxAddresses.create();
13
+ * ```
14
+ */
15
+ create(body: LockboxAddressCreateParams, options?: RequestOptions): APIPromise<LockboxAddress>;
16
+ /**
17
+ * Retrieve a Lockbox Address
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const lockboxAddress =
22
+ * await client.lockboxAddresses.retrieve(
23
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
24
+ * );
25
+ * ```
26
+ */
27
+ retrieve(lockboxAddressID: string, options?: RequestOptions): APIPromise<LockboxAddress>;
28
+ /**
29
+ * Update a Lockbox Address
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const lockboxAddress = await client.lockboxAddresses.update(
34
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
35
+ * );
36
+ * ```
37
+ */
38
+ update(lockboxAddressID: string, body: LockboxAddressUpdateParams, options?: RequestOptions): APIPromise<LockboxAddress>;
39
+ /**
40
+ * List Lockbox Addresses
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * // Automatically fetches more pages as needed.
45
+ * for await (const lockboxAddress of client.lockboxAddresses.list()) {
46
+ * // ...
47
+ * }
48
+ * ```
49
+ */
50
+ list(query?: LockboxAddressListParams | null | undefined, options?: RequestOptions): PagePromise<LockboxAddressesPage, LockboxAddress>;
51
+ }
52
+ export type LockboxAddressesPage = Page<LockboxAddress>;
53
+ /**
54
+ * Lockbox Addresses are physical locations that can receive mail containing paper
55
+ * checks.
56
+ */
57
+ export interface LockboxAddress {
58
+ /**
59
+ * The Lockbox Address identifier.
60
+ */
61
+ id: string;
62
+ /**
63
+ * The mailing address for the Lockbox Address. It will be present after Increase
64
+ * generates it.
65
+ */
66
+ address: LockboxAddress.Address | null;
67
+ /**
68
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
69
+ * Address was created.
70
+ */
71
+ created_at: string;
72
+ /**
73
+ * The description you choose for the Lockbox Address.
74
+ */
75
+ description: string | null;
76
+ /**
77
+ * The idempotency key you chose for this object. This value is unique across
78
+ * Increase and is used to ensure that a request is only processed once. Learn more
79
+ * about [idempotency](https://increase.com/documentation/idempotency-keys).
80
+ */
81
+ idempotency_key: string | null;
82
+ /**
83
+ * The status of the Lockbox Address.
84
+ *
85
+ * - `pending` - Increase is generating this Lockbox Address.
86
+ * - `active` - This Lockbox Address is active.
87
+ * - `disabled` - This Lockbox Address is disabled.
88
+ * - `canceled` - This Lockbox Address is permanently disabled.
89
+ */
90
+ status: 'pending' | 'active' | 'disabled' | 'canceled';
91
+ /**
92
+ * A constant representing the object's type. For this resource it will always be
93
+ * `lockbox_address`.
94
+ */
95
+ type: 'lockbox_address';
96
+ }
97
+ export declare namespace LockboxAddress {
98
+ /**
99
+ * The mailing address for the Lockbox Address. It will be present after Increase
100
+ * generates it.
101
+ */
102
+ interface Address {
103
+ /**
104
+ * The city of the address.
105
+ */
106
+ city: string;
107
+ /**
108
+ * The first line of the address.
109
+ */
110
+ line1: string;
111
+ /**
112
+ * The second line of the address.
113
+ */
114
+ line2: string;
115
+ /**
116
+ * The postal code of the address.
117
+ */
118
+ postal_code: string;
119
+ /**
120
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
121
+ * the address.
122
+ */
123
+ state: string;
124
+ }
125
+ }
126
+ export interface LockboxAddressCreateParams {
127
+ /**
128
+ * The description you choose for the Lockbox Address.
129
+ */
130
+ description?: string;
131
+ [k: string]: unknown;
132
+ }
133
+ export interface LockboxAddressUpdateParams {
134
+ /**
135
+ * The description you choose for the Lockbox Address.
136
+ */
137
+ description?: string;
138
+ /**
139
+ * The status of the Lockbox Address.
140
+ *
141
+ * - `active` - This Lockbox Address is active.
142
+ * - `disabled` - This Lockbox Address is disabled.
143
+ * - `canceled` - This Lockbox Address is permanently disabled.
144
+ */
145
+ status?: 'active' | 'disabled' | 'canceled';
146
+ }
147
+ export interface LockboxAddressListParams extends PageParams {
148
+ created_at?: LockboxAddressListParams.CreatedAt;
149
+ /**
150
+ * Filter records to the one with the specified `idempotency_key` you chose for
151
+ * that object. This value is unique across Increase and is used to ensure that a
152
+ * request is only processed once. Learn more about
153
+ * [idempotency](https://increase.com/documentation/idempotency-keys).
154
+ */
155
+ idempotency_key?: string;
156
+ }
157
+ export declare namespace LockboxAddressListParams {
158
+ interface CreatedAt {
159
+ /**
160
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
161
+ * timestamp.
162
+ */
163
+ after?: string;
164
+ /**
165
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
166
+ * timestamp.
167
+ */
168
+ before?: string;
169
+ /**
170
+ * Return results on or after this
171
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
172
+ */
173
+ on_or_after?: string;
174
+ /**
175
+ * Return results on or before this
176
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
177
+ */
178
+ on_or_before?: string;
179
+ }
180
+ }
181
+ export declare namespace LockboxAddresses {
182
+ export { type LockboxAddress as LockboxAddress, type LockboxAddressesPage as LockboxAddressesPage, type LockboxAddressCreateParams as LockboxAddressCreateParams, type LockboxAddressUpdateParams as LockboxAddressUpdateParams, type LockboxAddressListParams as LockboxAddressListParams, };
183
+ }
184
+ //# sourceMappingURL=lockbox-addresses.d.mts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lockbox-addresses.d.mts","sourceRoot":"","sources":["../src/resources/lockbox-addresses.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,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIxF;;;;;;;;;OASG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,cAAc,CAAC;CAGrD;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAEvC;;;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;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IAEvD;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;OAGG;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;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,UAAU,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC;IAEhD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,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,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -0,0 +1,184 @@
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 LockboxAddresses extends APIResource {
6
+ /**
7
+ * Create a Lockbox Address
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const lockboxAddress =
12
+ * await client.lockboxAddresses.create();
13
+ * ```
14
+ */
15
+ create(body: LockboxAddressCreateParams, options?: RequestOptions): APIPromise<LockboxAddress>;
16
+ /**
17
+ * Retrieve a Lockbox Address
18
+ *
19
+ * @example
20
+ * ```ts
21
+ * const lockboxAddress =
22
+ * await client.lockboxAddresses.retrieve(
23
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
24
+ * );
25
+ * ```
26
+ */
27
+ retrieve(lockboxAddressID: string, options?: RequestOptions): APIPromise<LockboxAddress>;
28
+ /**
29
+ * Update a Lockbox Address
30
+ *
31
+ * @example
32
+ * ```ts
33
+ * const lockboxAddress = await client.lockboxAddresses.update(
34
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
35
+ * );
36
+ * ```
37
+ */
38
+ update(lockboxAddressID: string, body: LockboxAddressUpdateParams, options?: RequestOptions): APIPromise<LockboxAddress>;
39
+ /**
40
+ * List Lockbox Addresses
41
+ *
42
+ * @example
43
+ * ```ts
44
+ * // Automatically fetches more pages as needed.
45
+ * for await (const lockboxAddress of client.lockboxAddresses.list()) {
46
+ * // ...
47
+ * }
48
+ * ```
49
+ */
50
+ list(query?: LockboxAddressListParams | null | undefined, options?: RequestOptions): PagePromise<LockboxAddressesPage, LockboxAddress>;
51
+ }
52
+ export type LockboxAddressesPage = Page<LockboxAddress>;
53
+ /**
54
+ * Lockbox Addresses are physical locations that can receive mail containing paper
55
+ * checks.
56
+ */
57
+ export interface LockboxAddress {
58
+ /**
59
+ * The Lockbox Address identifier.
60
+ */
61
+ id: string;
62
+ /**
63
+ * The mailing address for the Lockbox Address. It will be present after Increase
64
+ * generates it.
65
+ */
66
+ address: LockboxAddress.Address | null;
67
+ /**
68
+ * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
69
+ * Address was created.
70
+ */
71
+ created_at: string;
72
+ /**
73
+ * The description you choose for the Lockbox Address.
74
+ */
75
+ description: string | null;
76
+ /**
77
+ * The idempotency key you chose for this object. This value is unique across
78
+ * Increase and is used to ensure that a request is only processed once. Learn more
79
+ * about [idempotency](https://increase.com/documentation/idempotency-keys).
80
+ */
81
+ idempotency_key: string | null;
82
+ /**
83
+ * The status of the Lockbox Address.
84
+ *
85
+ * - `pending` - Increase is generating this Lockbox Address.
86
+ * - `active` - This Lockbox Address is active.
87
+ * - `disabled` - This Lockbox Address is disabled.
88
+ * - `canceled` - This Lockbox Address is permanently disabled.
89
+ */
90
+ status: 'pending' | 'active' | 'disabled' | 'canceled';
91
+ /**
92
+ * A constant representing the object's type. For this resource it will always be
93
+ * `lockbox_address`.
94
+ */
95
+ type: 'lockbox_address';
96
+ }
97
+ export declare namespace LockboxAddress {
98
+ /**
99
+ * The mailing address for the Lockbox Address. It will be present after Increase
100
+ * generates it.
101
+ */
102
+ interface Address {
103
+ /**
104
+ * The city of the address.
105
+ */
106
+ city: string;
107
+ /**
108
+ * The first line of the address.
109
+ */
110
+ line1: string;
111
+ /**
112
+ * The second line of the address.
113
+ */
114
+ line2: string;
115
+ /**
116
+ * The postal code of the address.
117
+ */
118
+ postal_code: string;
119
+ /**
120
+ * The two-letter United States Postal Service (USPS) abbreviation for the state of
121
+ * the address.
122
+ */
123
+ state: string;
124
+ }
125
+ }
126
+ export interface LockboxAddressCreateParams {
127
+ /**
128
+ * The description you choose for the Lockbox Address.
129
+ */
130
+ description?: string;
131
+ [k: string]: unknown;
132
+ }
133
+ export interface LockboxAddressUpdateParams {
134
+ /**
135
+ * The description you choose for the Lockbox Address.
136
+ */
137
+ description?: string;
138
+ /**
139
+ * The status of the Lockbox Address.
140
+ *
141
+ * - `active` - This Lockbox Address is active.
142
+ * - `disabled` - This Lockbox Address is disabled.
143
+ * - `canceled` - This Lockbox Address is permanently disabled.
144
+ */
145
+ status?: 'active' | 'disabled' | 'canceled';
146
+ }
147
+ export interface LockboxAddressListParams extends PageParams {
148
+ created_at?: LockboxAddressListParams.CreatedAt;
149
+ /**
150
+ * Filter records to the one with the specified `idempotency_key` you chose for
151
+ * that object. This value is unique across Increase and is used to ensure that a
152
+ * request is only processed once. Learn more about
153
+ * [idempotency](https://increase.com/documentation/idempotency-keys).
154
+ */
155
+ idempotency_key?: string;
156
+ }
157
+ export declare namespace LockboxAddressListParams {
158
+ interface CreatedAt {
159
+ /**
160
+ * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
161
+ * timestamp.
162
+ */
163
+ after?: string;
164
+ /**
165
+ * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
166
+ * timestamp.
167
+ */
168
+ before?: string;
169
+ /**
170
+ * Return results on or after this
171
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
172
+ */
173
+ on_or_after?: string;
174
+ /**
175
+ * Return results on or before this
176
+ * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
177
+ */
178
+ on_or_before?: string;
179
+ }
180
+ }
181
+ export declare namespace LockboxAddresses {
182
+ export { type LockboxAddress as LockboxAddress, type LockboxAddressesPage as LockboxAddressesPage, type LockboxAddressCreateParams as LockboxAddressCreateParams, type LockboxAddressUpdateParams as LockboxAddressUpdateParams, type LockboxAddressListParams as LockboxAddressListParams, };
183
+ }
184
+ //# sourceMappingURL=lockbox-addresses.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lockbox-addresses.d.ts","sourceRoot":"","sources":["../src/resources/lockbox-addresses.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,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAI,EAAE,0BAA0B,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAI9F;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAgB,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,cAAc,CAAC;IAIxF;;;;;;;;;OASG;IACH,MAAM,CACJ,gBAAgB,EAAE,MAAM,EACxB,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,cAAc,CAAC;IAI7B;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,wBAAwB,GAAG,IAAI,GAAG,SAAc,EACvD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,oBAAoB,EAAE,cAAc,CAAC;CAGrD;AAED,MAAM,MAAM,oBAAoB,GAAG,IAAI,CAAC,cAAc,CAAC,CAAC;AAExD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;OAGG;IACH,OAAO,EAAE,cAAc,CAAC,OAAO,GAAG,IAAI,CAAC;IAEvC;;;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;;;;;;;OAOG;IACH,MAAM,EAAE,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;IAEvD;;;OAGG;IACH,IAAI,EAAE,iBAAiB,CAAC;CACzB;AAED,yBAAiB,cAAc,CAAC;IAC9B;;;OAGG;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;;;WAGG;QACH,KAAK,EAAE,MAAM,CAAC;KACf;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC;CAC7C;AAED,MAAM,WAAW,wBAAyB,SAAQ,UAAU;IAC1D,UAAU,CAAC,EAAE,wBAAwB,CAAC,SAAS,CAAC;IAEhD;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,wBAAwB,CAAC;IACxC,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,gBAAgB,CAAC;IACxC,OAAO,EACL,KAAK,cAAc,IAAI,cAAc,EACrC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,GAC1D,CAAC;CACH"}
@@ -0,0 +1,64 @@
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.LockboxAddresses = 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 LockboxAddresses extends resource_1.APIResource {
9
+ /**
10
+ * Create a Lockbox Address
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const lockboxAddress =
15
+ * await client.lockboxAddresses.create();
16
+ * ```
17
+ */
18
+ create(body, options) {
19
+ return this._client.post('/lockbox_addresses', { body, ...options });
20
+ }
21
+ /**
22
+ * Retrieve a Lockbox Address
23
+ *
24
+ * @example
25
+ * ```ts
26
+ * const lockboxAddress =
27
+ * await client.lockboxAddresses.retrieve(
28
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
29
+ * );
30
+ * ```
31
+ */
32
+ retrieve(lockboxAddressID, options) {
33
+ return this._client.get((0, path_1.path) `/lockbox_addresses/${lockboxAddressID}`, options);
34
+ }
35
+ /**
36
+ * Update a Lockbox Address
37
+ *
38
+ * @example
39
+ * ```ts
40
+ * const lockboxAddress = await client.lockboxAddresses.update(
41
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
42
+ * );
43
+ * ```
44
+ */
45
+ update(lockboxAddressID, body, options) {
46
+ return this._client.patch((0, path_1.path) `/lockbox_addresses/${lockboxAddressID}`, { body, ...options });
47
+ }
48
+ /**
49
+ * List Lockbox Addresses
50
+ *
51
+ * @example
52
+ * ```ts
53
+ * // Automatically fetches more pages as needed.
54
+ * for await (const lockboxAddress of client.lockboxAddresses.list()) {
55
+ * // ...
56
+ * }
57
+ * ```
58
+ */
59
+ list(query = {}, options) {
60
+ return this._client.getAPIList('/lockbox_addresses', (pagination_1.Page), { query, ...options });
61
+ }
62
+ }
63
+ exports.LockboxAddresses = LockboxAddresses;
64
+ //# sourceMappingURL=lockbox-addresses.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lockbox-addresses.js","sourceRoot":"","sources":["../src/resources/lockbox-addresses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,gBAAiB,SAAQ,sBAAW;IAC/C;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,sBAAsB,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,gBAAwB,EACxB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,sBAAsB,gBAAgB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAA,iBAAoB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF;AAhED,4CAgEC"}
@@ -0,0 +1,60 @@
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 LockboxAddresses extends APIResource {
6
+ /**
7
+ * Create a Lockbox Address
8
+ *
9
+ * @example
10
+ * ```ts
11
+ * const lockboxAddress =
12
+ * await client.lockboxAddresses.create();
13
+ * ```
14
+ */
15
+ create(body, options) {
16
+ return this._client.post('/lockbox_addresses', { body, ...options });
17
+ }
18
+ /**
19
+ * Retrieve a Lockbox Address
20
+ *
21
+ * @example
22
+ * ```ts
23
+ * const lockboxAddress =
24
+ * await client.lockboxAddresses.retrieve(
25
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
26
+ * );
27
+ * ```
28
+ */
29
+ retrieve(lockboxAddressID, options) {
30
+ return this._client.get(path `/lockbox_addresses/${lockboxAddressID}`, options);
31
+ }
32
+ /**
33
+ * Update a Lockbox Address
34
+ *
35
+ * @example
36
+ * ```ts
37
+ * const lockboxAddress = await client.lockboxAddresses.update(
38
+ * 'lockbox_address_lw6sbzl9ol5dfd8hdml6',
39
+ * );
40
+ * ```
41
+ */
42
+ update(lockboxAddressID, body, options) {
43
+ return this._client.patch(path `/lockbox_addresses/${lockboxAddressID}`, { body, ...options });
44
+ }
45
+ /**
46
+ * List Lockbox Addresses
47
+ *
48
+ * @example
49
+ * ```ts
50
+ * // Automatically fetches more pages as needed.
51
+ * for await (const lockboxAddress of client.lockboxAddresses.list()) {
52
+ * // ...
53
+ * }
54
+ * ```
55
+ */
56
+ list(query = {}, options) {
57
+ return this._client.getAPIList('/lockbox_addresses', (Page), { query, ...options });
58
+ }
59
+ }
60
+ //# sourceMappingURL=lockbox-addresses.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"lockbox-addresses.mjs","sourceRoot":"","sources":["../src/resources/lockbox-addresses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,IAAI,EAAgC;OAEtC,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,gBAAiB,SAAQ,WAAW;IAC/C;;;;;;;;OAQG;IACH,MAAM,CAAC,IAAgC,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,oBAAoB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACvE,CAAC;IAED;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,gBAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,sBAAsB,gBAAgB,EAAE,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;;;;OASG;IACH,MAAM,CACJ,gBAAwB,EACxB,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,sBAAsB,gBAAgB,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAChG,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAAqD,EAAE,EACvD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,oBAAoB,EAAE,CAAA,IAAoB,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACpG,CAAC;CACF"}