increase 0.388.0 → 0.389.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.
- package/CHANGELOG.md +8 -0
- package/client.d.mts +0 -3
- package/client.d.mts.map +1 -1
- package/client.d.ts +0 -3
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/index.d.mts +0 -1
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +0 -1
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +2 -4
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +0 -1
- package/resources/index.mjs.map +1 -1
- package/resources/simulations/index.d.mts +0 -1
- package/resources/simulations/index.d.mts.map +1 -1
- package/resources/simulations/index.d.ts +0 -1
- package/resources/simulations/index.d.ts.map +1 -1
- package/resources/simulations/index.js +1 -3
- package/resources/simulations/index.js.map +1 -1
- package/resources/simulations/index.mjs +0 -1
- package/resources/simulations/index.mjs.map +1 -1
- package/resources/simulations/simulations.d.mts +0 -4
- package/resources/simulations/simulations.d.mts.map +1 -1
- package/resources/simulations/simulations.d.ts +0 -4
- package/resources/simulations/simulations.d.ts.map +1 -1
- package/resources/simulations/simulations.js +0 -4
- package/resources/simulations/simulations.js.map +1 -1
- package/resources/simulations/simulations.mjs +0 -4
- package/resources/simulations/simulations.mjs.map +1 -1
- package/src/client.ts +0 -17
- package/src/resources/index.ts +0 -7
- package/src/resources/simulations/index.ts +0 -1
- package/src/resources/simulations/simulations.ts +0 -6
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
- package/resources/documents.d.mts +0 -213
- package/resources/documents.d.mts.map +0 -1
- package/resources/documents.d.ts +0 -213
- package/resources/documents.d.ts.map +0 -1
- package/resources/documents.js +0 -51
- package/resources/documents.js.map +0 -1
- package/resources/documents.mjs +0 -47
- package/resources/documents.mjs.map +0 -1
- package/resources/simulations/documents.d.mts +0 -27
- package/resources/simulations/documents.d.mts.map +0 -1
- package/resources/simulations/documents.d.ts +0 -27
- package/resources/simulations/documents.d.ts.map +0 -1
- package/resources/simulations/documents.js +0 -22
- package/resources/simulations/documents.js.map +0 -1
- package/resources/simulations/documents.mjs +0 -18
- package/resources/simulations/documents.mjs.map +0 -1
- package/src/resources/documents.ts +0 -274
- package/src/resources/simulations/documents.ts +0 -33
|
@@ -1,274 +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 Documents extends APIResource {
|
|
10
|
-
/**
|
|
11
|
-
* Create a Document
|
|
12
|
-
*
|
|
13
|
-
* @example
|
|
14
|
-
* ```ts
|
|
15
|
-
* const document = await client.documents.create({
|
|
16
|
-
* category: 'account_verification_letter',
|
|
17
|
-
* });
|
|
18
|
-
* ```
|
|
19
|
-
*/
|
|
20
|
-
create(body: DocumentCreateParams, options?: RequestOptions): APIPromise<Document> {
|
|
21
|
-
return this._client.post('/documents', { body, ...options });
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
/**
|
|
25
|
-
* Retrieve a Document
|
|
26
|
-
*
|
|
27
|
-
* @example
|
|
28
|
-
* ```ts
|
|
29
|
-
* const document = await client.documents.retrieve(
|
|
30
|
-
* 'document_qjtqc6s4c14ve2q89izm',
|
|
31
|
-
* );
|
|
32
|
-
* ```
|
|
33
|
-
*/
|
|
34
|
-
retrieve(documentID: string, options?: RequestOptions): APIPromise<Document> {
|
|
35
|
-
return this._client.get(path`/documents/${documentID}`, options);
|
|
36
|
-
}
|
|
37
|
-
|
|
38
|
-
/**
|
|
39
|
-
* List Documents
|
|
40
|
-
*
|
|
41
|
-
* @example
|
|
42
|
-
* ```ts
|
|
43
|
-
* // Automatically fetches more pages as needed.
|
|
44
|
-
* for await (const document of client.documents.list()) {
|
|
45
|
-
* // ...
|
|
46
|
-
* }
|
|
47
|
-
* ```
|
|
48
|
-
*/
|
|
49
|
-
list(
|
|
50
|
-
query: DocumentListParams | null | undefined = {},
|
|
51
|
-
options?: RequestOptions,
|
|
52
|
-
): PagePromise<DocumentsPage, Document> {
|
|
53
|
-
return this._client.getAPIList('/documents', Page<Document>, { query, ...options });
|
|
54
|
-
}
|
|
55
|
-
}
|
|
56
|
-
|
|
57
|
-
export type DocumentsPage = Page<Document>;
|
|
58
|
-
|
|
59
|
-
/**
|
|
60
|
-
* Increase generates certain documents / forms automatically for your application;
|
|
61
|
-
* they can be listed here.
|
|
62
|
-
*/
|
|
63
|
-
export interface Document {
|
|
64
|
-
/**
|
|
65
|
-
* The Document identifier.
|
|
66
|
-
*/
|
|
67
|
-
id: string;
|
|
68
|
-
|
|
69
|
-
/**
|
|
70
|
-
* Properties of an account verification letter document.
|
|
71
|
-
*/
|
|
72
|
-
account_verification_letter: Document.AccountVerificationLetter | null;
|
|
73
|
-
|
|
74
|
-
/**
|
|
75
|
-
* The type of document.
|
|
76
|
-
*
|
|
77
|
-
* - `form_1099_int` - Internal Revenue Service Form 1099-INT.
|
|
78
|
-
* - `form_1099_misc` - Internal Revenue Service Form 1099-MISC.
|
|
79
|
-
* - `proof_of_authorization` - A document submitted in response to a proof of
|
|
80
|
-
* authorization request for an ACH transfer.
|
|
81
|
-
* - `company_information` - Company information, such a policies or procedures,
|
|
82
|
-
* typically submitted during our due diligence process.
|
|
83
|
-
* - `account_verification_letter` - An account verification letter.
|
|
84
|
-
* - `funding_instructions` - Funding instructions.
|
|
85
|
-
*/
|
|
86
|
-
category:
|
|
87
|
-
| 'form_1099_int'
|
|
88
|
-
| 'form_1099_misc'
|
|
89
|
-
| 'proof_of_authorization'
|
|
90
|
-
| 'company_information'
|
|
91
|
-
| 'account_verification_letter'
|
|
92
|
-
| 'funding_instructions';
|
|
93
|
-
|
|
94
|
-
/**
|
|
95
|
-
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
|
|
96
|
-
* Document was created.
|
|
97
|
-
*/
|
|
98
|
-
created_at: string;
|
|
99
|
-
|
|
100
|
-
/**
|
|
101
|
-
* The identifier of the Entity the document was generated for.
|
|
102
|
-
*/
|
|
103
|
-
entity_id: string | null;
|
|
104
|
-
|
|
105
|
-
/**
|
|
106
|
-
* The identifier of the File containing the Document's contents.
|
|
107
|
-
*/
|
|
108
|
-
file_id: string;
|
|
109
|
-
|
|
110
|
-
/**
|
|
111
|
-
* Properties of a funding instructions document.
|
|
112
|
-
*/
|
|
113
|
-
funding_instructions: Document.FundingInstructions | null;
|
|
114
|
-
|
|
115
|
-
/**
|
|
116
|
-
* The idempotency key you chose for this object. This value is unique across
|
|
117
|
-
* Increase and is used to ensure that a request is only processed once. Learn more
|
|
118
|
-
* about [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
119
|
-
*/
|
|
120
|
-
idempotency_key: string | null;
|
|
121
|
-
|
|
122
|
-
/**
|
|
123
|
-
* A constant representing the object's type. For this resource it will always be
|
|
124
|
-
* `document`.
|
|
125
|
-
*/
|
|
126
|
-
type: 'document';
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
export namespace Document {
|
|
130
|
-
/**
|
|
131
|
-
* Properties of an account verification letter document.
|
|
132
|
-
*/
|
|
133
|
-
export interface AccountVerificationLetter {
|
|
134
|
-
/**
|
|
135
|
-
* The identifier of the Account Number the document was generated for.
|
|
136
|
-
*/
|
|
137
|
-
account_number_id: string;
|
|
138
|
-
}
|
|
139
|
-
|
|
140
|
-
/**
|
|
141
|
-
* Properties of a funding instructions document.
|
|
142
|
-
*/
|
|
143
|
-
export interface FundingInstructions {
|
|
144
|
-
/**
|
|
145
|
-
* The identifier of the Account Number the document was generated for.
|
|
146
|
-
*/
|
|
147
|
-
account_number_id: string;
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
export interface DocumentCreateParams {
|
|
152
|
-
/**
|
|
153
|
-
* The type of document to create.
|
|
154
|
-
*
|
|
155
|
-
* - `account_verification_letter` - An account verification letter.
|
|
156
|
-
* - `funding_instructions` - Funding instructions.
|
|
157
|
-
*/
|
|
158
|
-
category: 'account_verification_letter' | 'funding_instructions';
|
|
159
|
-
|
|
160
|
-
/**
|
|
161
|
-
* An account verification letter. Required if and only if `category` is
|
|
162
|
-
* `account_verification_letter`.
|
|
163
|
-
*/
|
|
164
|
-
account_verification_letter?: DocumentCreateParams.AccountVerificationLetter;
|
|
165
|
-
|
|
166
|
-
/**
|
|
167
|
-
* Funding instructions. Required if and only if `category` is
|
|
168
|
-
* `funding_instructions`.
|
|
169
|
-
*/
|
|
170
|
-
funding_instructions?: DocumentCreateParams.FundingInstructions;
|
|
171
|
-
|
|
172
|
-
[k: string]: unknown;
|
|
173
|
-
}
|
|
174
|
-
|
|
175
|
-
export namespace DocumentCreateParams {
|
|
176
|
-
/**
|
|
177
|
-
* An account verification letter. Required if and only if `category` is
|
|
178
|
-
* `account_verification_letter`.
|
|
179
|
-
*/
|
|
180
|
-
export interface AccountVerificationLetter {
|
|
181
|
-
/**
|
|
182
|
-
* The Account Number the bank letter should be generated for.
|
|
183
|
-
*/
|
|
184
|
-
account_number_id: string;
|
|
185
|
-
|
|
186
|
-
/**
|
|
187
|
-
* If provided, the letter will include the Account's balance as of the date.
|
|
188
|
-
*/
|
|
189
|
-
balance_date?: string;
|
|
190
|
-
}
|
|
191
|
-
|
|
192
|
-
/**
|
|
193
|
-
* Funding instructions. Required if and only if `category` is
|
|
194
|
-
* `funding_instructions`.
|
|
195
|
-
*/
|
|
196
|
-
export interface FundingInstructions {
|
|
197
|
-
/**
|
|
198
|
-
* The Account Number the funding instructions should be generated for.
|
|
199
|
-
*/
|
|
200
|
-
account_number_id: string;
|
|
201
|
-
}
|
|
202
|
-
}
|
|
203
|
-
|
|
204
|
-
export interface DocumentListParams extends PageParams {
|
|
205
|
-
category?: DocumentListParams.Category;
|
|
206
|
-
|
|
207
|
-
created_at?: DocumentListParams.CreatedAt;
|
|
208
|
-
|
|
209
|
-
/**
|
|
210
|
-
* Filter Documents to ones belonging to the specified Entity.
|
|
211
|
-
*/
|
|
212
|
-
entity_id?: string;
|
|
213
|
-
|
|
214
|
-
/**
|
|
215
|
-
* Filter records to the one with the specified `idempotency_key` you chose for
|
|
216
|
-
* that object. This value is unique across Increase and is used to ensure that a
|
|
217
|
-
* request is only processed once. Learn more about
|
|
218
|
-
* [idempotency](https://increase.com/documentation/idempotency-keys).
|
|
219
|
-
*/
|
|
220
|
-
idempotency_key?: string;
|
|
221
|
-
}
|
|
222
|
-
|
|
223
|
-
export namespace DocumentListParams {
|
|
224
|
-
export interface Category {
|
|
225
|
-
/**
|
|
226
|
-
* Filter Documents for those with the specified category or categories. For GET
|
|
227
|
-
* requests, this should be encoded as a comma-delimited string, such as
|
|
228
|
-
* `?in=one,two,three`.
|
|
229
|
-
*/
|
|
230
|
-
in?: Array<
|
|
231
|
-
| 'form_1099_int'
|
|
232
|
-
| 'form_1099_misc'
|
|
233
|
-
| 'proof_of_authorization'
|
|
234
|
-
| 'company_information'
|
|
235
|
-
| 'account_verification_letter'
|
|
236
|
-
| 'funding_instructions'
|
|
237
|
-
>;
|
|
238
|
-
}
|
|
239
|
-
|
|
240
|
-
export interface CreatedAt {
|
|
241
|
-
/**
|
|
242
|
-
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
243
|
-
* timestamp.
|
|
244
|
-
*/
|
|
245
|
-
after?: string;
|
|
246
|
-
|
|
247
|
-
/**
|
|
248
|
-
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
249
|
-
* timestamp.
|
|
250
|
-
*/
|
|
251
|
-
before?: string;
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* Return results on or after this
|
|
255
|
-
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
256
|
-
*/
|
|
257
|
-
on_or_after?: string;
|
|
258
|
-
|
|
259
|
-
/**
|
|
260
|
-
* Return results on or before this
|
|
261
|
-
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
262
|
-
*/
|
|
263
|
-
on_or_before?: string;
|
|
264
|
-
}
|
|
265
|
-
}
|
|
266
|
-
|
|
267
|
-
export declare namespace Documents {
|
|
268
|
-
export {
|
|
269
|
-
type Document as Document,
|
|
270
|
-
type DocumentsPage as DocumentsPage,
|
|
271
|
-
type DocumentCreateParams as DocumentCreateParams,
|
|
272
|
-
type DocumentListParams as DocumentListParams,
|
|
273
|
-
};
|
|
274
|
-
}
|
|
@@ -1,33 +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 * as DocumentsAPI from '../documents';
|
|
5
|
-
import { APIPromise } from '../../core/api-promise';
|
|
6
|
-
import { RequestOptions } from '../../internal/request-options';
|
|
7
|
-
|
|
8
|
-
export class Documents extends APIResource {
|
|
9
|
-
/**
|
|
10
|
-
* Simulates an tax document being created for an account.
|
|
11
|
-
*
|
|
12
|
-
* @example
|
|
13
|
-
* ```ts
|
|
14
|
-
* const document = await client.simulations.documents.create({
|
|
15
|
-
* account_id: 'account_in71c4amph0vgo2qllky',
|
|
16
|
-
* });
|
|
17
|
-
* ```
|
|
18
|
-
*/
|
|
19
|
-
create(body: DocumentCreateParams, options?: RequestOptions): APIPromise<DocumentsAPI.Document> {
|
|
20
|
-
return this._client.post('/simulations/documents', { body, ...options });
|
|
21
|
-
}
|
|
22
|
-
}
|
|
23
|
-
|
|
24
|
-
export interface DocumentCreateParams {
|
|
25
|
-
/**
|
|
26
|
-
* The identifier of the Account the tax document is for.
|
|
27
|
-
*/
|
|
28
|
-
account_id: string;
|
|
29
|
-
}
|
|
30
|
-
|
|
31
|
-
export declare namespace Documents {
|
|
32
|
-
export { type DocumentCreateParams as DocumentCreateParams };
|
|
33
|
-
}
|