increase 0.388.0 → 0.390.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 (70) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/client.d.mts +0 -3
  3. package/client.d.mts.map +1 -1
  4. package/client.d.ts +0 -3
  5. package/client.d.ts.map +1 -1
  6. package/client.js +0 -3
  7. package/client.js.map +1 -1
  8. package/client.mjs +0 -3
  9. package/client.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/index.d.mts +0 -1
  12. package/resources/index.d.mts.map +1 -1
  13. package/resources/index.d.ts +0 -1
  14. package/resources/index.d.ts.map +1 -1
  15. package/resources/index.js +2 -4
  16. package/resources/index.js.map +1 -1
  17. package/resources/index.mjs +0 -1
  18. package/resources/index.mjs.map +1 -1
  19. package/resources/simulations/exports.d.mts +26 -4
  20. package/resources/simulations/exports.d.mts.map +1 -1
  21. package/resources/simulations/exports.d.ts +26 -4
  22. package/resources/simulations/exports.d.ts.map +1 -1
  23. package/resources/simulations/exports.js +5 -2
  24. package/resources/simulations/exports.js.map +1 -1
  25. package/resources/simulations/exports.mjs +5 -2
  26. package/resources/simulations/exports.mjs.map +1 -1
  27. package/resources/simulations/index.d.mts +0 -1
  28. package/resources/simulations/index.d.mts.map +1 -1
  29. package/resources/simulations/index.d.ts +0 -1
  30. package/resources/simulations/index.d.ts.map +1 -1
  31. package/resources/simulations/index.js +1 -3
  32. package/resources/simulations/index.js.map +1 -1
  33. package/resources/simulations/index.mjs +0 -1
  34. package/resources/simulations/index.mjs.map +1 -1
  35. package/resources/simulations/simulations.d.mts +0 -4
  36. package/resources/simulations/simulations.d.mts.map +1 -1
  37. package/resources/simulations/simulations.d.ts +0 -4
  38. package/resources/simulations/simulations.d.ts.map +1 -1
  39. package/resources/simulations/simulations.js +0 -4
  40. package/resources/simulations/simulations.js.map +1 -1
  41. package/resources/simulations/simulations.mjs +0 -4
  42. package/resources/simulations/simulations.mjs.map +1 -1
  43. package/src/client.ts +0 -17
  44. package/src/resources/index.ts +0 -7
  45. package/src/resources/simulations/exports.ts +28 -4
  46. package/src/resources/simulations/index.ts +0 -1
  47. package/src/resources/simulations/simulations.ts +0 -6
  48. package/src/version.ts +1 -1
  49. package/version.d.mts +1 -1
  50. package/version.d.ts +1 -1
  51. package/version.js +1 -1
  52. package/version.mjs +1 -1
  53. package/resources/documents.d.mts +0 -213
  54. package/resources/documents.d.mts.map +0 -1
  55. package/resources/documents.d.ts +0 -213
  56. package/resources/documents.d.ts.map +0 -1
  57. package/resources/documents.js +0 -51
  58. package/resources/documents.js.map +0 -1
  59. package/resources/documents.mjs +0 -47
  60. package/resources/documents.mjs.map +0 -1
  61. package/resources/simulations/documents.d.mts +0 -27
  62. package/resources/simulations/documents.d.mts.map +0 -1
  63. package/resources/simulations/documents.d.ts +0 -27
  64. package/resources/simulations/documents.d.ts.map +0 -1
  65. package/resources/simulations/documents.js +0 -22
  66. package/resources/simulations/documents.js.map +0 -1
  67. package/resources/simulations/documents.mjs +0 -18
  68. package/resources/simulations/documents.mjs.map +0 -1
  69. package/src/resources/documents.ts +0 -274
  70. package/src/resources/simulations/documents.ts +0 -33
package/src/client.ts CHANGED
@@ -175,13 +175,6 @@ import {
175
175
  DigitalWalletTokens,
176
176
  DigitalWalletTokensPage,
177
177
  } from './resources/digital-wallet-tokens';
178
- import {
179
- Document,
180
- DocumentCreateParams,
181
- DocumentListParams,
182
- Documents,
183
- DocumentsPage,
184
- } from './resources/documents';
185
178
  import {
186
179
  Entities,
187
180
  EntitiesPage,
@@ -1159,7 +1152,6 @@ export class Increase {
1159
1152
  accountStatements: API.AccountStatements = new API.AccountStatements(this);
1160
1153
  files: API.Files = new API.Files(this);
1161
1154
  fileLinks: API.FileLinks = new API.FileLinks(this);
1162
- documents: API.Documents = new API.Documents(this);
1163
1155
  exports: API.Exports = new API.Exports(this);
1164
1156
  events: API.Events = new API.Events(this);
1165
1157
  eventSubscriptions: API.EventSubscriptions = new API.EventSubscriptions(this);
@@ -1218,7 +1210,6 @@ Increase.Programs = Programs;
1218
1210
  Increase.AccountStatements = AccountStatements;
1219
1211
  Increase.Files = Files;
1220
1212
  Increase.FileLinks = FileLinks;
1221
- Increase.Documents = Documents;
1222
1213
  Increase.Exports = Exports;
1223
1214
  Increase.Events = Events;
1224
1215
  Increase.EventSubscriptions = EventSubscriptions;
@@ -1560,14 +1551,6 @@ export declare namespace Increase {
1560
1551
  type FileLinkCreateParams as FileLinkCreateParams,
1561
1552
  };
1562
1553
 
1563
- export {
1564
- Documents as Documents,
1565
- type Document as Document,
1566
- type DocumentsPage as DocumentsPage,
1567
- type DocumentCreateParams as DocumentCreateParams,
1568
- type DocumentListParams as DocumentListParams,
1569
- };
1570
-
1571
1554
  export {
1572
1555
  Exports as Exports,
1573
1556
  type Export as Export,
@@ -156,13 +156,6 @@ export {
156
156
  type DigitalWalletTokenListParams,
157
157
  type DigitalWalletTokensPage,
158
158
  } from './digital-wallet-tokens';
159
- export {
160
- Documents,
161
- type Document,
162
- type DocumentCreateParams,
163
- type DocumentListParams,
164
- type DocumentsPage,
165
- } from './documents';
166
159
  export {
167
160
  Entities,
168
161
  type Entity,
@@ -7,12 +7,15 @@ import { RequestOptions } from '../../internal/request-options';
7
7
 
8
8
  export class Exports extends APIResource {
9
9
  /**
10
- * Simulates a tax form export being generated.
10
+ * Many exports are created by you via POST /exports or in the Dashboard. Some
11
+ * exports are created automatically by Increase. For example, tax documents are
12
+ * published once a year. In sandbox, you can trigger the arrival of an export that
13
+ * would normally only be created automatically via this simulation.
11
14
  *
12
15
  * @example
13
16
  * ```ts
14
17
  * const _export = await client.simulations.exports.create({
15
- * account_id: 'account_in71c4amph0vgo2qllky',
18
+ * category: 'form_1099_int',
16
19
  * });
17
20
  * ```
18
21
  */
@@ -23,9 +26,30 @@ export class Exports extends APIResource {
23
26
 
24
27
  export interface ExportCreateParams {
25
28
  /**
26
- * The identifier of the Account the tax document is for.
29
+ * The type of Export to create.
30
+ *
31
+ * - `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
27
32
  */
28
- account_id: string;
33
+ category: 'form_1099_int';
34
+
35
+ /**
36
+ * Options for the created export. Required if `category` is equal to
37
+ * `form_1099_int`.
38
+ */
39
+ form_1099_int?: ExportCreateParams.Form1099Int;
40
+ }
41
+
42
+ export namespace ExportCreateParams {
43
+ /**
44
+ * Options for the created export. Required if `category` is equal to
45
+ * `form_1099_int`.
46
+ */
47
+ export interface Form1099Int {
48
+ /**
49
+ * The identifier of the Account the tax document is for.
50
+ */
51
+ account_id: string;
52
+ }
29
53
  }
30
54
 
31
55
  export declare namespace Exports {
@@ -32,7 +32,6 @@ export {
32
32
  type DigitalWalletTokenRequestCreateResponse,
33
33
  type DigitalWalletTokenRequestCreateParams,
34
34
  } from './digital-wallet-token-requests';
35
- export { Documents, type DocumentCreateParams } from './documents';
36
35
  export { Exports, type ExportCreateParams } from './exports';
37
36
  export { InboundACHTransfers, type InboundACHTransferCreateParams } from './inbound-ach-transfers';
38
37
  export { InboundCheckDeposits, type InboundCheckDepositCreateParams } from './inbound-check-deposits';
@@ -49,8 +49,6 @@ import {
49
49
  DigitalWalletTokenRequestCreateResponse,
50
50
  DigitalWalletTokenRequests,
51
51
  } from './digital-wallet-token-requests';
52
- import * as DocumentsAPI from './documents';
53
- import { DocumentCreateParams, Documents } from './documents';
54
52
  import * as ExportsAPI from './exports';
55
53
  import { ExportCreateParams, Exports } from './exports';
56
54
  import * as InboundACHTransfersAPI from './inbound-ach-transfers';
@@ -144,7 +142,6 @@ export class Simulations extends APIResource {
144
142
  accountStatements: AccountStatementsAPI.AccountStatements = new AccountStatementsAPI.AccountStatements(
145
143
  this._client,
146
144
  );
147
- documents: DocumentsAPI.Documents = new DocumentsAPI.Documents(this._client);
148
145
  exports: ExportsAPI.Exports = new ExportsAPI.Exports(this._client);
149
146
  cardTokens: CardTokensAPI.CardTokens = new CardTokensAPI.CardTokens(this._client);
150
147
  }
@@ -178,7 +175,6 @@ Simulations.CheckDeposits = CheckDeposits;
178
175
  Simulations.InboundMailItems = InboundMailItems;
179
176
  Simulations.Programs = Programs;
180
177
  Simulations.AccountStatements = AccountStatements;
181
- Simulations.Documents = Documents;
182
178
  Simulations.Exports = Exports;
183
179
  Simulations.CardTokens = CardTokens;
184
180
 
@@ -300,8 +296,6 @@ export declare namespace Simulations {
300
296
  type AccountStatementCreateParams as AccountStatementCreateParams,
301
297
  };
302
298
 
303
- export { Documents as Documents, type DocumentCreateParams as DocumentCreateParams };
304
-
305
299
  export { Exports as Exports, type ExportCreateParams as ExportCreateParams };
306
300
 
307
301
  export { CardTokens as CardTokens, type CardTokenCreateParams as CardTokenCreateParams };
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.388.0'; // x-release-please-version
1
+ export const VERSION = '0.390.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.388.0";
1
+ export declare const VERSION = "0.390.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.388.0";
1
+ export declare const VERSION = "0.390.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.388.0'; // x-release-please-version
4
+ exports.VERSION = '0.390.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.388.0'; // x-release-please-version
1
+ export const VERSION = '0.390.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map
@@ -1,213 +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 Documents extends APIResource {
6
- /**
7
- * Create a Document
8
- *
9
- * @example
10
- * ```ts
11
- * const document = await client.documents.create({
12
- * category: 'account_verification_letter',
13
- * });
14
- * ```
15
- */
16
- create(body: DocumentCreateParams, options?: RequestOptions): APIPromise<Document>;
17
- /**
18
- * Retrieve a Document
19
- *
20
- * @example
21
- * ```ts
22
- * const document = await client.documents.retrieve(
23
- * 'document_qjtqc6s4c14ve2q89izm',
24
- * );
25
- * ```
26
- */
27
- retrieve(documentID: string, options?: RequestOptions): APIPromise<Document>;
28
- /**
29
- * List Documents
30
- *
31
- * @example
32
- * ```ts
33
- * // Automatically fetches more pages as needed.
34
- * for await (const document of client.documents.list()) {
35
- * // ...
36
- * }
37
- * ```
38
- */
39
- list(query?: DocumentListParams | null | undefined, options?: RequestOptions): PagePromise<DocumentsPage, Document>;
40
- }
41
- export type DocumentsPage = Page<Document>;
42
- /**
43
- * Increase generates certain documents / forms automatically for your application;
44
- * they can be listed here.
45
- */
46
- export interface Document {
47
- /**
48
- * The Document identifier.
49
- */
50
- id: string;
51
- /**
52
- * Properties of an account verification letter document.
53
- */
54
- account_verification_letter: Document.AccountVerificationLetter | null;
55
- /**
56
- * The type of document.
57
- *
58
- * - `form_1099_int` - Internal Revenue Service Form 1099-INT.
59
- * - `form_1099_misc` - Internal Revenue Service Form 1099-MISC.
60
- * - `proof_of_authorization` - A document submitted in response to a proof of
61
- * authorization request for an ACH transfer.
62
- * - `company_information` - Company information, such a policies or procedures,
63
- * typically submitted during our due diligence process.
64
- * - `account_verification_letter` - An account verification letter.
65
- * - `funding_instructions` - Funding instructions.
66
- */
67
- category: 'form_1099_int' | 'form_1099_misc' | 'proof_of_authorization' | 'company_information' | 'account_verification_letter' | 'funding_instructions';
68
- /**
69
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
70
- * Document was created.
71
- */
72
- created_at: string;
73
- /**
74
- * The identifier of the Entity the document was generated for.
75
- */
76
- entity_id: string | null;
77
- /**
78
- * The identifier of the File containing the Document's contents.
79
- */
80
- file_id: string;
81
- /**
82
- * Properties of a funding instructions document.
83
- */
84
- funding_instructions: Document.FundingInstructions | null;
85
- /**
86
- * The idempotency key you chose for this object. This value is unique across
87
- * Increase and is used to ensure that a request is only processed once. Learn more
88
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
89
- */
90
- idempotency_key: string | null;
91
- /**
92
- * A constant representing the object's type. For this resource it will always be
93
- * `document`.
94
- */
95
- type: 'document';
96
- }
97
- export declare namespace Document {
98
- /**
99
- * Properties of an account verification letter document.
100
- */
101
- interface AccountVerificationLetter {
102
- /**
103
- * The identifier of the Account Number the document was generated for.
104
- */
105
- account_number_id: string;
106
- }
107
- /**
108
- * Properties of a funding instructions document.
109
- */
110
- interface FundingInstructions {
111
- /**
112
- * The identifier of the Account Number the document was generated for.
113
- */
114
- account_number_id: string;
115
- }
116
- }
117
- export interface DocumentCreateParams {
118
- /**
119
- * The type of document to create.
120
- *
121
- * - `account_verification_letter` - An account verification letter.
122
- * - `funding_instructions` - Funding instructions.
123
- */
124
- category: 'account_verification_letter' | 'funding_instructions';
125
- /**
126
- * An account verification letter. Required if and only if `category` is
127
- * `account_verification_letter`.
128
- */
129
- account_verification_letter?: DocumentCreateParams.AccountVerificationLetter;
130
- /**
131
- * Funding instructions. Required if and only if `category` is
132
- * `funding_instructions`.
133
- */
134
- funding_instructions?: DocumentCreateParams.FundingInstructions;
135
- [k: string]: unknown;
136
- }
137
- export declare namespace DocumentCreateParams {
138
- /**
139
- * An account verification letter. Required if and only if `category` is
140
- * `account_verification_letter`.
141
- */
142
- interface AccountVerificationLetter {
143
- /**
144
- * The Account Number the bank letter should be generated for.
145
- */
146
- account_number_id: string;
147
- /**
148
- * If provided, the letter will include the Account's balance as of the date.
149
- */
150
- balance_date?: string;
151
- }
152
- /**
153
- * Funding instructions. Required if and only if `category` is
154
- * `funding_instructions`.
155
- */
156
- interface FundingInstructions {
157
- /**
158
- * The Account Number the funding instructions should be generated for.
159
- */
160
- account_number_id: string;
161
- }
162
- }
163
- export interface DocumentListParams extends PageParams {
164
- category?: DocumentListParams.Category;
165
- created_at?: DocumentListParams.CreatedAt;
166
- /**
167
- * Filter Documents to ones belonging to the specified Entity.
168
- */
169
- entity_id?: string;
170
- /**
171
- * Filter records to the one with the specified `idempotency_key` you chose for
172
- * that object. This value is unique across Increase and is used to ensure that a
173
- * request is only processed once. Learn more about
174
- * [idempotency](https://increase.com/documentation/idempotency-keys).
175
- */
176
- idempotency_key?: string;
177
- }
178
- export declare namespace DocumentListParams {
179
- interface Category {
180
- /**
181
- * Filter Documents for those with the specified category or categories. For GET
182
- * requests, this should be encoded as a comma-delimited string, such as
183
- * `?in=one,two,three`.
184
- */
185
- in?: Array<'form_1099_int' | 'form_1099_misc' | 'proof_of_authorization' | 'company_information' | 'account_verification_letter' | 'funding_instructions'>;
186
- }
187
- interface CreatedAt {
188
- /**
189
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
190
- * timestamp.
191
- */
192
- after?: string;
193
- /**
194
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
195
- * timestamp.
196
- */
197
- before?: string;
198
- /**
199
- * Return results on or after this
200
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
201
- */
202
- on_or_after?: string;
203
- /**
204
- * Return results on or before this
205
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
206
- */
207
- on_or_before?: string;
208
- }
209
- }
210
- export declare namespace Documents {
211
- export { type Document as Document, type DocumentsPage as DocumentsPage, type DocumentCreateParams as DocumentCreateParams, type DocumentListParams as DocumentListParams, };
212
- }
213
- //# sourceMappingURL=documents.d.mts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"documents.d.mts","sourceRoot":"","sources":["../src/resources/documents.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,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI5E;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;CAGxC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,EAAE,QAAQ,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEvE;;;;;;;;;;;OAWG;IACH,QAAQ,EACJ,eAAe,GACf,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,6BAA6B,GAC7B,sBAAsB,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,oBAAoB,EAAE,QAAQ,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,6BAA6B,GAAG,sBAAsB,CAAC;IAEjE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,oBAAoB,CAAC,yBAAyB,CAAC;IAE7E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC;IAEhE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC,UAAU,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,EAAE,CAAC,EAAE,KAAK,CACN,eAAe,GACf,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,6BAA6B,GAC7B,sBAAsB,CACzB,CAAC;KACH;IAED,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,QAAQ,IAAI,QAAQ,EACzB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -1,213 +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 Documents extends APIResource {
6
- /**
7
- * Create a Document
8
- *
9
- * @example
10
- * ```ts
11
- * const document = await client.documents.create({
12
- * category: 'account_verification_letter',
13
- * });
14
- * ```
15
- */
16
- create(body: DocumentCreateParams, options?: RequestOptions): APIPromise<Document>;
17
- /**
18
- * Retrieve a Document
19
- *
20
- * @example
21
- * ```ts
22
- * const document = await client.documents.retrieve(
23
- * 'document_qjtqc6s4c14ve2q89izm',
24
- * );
25
- * ```
26
- */
27
- retrieve(documentID: string, options?: RequestOptions): APIPromise<Document>;
28
- /**
29
- * List Documents
30
- *
31
- * @example
32
- * ```ts
33
- * // Automatically fetches more pages as needed.
34
- * for await (const document of client.documents.list()) {
35
- * // ...
36
- * }
37
- * ```
38
- */
39
- list(query?: DocumentListParams | null | undefined, options?: RequestOptions): PagePromise<DocumentsPage, Document>;
40
- }
41
- export type DocumentsPage = Page<Document>;
42
- /**
43
- * Increase generates certain documents / forms automatically for your application;
44
- * they can be listed here.
45
- */
46
- export interface Document {
47
- /**
48
- * The Document identifier.
49
- */
50
- id: string;
51
- /**
52
- * Properties of an account verification letter document.
53
- */
54
- account_verification_letter: Document.AccountVerificationLetter | null;
55
- /**
56
- * The type of document.
57
- *
58
- * - `form_1099_int` - Internal Revenue Service Form 1099-INT.
59
- * - `form_1099_misc` - Internal Revenue Service Form 1099-MISC.
60
- * - `proof_of_authorization` - A document submitted in response to a proof of
61
- * authorization request for an ACH transfer.
62
- * - `company_information` - Company information, such a policies or procedures,
63
- * typically submitted during our due diligence process.
64
- * - `account_verification_letter` - An account verification letter.
65
- * - `funding_instructions` - Funding instructions.
66
- */
67
- category: 'form_1099_int' | 'form_1099_misc' | 'proof_of_authorization' | 'company_information' | 'account_verification_letter' | 'funding_instructions';
68
- /**
69
- * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
70
- * Document was created.
71
- */
72
- created_at: string;
73
- /**
74
- * The identifier of the Entity the document was generated for.
75
- */
76
- entity_id: string | null;
77
- /**
78
- * The identifier of the File containing the Document's contents.
79
- */
80
- file_id: string;
81
- /**
82
- * Properties of a funding instructions document.
83
- */
84
- funding_instructions: Document.FundingInstructions | null;
85
- /**
86
- * The idempotency key you chose for this object. This value is unique across
87
- * Increase and is used to ensure that a request is only processed once. Learn more
88
- * about [idempotency](https://increase.com/documentation/idempotency-keys).
89
- */
90
- idempotency_key: string | null;
91
- /**
92
- * A constant representing the object's type. For this resource it will always be
93
- * `document`.
94
- */
95
- type: 'document';
96
- }
97
- export declare namespace Document {
98
- /**
99
- * Properties of an account verification letter document.
100
- */
101
- interface AccountVerificationLetter {
102
- /**
103
- * The identifier of the Account Number the document was generated for.
104
- */
105
- account_number_id: string;
106
- }
107
- /**
108
- * Properties of a funding instructions document.
109
- */
110
- interface FundingInstructions {
111
- /**
112
- * The identifier of the Account Number the document was generated for.
113
- */
114
- account_number_id: string;
115
- }
116
- }
117
- export interface DocumentCreateParams {
118
- /**
119
- * The type of document to create.
120
- *
121
- * - `account_verification_letter` - An account verification letter.
122
- * - `funding_instructions` - Funding instructions.
123
- */
124
- category: 'account_verification_letter' | 'funding_instructions';
125
- /**
126
- * An account verification letter. Required if and only if `category` is
127
- * `account_verification_letter`.
128
- */
129
- account_verification_letter?: DocumentCreateParams.AccountVerificationLetter;
130
- /**
131
- * Funding instructions. Required if and only if `category` is
132
- * `funding_instructions`.
133
- */
134
- funding_instructions?: DocumentCreateParams.FundingInstructions;
135
- [k: string]: unknown;
136
- }
137
- export declare namespace DocumentCreateParams {
138
- /**
139
- * An account verification letter. Required if and only if `category` is
140
- * `account_verification_letter`.
141
- */
142
- interface AccountVerificationLetter {
143
- /**
144
- * The Account Number the bank letter should be generated for.
145
- */
146
- account_number_id: string;
147
- /**
148
- * If provided, the letter will include the Account's balance as of the date.
149
- */
150
- balance_date?: string;
151
- }
152
- /**
153
- * Funding instructions. Required if and only if `category` is
154
- * `funding_instructions`.
155
- */
156
- interface FundingInstructions {
157
- /**
158
- * The Account Number the funding instructions should be generated for.
159
- */
160
- account_number_id: string;
161
- }
162
- }
163
- export interface DocumentListParams extends PageParams {
164
- category?: DocumentListParams.Category;
165
- created_at?: DocumentListParams.CreatedAt;
166
- /**
167
- * Filter Documents to ones belonging to the specified Entity.
168
- */
169
- entity_id?: string;
170
- /**
171
- * Filter records to the one with the specified `idempotency_key` you chose for
172
- * that object. This value is unique across Increase and is used to ensure that a
173
- * request is only processed once. Learn more about
174
- * [idempotency](https://increase.com/documentation/idempotency-keys).
175
- */
176
- idempotency_key?: string;
177
- }
178
- export declare namespace DocumentListParams {
179
- interface Category {
180
- /**
181
- * Filter Documents for those with the specified category or categories. For GET
182
- * requests, this should be encoded as a comma-delimited string, such as
183
- * `?in=one,two,three`.
184
- */
185
- in?: Array<'form_1099_int' | 'form_1099_misc' | 'proof_of_authorization' | 'company_information' | 'account_verification_letter' | 'funding_instructions'>;
186
- }
187
- interface CreatedAt {
188
- /**
189
- * Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
190
- * timestamp.
191
- */
192
- after?: string;
193
- /**
194
- * Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
195
- * timestamp.
196
- */
197
- before?: string;
198
- /**
199
- * Return results on or after this
200
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
201
- */
202
- on_or_after?: string;
203
- /**
204
- * Return results on or before this
205
- * [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
206
- */
207
- on_or_before?: string;
208
- }
209
- }
210
- export declare namespace Documents {
211
- export { type Document as Document, type DocumentsPage as DocumentsPage, type DocumentCreateParams as DocumentCreateParams, type DocumentListParams as DocumentListParams, };
212
- }
213
- //# sourceMappingURL=documents.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"documents.d.ts","sourceRoot":"","sources":["../src/resources/documents.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,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAIlF;;;;;;;;;OASG;IACH,QAAQ,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,QAAQ,CAAC;IAI5E;;;;;;;;;;OAUG;IACH,IAAI,CACF,KAAK,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,aAAa,EAAE,QAAQ,CAAC;CAGxC;AAED,MAAM,MAAM,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC;AAE3C;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,2BAA2B,EAAE,QAAQ,CAAC,yBAAyB,GAAG,IAAI,CAAC;IAEvE;;;;;;;;;;;OAWG;IACH,QAAQ,EACJ,eAAe,GACf,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,6BAA6B,GAC7B,sBAAsB,CAAC;IAE3B;;;OAGG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,oBAAoB,EAAE,QAAQ,CAAC,mBAAmB,GAAG,IAAI,CAAC;IAE1D;;;;OAIG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;;OAGG;IACH,IAAI,EAAE,UAAU,CAAC;CAClB;AAED,yBAAiB,QAAQ,CAAC;IACxB;;OAEG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;IAED;;OAEG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;;OAKG;IACH,QAAQ,EAAE,6BAA6B,GAAG,sBAAsB,CAAC;IAEjE;;;OAGG;IACH,2BAA2B,CAAC,EAAE,oBAAoB,CAAC,yBAAyB,CAAC;IAE7E;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC,mBAAmB,CAAC;IAEhE,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CACtB;AAED,yBAAiB,oBAAoB,CAAC;IACpC;;;OAGG;IACH,UAAiB,yBAAyB;QACxC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB;IAED;;;OAGG;IACH,UAAiB,mBAAmB;QAClC;;WAEG;QACH,iBAAiB,EAAE,MAAM,CAAC;KAC3B;CACF;AAED,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC,UAAU,CAAC,EAAE,kBAAkB,CAAC,SAAS,CAAC;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,yBAAiB,kBAAkB,CAAC;IAClC,UAAiB,QAAQ;QACvB;;;;WAIG;QACH,EAAE,CAAC,EAAE,KAAK,CACN,eAAe,GACf,gBAAgB,GAChB,wBAAwB,GACxB,qBAAqB,GACrB,6BAA6B,GAC7B,sBAAsB,CACzB,CAAC;KACH;IAED,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,QAAQ,IAAI,QAAQ,EACzB,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,kBAAkB,IAAI,kBAAkB,GAC9C,CAAC;CACH"}
@@ -1,51 +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.Documents = 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 Documents extends resource_1.APIResource {
9
- /**
10
- * Create a Document
11
- *
12
- * @example
13
- * ```ts
14
- * const document = await client.documents.create({
15
- * category: 'account_verification_letter',
16
- * });
17
- * ```
18
- */
19
- create(body, options) {
20
- return this._client.post('/documents', { body, ...options });
21
- }
22
- /**
23
- * Retrieve a Document
24
- *
25
- * @example
26
- * ```ts
27
- * const document = await client.documents.retrieve(
28
- * 'document_qjtqc6s4c14ve2q89izm',
29
- * );
30
- * ```
31
- */
32
- retrieve(documentID, options) {
33
- return this._client.get((0, path_1.path) `/documents/${documentID}`, options);
34
- }
35
- /**
36
- * List Documents
37
- *
38
- * @example
39
- * ```ts
40
- * // Automatically fetches more pages as needed.
41
- * for await (const document of client.documents.list()) {
42
- * // ...
43
- * }
44
- * ```
45
- */
46
- list(query = {}, options) {
47
- return this._client.getAPIList('/documents', (pagination_1.Page), { query, ...options });
48
- }
49
- }
50
- exports.Documents = Documents;
51
- //# sourceMappingURL=documents.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"documents.js","sourceRoot":"","sources":["../src/resources/documents.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,sDAAwE;AAExE,oDAA8C;AAE9C,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAA0B,EAAE,OAAwB;QACzD,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,UAAkB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,cAAc,UAAU,EAAE,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,EAAE,CAAA,iBAAc,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACtF,CAAC;CACF;AA9CD,8BA8CC"}