increase 0.11.3 → 0.11.4
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 +9 -0
- package/index.d.mts +12 -0
- package/index.d.ts +12 -0
- package/index.d.ts.map +1 -1
- package/index.js +6 -0
- package/index.js.map +1 -1
- package/index.mjs +6 -0
- package/index.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/card-payments.d.ts +1797 -0
- package/resources/card-payments.d.ts.map +1 -0
- package/resources/card-payments.js +28 -0
- package/resources/card-payments.js.map +1 -0
- package/resources/card-payments.mjs +23 -0
- package/resources/card-payments.mjs.map +1 -0
- package/resources/cards.d.ts +7 -1
- package/resources/cards.d.ts.map +1 -1
- package/resources/cards.js.map +1 -1
- package/resources/cards.mjs.map +1 -1
- package/resources/event-subscriptions.d.ts +22 -2
- package/resources/event-subscriptions.d.ts.map +1 -1
- package/resources/event-subscriptions.js.map +1 -1
- package/resources/event-subscriptions.mjs.map +1 -1
- package/resources/events.d.ts +12 -2
- package/resources/events.d.ts.map +1 -1
- package/resources/events.js.map +1 -1
- package/resources/events.mjs.map +1 -1
- package/resources/files.d.ts +4 -0
- package/resources/files.d.ts.map +1 -1
- package/resources/files.js.map +1 -1
- package/resources/files.mjs.map +1 -1
- package/resources/index.d.ts +2 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +8 -2
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +2 -0
- package/resources/index.mjs.map +1 -1
- package/resources/physical-cards.d.ts +318 -0
- package/resources/physical-cards.d.ts.map +1 -0
- package/resources/physical-cards.js +40 -0
- package/resources/physical-cards.js.map +1 -0
- package/resources/physical-cards.mjs +35 -0
- package/resources/physical-cards.mjs.map +1 -0
- package/resources/simulations/ach-transfers.d.ts +5 -5
- package/resources/simulations/ach-transfers.d.ts.map +1 -1
- package/resources/simulations/index.d.ts +1 -0
- package/resources/simulations/index.d.ts.map +1 -1
- package/resources/simulations/index.js +3 -1
- package/resources/simulations/index.js.map +1 -1
- package/resources/simulations/index.mjs +1 -0
- package/resources/simulations/index.mjs.map +1 -1
- package/resources/simulations/interest-payments.d.ts +5 -5
- package/resources/simulations/interest-payments.d.ts.map +1 -1
- package/resources/simulations/physical-cards.d.ts +34 -0
- package/resources/simulations/physical-cards.d.ts.map +1 -0
- package/resources/simulations/physical-cards.js +19 -0
- package/resources/simulations/physical-cards.js.map +1 -0
- package/resources/simulations/physical-cards.mjs +15 -0
- package/resources/simulations/physical-cards.mjs.map +1 -0
- package/resources/simulations/real-time-payments-transfers.d.ts +5 -5
- package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
- package/resources/simulations/simulations.d.ts +4 -0
- package/resources/simulations/simulations.d.ts.map +1 -1
- package/resources/simulations/simulations.js +3 -0
- package/resources/simulations/simulations.js.map +1 -1
- package/resources/simulations/simulations.mjs +3 -0
- package/resources/simulations/simulations.mjs.map +1 -1
- package/resources/simulations/wire-transfers.d.ts +5 -5
- package/resources/simulations/wire-transfers.d.ts.map +1 -1
- package/resources/transactions.d.ts +6 -6
- package/resources/transactions.d.ts.map +1 -1
- package/src/index.ts +14 -0
- package/src/resources/card-payments.ts +2284 -0
- package/src/resources/cards.ts +8 -1
- package/src/resources/event-subscriptions.ts +36 -0
- package/src/resources/events.ts +26 -0
- package/src/resources/files.ts +5 -0
- package/src/resources/index.ts +9 -0
- package/src/resources/physical-cards.ts +394 -0
- package/src/resources/simulations/ach-transfers.ts +6 -6
- package/src/resources/simulations/index.ts +1 -0
- package/src/resources/simulations/interest-payments.ts +6 -6
- package/src/resources/simulations/physical-cards.ts +51 -0
- package/src/resources/simulations/real-time-payments-transfers.ts +6 -6
- package/src/resources/simulations/simulations.ts +5 -0
- package/src/resources/simulations/wire-transfers.ts +6 -6
- package/src/resources/transactions.ts +8 -8
- package/src/version.ts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/resources/cards.ts
CHANGED
|
@@ -252,7 +252,8 @@ export interface CardCreateParams {
|
|
|
252
252
|
digital_wallet?: CardCreateParams.DigitalWallet;
|
|
253
253
|
|
|
254
254
|
/**
|
|
255
|
-
* The Entity the card
|
|
255
|
+
* The Entity the card belongs to. You only need to supply this in rare situations
|
|
256
|
+
* when the card is not for the Account holder.
|
|
256
257
|
*/
|
|
257
258
|
entity_id?: string;
|
|
258
259
|
}
|
|
@@ -334,6 +335,12 @@ export interface CardUpdateParams {
|
|
|
334
335
|
*/
|
|
335
336
|
digital_wallet?: CardUpdateParams.DigitalWallet;
|
|
336
337
|
|
|
338
|
+
/**
|
|
339
|
+
* The Entity the card belongs to. You only need to supply this in rare situations
|
|
340
|
+
* when the card is not for the Account holder.
|
|
341
|
+
*/
|
|
342
|
+
entity_id?: string;
|
|
343
|
+
|
|
337
344
|
/**
|
|
338
345
|
* The status to update the Card with.
|
|
339
346
|
*
|
|
@@ -115,6 +115,8 @@ export interface EventSubscription {
|
|
|
115
115
|
* - `document.created` - Occurs whenever a Document is created.
|
|
116
116
|
* - `entity.created` - Occurs whenever an Entity is created.
|
|
117
117
|
* - `entity.updated` - Occurs whenever an Entity is updated.
|
|
118
|
+
* - `export.created` - Occurs whenever an Export is created.
|
|
119
|
+
* - `export.updated` - Occurs whenever an Export is updated.
|
|
118
120
|
* - `external_account.created` - Occurs whenever an External Account is created.
|
|
119
121
|
* - `file.created` - Occurs whenever a File is created.
|
|
120
122
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
@@ -130,6 +132,12 @@ export interface EventSubscription {
|
|
|
130
132
|
* Transfer Return is updated.
|
|
131
133
|
* - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
|
|
132
134
|
* Drawdown Request is created.
|
|
135
|
+
* - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
|
|
136
|
+
* Enrollment is created.
|
|
137
|
+
* - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account
|
|
138
|
+
* Enrollment is updated.
|
|
139
|
+
* - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
|
|
140
|
+
* - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
|
|
133
141
|
* - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
|
|
134
142
|
* - `oauth_connection.deactivated` - Occurs whenever an OAuth Connection is
|
|
135
143
|
* deactivated.
|
|
@@ -137,6 +145,8 @@ export interface EventSubscription {
|
|
|
137
145
|
* created.
|
|
138
146
|
* - `pending_transaction.updated` - Occurs whenever a Pending Transaction is
|
|
139
147
|
* updated.
|
|
148
|
+
* - `physical_card.created` - Occurs whenever a Physical Card is created.
|
|
149
|
+
* - `physical_card.updated` - Occurs whenever a Physical Card is updated.
|
|
140
150
|
* - `real_time_decision.card_authorization_requested` - Occurs whenever a
|
|
141
151
|
* Real-Time Decision is created in response to a card authorization.
|
|
142
152
|
* - `real_time_decision.digital_wallet_token_requested` - Occurs whenever a
|
|
@@ -191,6 +201,8 @@ export interface EventSubscription {
|
|
|
191
201
|
| 'document.created'
|
|
192
202
|
| 'entity.created'
|
|
193
203
|
| 'entity.updated'
|
|
204
|
+
| 'export.created'
|
|
205
|
+
| 'export.updated'
|
|
194
206
|
| 'external_account.created'
|
|
195
207
|
| 'file.created'
|
|
196
208
|
| 'group.updated'
|
|
@@ -200,10 +212,16 @@ export interface EventSubscription {
|
|
|
200
212
|
| 'inbound_ach_transfer_return.created'
|
|
201
213
|
| 'inbound_ach_transfer_return.updated'
|
|
202
214
|
| 'inbound_wire_drawdown_request.created'
|
|
215
|
+
| 'intrafi_account_enrollment.created'
|
|
216
|
+
| 'intrafi_account_enrollment.updated'
|
|
217
|
+
| 'intrafi_exclusion.created'
|
|
218
|
+
| 'intrafi_exclusion.updated'
|
|
203
219
|
| 'oauth_connection.created'
|
|
204
220
|
| 'oauth_connection.deactivated'
|
|
205
221
|
| 'pending_transaction.created'
|
|
206
222
|
| 'pending_transaction.updated'
|
|
223
|
+
| 'physical_card.created'
|
|
224
|
+
| 'physical_card.updated'
|
|
207
225
|
| 'real_time_decision.card_authorization_requested'
|
|
208
226
|
| 'real_time_decision.digital_wallet_token_requested'
|
|
209
227
|
| 'real_time_decision.digital_wallet_authentication_requested'
|
|
@@ -287,6 +305,8 @@ export interface EventSubscriptionCreateParams {
|
|
|
287
305
|
* - `document.created` - Occurs whenever a Document is created.
|
|
288
306
|
* - `entity.created` - Occurs whenever an Entity is created.
|
|
289
307
|
* - `entity.updated` - Occurs whenever an Entity is updated.
|
|
308
|
+
* - `export.created` - Occurs whenever an Export is created.
|
|
309
|
+
* - `export.updated` - Occurs whenever an Export is updated.
|
|
290
310
|
* - `external_account.created` - Occurs whenever an External Account is created.
|
|
291
311
|
* - `file.created` - Occurs whenever a File is created.
|
|
292
312
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
@@ -302,6 +322,12 @@ export interface EventSubscriptionCreateParams {
|
|
|
302
322
|
* Transfer Return is updated.
|
|
303
323
|
* - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
|
|
304
324
|
* Drawdown Request is created.
|
|
325
|
+
* - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
|
|
326
|
+
* Enrollment is created.
|
|
327
|
+
* - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account
|
|
328
|
+
* Enrollment is updated.
|
|
329
|
+
* - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
|
|
330
|
+
* - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
|
|
305
331
|
* - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
|
|
306
332
|
* - `oauth_connection.deactivated` - Occurs whenever an OAuth Connection is
|
|
307
333
|
* deactivated.
|
|
@@ -309,6 +335,8 @@ export interface EventSubscriptionCreateParams {
|
|
|
309
335
|
* created.
|
|
310
336
|
* - `pending_transaction.updated` - Occurs whenever a Pending Transaction is
|
|
311
337
|
* updated.
|
|
338
|
+
* - `physical_card.created` - Occurs whenever a Physical Card is created.
|
|
339
|
+
* - `physical_card.updated` - Occurs whenever a Physical Card is updated.
|
|
312
340
|
* - `real_time_decision.card_authorization_requested` - Occurs whenever a
|
|
313
341
|
* Real-Time Decision is created in response to a card authorization.
|
|
314
342
|
* - `real_time_decision.digital_wallet_token_requested` - Occurs whenever a
|
|
@@ -363,6 +391,8 @@ export interface EventSubscriptionCreateParams {
|
|
|
363
391
|
| 'document.created'
|
|
364
392
|
| 'entity.created'
|
|
365
393
|
| 'entity.updated'
|
|
394
|
+
| 'export.created'
|
|
395
|
+
| 'export.updated'
|
|
366
396
|
| 'external_account.created'
|
|
367
397
|
| 'file.created'
|
|
368
398
|
| 'group.updated'
|
|
@@ -372,10 +402,16 @@ export interface EventSubscriptionCreateParams {
|
|
|
372
402
|
| 'inbound_ach_transfer_return.created'
|
|
373
403
|
| 'inbound_ach_transfer_return.updated'
|
|
374
404
|
| 'inbound_wire_drawdown_request.created'
|
|
405
|
+
| 'intrafi_account_enrollment.created'
|
|
406
|
+
| 'intrafi_account_enrollment.updated'
|
|
407
|
+
| 'intrafi_exclusion.created'
|
|
408
|
+
| 'intrafi_exclusion.updated'
|
|
375
409
|
| 'oauth_connection.created'
|
|
376
410
|
| 'oauth_connection.deactivated'
|
|
377
411
|
| 'pending_transaction.created'
|
|
378
412
|
| 'pending_transaction.updated'
|
|
413
|
+
| 'physical_card.created'
|
|
414
|
+
| 'physical_card.updated'
|
|
379
415
|
| 'real_time_decision.card_authorization_requested'
|
|
380
416
|
| 'real_time_decision.digital_wallet_token_requested'
|
|
381
417
|
| 'real_time_decision.digital_wallet_authentication_requested'
|
package/src/resources/events.ts
CHANGED
|
@@ -94,6 +94,8 @@ export interface Event {
|
|
|
94
94
|
* - `document.created` - Occurs whenever a Document is created.
|
|
95
95
|
* - `entity.created` - Occurs whenever an Entity is created.
|
|
96
96
|
* - `entity.updated` - Occurs whenever an Entity is updated.
|
|
97
|
+
* - `export.created` - Occurs whenever an Export is created.
|
|
98
|
+
* - `export.updated` - Occurs whenever an Export is updated.
|
|
97
99
|
* - `external_account.created` - Occurs whenever an External Account is created.
|
|
98
100
|
* - `file.created` - Occurs whenever a File is created.
|
|
99
101
|
* - `group.updated` - Occurs whenever a Group is updated.
|
|
@@ -109,6 +111,12 @@ export interface Event {
|
|
|
109
111
|
* Transfer Return is updated.
|
|
110
112
|
* - `inbound_wire_drawdown_request.created` - Occurs whenever an Inbound Wire
|
|
111
113
|
* Drawdown Request is created.
|
|
114
|
+
* - `intrafi_account_enrollment.created` - Occurs whenever an IntraFi Account
|
|
115
|
+
* Enrollment is created.
|
|
116
|
+
* - `intrafi_account_enrollment.updated` - Occurs whenever an IntraFi Account
|
|
117
|
+
* Enrollment is updated.
|
|
118
|
+
* - `intrafi_exclusion.created` - Occurs whenever an IntraFi Exclusion is created.
|
|
119
|
+
* - `intrafi_exclusion.updated` - Occurs whenever an IntraFi Exclusion is updated.
|
|
112
120
|
* - `oauth_connection.created` - Occurs whenever an OAuth Connection is created.
|
|
113
121
|
* - `oauth_connection.deactivated` - Occurs whenever an OAuth Connection is
|
|
114
122
|
* deactivated.
|
|
@@ -116,6 +124,8 @@ export interface Event {
|
|
|
116
124
|
* created.
|
|
117
125
|
* - `pending_transaction.updated` - Occurs whenever a Pending Transaction is
|
|
118
126
|
* updated.
|
|
127
|
+
* - `physical_card.created` - Occurs whenever a Physical Card is created.
|
|
128
|
+
* - `physical_card.updated` - Occurs whenever a Physical Card is updated.
|
|
119
129
|
* - `real_time_decision.card_authorization_requested` - Occurs whenever a
|
|
120
130
|
* Real-Time Decision is created in response to a card authorization.
|
|
121
131
|
* - `real_time_decision.digital_wallet_token_requested` - Occurs whenever a
|
|
@@ -170,6 +180,8 @@ export interface Event {
|
|
|
170
180
|
| 'document.created'
|
|
171
181
|
| 'entity.created'
|
|
172
182
|
| 'entity.updated'
|
|
183
|
+
| 'export.created'
|
|
184
|
+
| 'export.updated'
|
|
173
185
|
| 'external_account.created'
|
|
174
186
|
| 'file.created'
|
|
175
187
|
| 'group.updated'
|
|
@@ -179,10 +191,16 @@ export interface Event {
|
|
|
179
191
|
| 'inbound_ach_transfer_return.created'
|
|
180
192
|
| 'inbound_ach_transfer_return.updated'
|
|
181
193
|
| 'inbound_wire_drawdown_request.created'
|
|
194
|
+
| 'intrafi_account_enrollment.created'
|
|
195
|
+
| 'intrafi_account_enrollment.updated'
|
|
196
|
+
| 'intrafi_exclusion.created'
|
|
197
|
+
| 'intrafi_exclusion.updated'
|
|
182
198
|
| 'oauth_connection.created'
|
|
183
199
|
| 'oauth_connection.deactivated'
|
|
184
200
|
| 'pending_transaction.created'
|
|
185
201
|
| 'pending_transaction.updated'
|
|
202
|
+
| 'physical_card.created'
|
|
203
|
+
| 'physical_card.updated'
|
|
186
204
|
| 'real_time_decision.card_authorization_requested'
|
|
187
205
|
| 'real_time_decision.digital_wallet_token_requested'
|
|
188
206
|
| 'real_time_decision.digital_wallet_authentication_requested'
|
|
@@ -256,6 +274,8 @@ export namespace EventListParams {
|
|
|
256
274
|
| 'document.created'
|
|
257
275
|
| 'entity.created'
|
|
258
276
|
| 'entity.updated'
|
|
277
|
+
| 'export.created'
|
|
278
|
+
| 'export.updated'
|
|
259
279
|
| 'external_account.created'
|
|
260
280
|
| 'file.created'
|
|
261
281
|
| 'group.updated'
|
|
@@ -265,10 +285,16 @@ export namespace EventListParams {
|
|
|
265
285
|
| 'inbound_ach_transfer_return.created'
|
|
266
286
|
| 'inbound_ach_transfer_return.updated'
|
|
267
287
|
| 'inbound_wire_drawdown_request.created'
|
|
288
|
+
| 'intrafi_account_enrollment.created'
|
|
289
|
+
| 'intrafi_account_enrollment.updated'
|
|
290
|
+
| 'intrafi_exclusion.created'
|
|
291
|
+
| 'intrafi_exclusion.updated'
|
|
268
292
|
| 'oauth_connection.created'
|
|
269
293
|
| 'oauth_connection.deactivated'
|
|
270
294
|
| 'pending_transaction.created'
|
|
271
295
|
| 'pending_transaction.updated'
|
|
296
|
+
| 'physical_card.created'
|
|
297
|
+
| 'physical_card.updated'
|
|
272
298
|
| 'real_time_decision.card_authorization_requested'
|
|
273
299
|
| 'real_time_decision.digital_wallet_token_requested'
|
|
274
300
|
| 'real_time_decision.digital_wallet_authentication_requested'
|
package/src/resources/files.ts
CHANGED
|
@@ -84,6 +84,11 @@ export interface File {
|
|
|
84
84
|
*/
|
|
85
85
|
filename: string | null;
|
|
86
86
|
|
|
87
|
+
/**
|
|
88
|
+
* The MIME type of the file.
|
|
89
|
+
*/
|
|
90
|
+
mime_type: string;
|
|
91
|
+
|
|
87
92
|
/**
|
|
88
93
|
* What the File will be used for. We may add additional possible values for this
|
|
89
94
|
* enum over time; your application should be able to handle such additions
|
package/src/resources/index.ts
CHANGED
|
@@ -78,6 +78,7 @@ export {
|
|
|
78
78
|
CardDisputesPage,
|
|
79
79
|
CardDisputes,
|
|
80
80
|
} from './card-disputes';
|
|
81
|
+
export { CardPayment, CardPaymentListParams, CardPaymentsPage, CardPayments } from './card-payments';
|
|
81
82
|
export {
|
|
82
83
|
CardProfile,
|
|
83
84
|
CardProfileCreateParams,
|
|
@@ -173,6 +174,14 @@ export {
|
|
|
173
174
|
PendingTransactionsPage,
|
|
174
175
|
PendingTransactions,
|
|
175
176
|
} from './pending-transactions';
|
|
177
|
+
export {
|
|
178
|
+
PhysicalCard,
|
|
179
|
+
PhysicalCardCreateParams,
|
|
180
|
+
PhysicalCardUpdateParams,
|
|
181
|
+
PhysicalCardListParams,
|
|
182
|
+
PhysicalCardsPage,
|
|
183
|
+
PhysicalCards,
|
|
184
|
+
} from './physical-cards';
|
|
176
185
|
export { Program, ProgramListParams, ProgramsPage, Programs } from './programs';
|
|
177
186
|
export { RealTimeDecision, RealTimeDecisionActionParams, RealTimeDecisions } from './real-time-decisions';
|
|
178
187
|
export {
|
|
@@ -0,0 +1,394 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless.
|
|
2
|
+
|
|
3
|
+
import * as Core from "../e/core";
|
|
4
|
+
import { APIResource } from "../e/resource";
|
|
5
|
+
import { isRequestOptions } from "../e/core";
|
|
6
|
+
import * as API from './index';
|
|
7
|
+
import { Page, PageParams } from "../e/pagination";
|
|
8
|
+
|
|
9
|
+
export class PhysicalCards extends APIResource {
|
|
10
|
+
/**
|
|
11
|
+
* Create a Physical Card
|
|
12
|
+
*/
|
|
13
|
+
create(body: PhysicalCardCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
|
|
14
|
+
return this.post('/physical_cards', { body, ...options });
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
/**
|
|
18
|
+
* Retrieve a Physical Card
|
|
19
|
+
*/
|
|
20
|
+
retrieve(physicalCardId: string, options?: Core.RequestOptions): Core.APIPromise<PhysicalCard> {
|
|
21
|
+
return this.get(`/physical_cards/${physicalCardId}`, options);
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Update a Physical Card
|
|
26
|
+
*/
|
|
27
|
+
update(
|
|
28
|
+
physicalCardId: string,
|
|
29
|
+
body: PhysicalCardUpdateParams,
|
|
30
|
+
options?: Core.RequestOptions,
|
|
31
|
+
): Core.APIPromise<PhysicalCard> {
|
|
32
|
+
return this.patch(`/physical_cards/${physicalCardId}`, { body, ...options });
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* List Physical Cards
|
|
37
|
+
*/
|
|
38
|
+
list(
|
|
39
|
+
query?: PhysicalCardListParams,
|
|
40
|
+
options?: Core.RequestOptions,
|
|
41
|
+
): Core.PagePromise<PhysicalCardsPage, PhysicalCard>;
|
|
42
|
+
list(options?: Core.RequestOptions): Core.PagePromise<PhysicalCardsPage, PhysicalCard>;
|
|
43
|
+
list(
|
|
44
|
+
query: PhysicalCardListParams | Core.RequestOptions = {},
|
|
45
|
+
options?: Core.RequestOptions,
|
|
46
|
+
): Core.PagePromise<PhysicalCardsPage, PhysicalCard> {
|
|
47
|
+
if (isRequestOptions(query)) {
|
|
48
|
+
return this.list({}, query);
|
|
49
|
+
}
|
|
50
|
+
return this.getAPIList('/physical_cards', PhysicalCardsPage, { query, ...options });
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export class PhysicalCardsPage extends Page<PhysicalCard> {}
|
|
55
|
+
// alias so we can export it in the namespace
|
|
56
|
+
type _PhysicalCardsPage = PhysicalCardsPage;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* Custom physical Visa cards that are shipped to your customers. The artwork is
|
|
60
|
+
* configurable by a connected [Card Profile](/documentation/api#card-profiles).
|
|
61
|
+
* The same Card can be used for multiple Physical Cards. Printing cards incurs a
|
|
62
|
+
* fee. Please contact [support@increase.com](mailto:support@increase.com) for
|
|
63
|
+
* pricing!
|
|
64
|
+
*/
|
|
65
|
+
export interface PhysicalCard {
|
|
66
|
+
/**
|
|
67
|
+
* The physical card identifier.
|
|
68
|
+
*/
|
|
69
|
+
id: string;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* The identifier for the Card this Physical Card represents.
|
|
73
|
+
*/
|
|
74
|
+
card_id: string;
|
|
75
|
+
|
|
76
|
+
/**
|
|
77
|
+
* The Card Profile used for this Physical Card.
|
|
78
|
+
*/
|
|
79
|
+
card_profile_id: string | null;
|
|
80
|
+
|
|
81
|
+
/**
|
|
82
|
+
* Details about the cardholder, as it appears on the printed card.
|
|
83
|
+
*/
|
|
84
|
+
cardholder: PhysicalCard.Cardholder | null;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
88
|
+
* the Physical Card was created.
|
|
89
|
+
*/
|
|
90
|
+
created_at: string;
|
|
91
|
+
|
|
92
|
+
/**
|
|
93
|
+
* The details used to ship this physical card.
|
|
94
|
+
*/
|
|
95
|
+
shipment: PhysicalCard.Shipment;
|
|
96
|
+
|
|
97
|
+
/**
|
|
98
|
+
* The status of the Physical Card.
|
|
99
|
+
*
|
|
100
|
+
* - `active` - The physical card is active.
|
|
101
|
+
* - `disabled` - The physical card is temporarily disabled.
|
|
102
|
+
* - `canceled` - The physical card is permanently canceled.
|
|
103
|
+
*/
|
|
104
|
+
status: 'active' | 'disabled' | 'canceled';
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* A constant representing the object's type. For this resource it will always be
|
|
108
|
+
* `physical_card`.
|
|
109
|
+
*/
|
|
110
|
+
type: 'physical_card';
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export namespace PhysicalCard {
|
|
114
|
+
/**
|
|
115
|
+
* Details about the cardholder, as it appears on the printed card.
|
|
116
|
+
*/
|
|
117
|
+
export interface Cardholder {
|
|
118
|
+
/**
|
|
119
|
+
* The cardholder's first name.
|
|
120
|
+
*/
|
|
121
|
+
first_name: string;
|
|
122
|
+
|
|
123
|
+
/**
|
|
124
|
+
* The cardholder's last name.
|
|
125
|
+
*/
|
|
126
|
+
last_name: string;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/**
|
|
130
|
+
* The details used to ship this physical card.
|
|
131
|
+
*/
|
|
132
|
+
export interface Shipment {
|
|
133
|
+
/**
|
|
134
|
+
* The location to where the card's packing label is addressed.
|
|
135
|
+
*/
|
|
136
|
+
address: Shipment.Address;
|
|
137
|
+
|
|
138
|
+
/**
|
|
139
|
+
* The shipping method.
|
|
140
|
+
*
|
|
141
|
+
* - `usps` - USPS Post with tracking.
|
|
142
|
+
* - `fedex_priority_overnight` - FedEx Priority Overnight, no signature.
|
|
143
|
+
* - `fedex_2_day` - FedEx 2-day.
|
|
144
|
+
*/
|
|
145
|
+
method: 'usps' | 'fedex_priority_overnight' | 'fedex_2_day';
|
|
146
|
+
|
|
147
|
+
/**
|
|
148
|
+
* The status of this shipment.
|
|
149
|
+
*
|
|
150
|
+
* - `pending` - The physical card has not yet been shipped.
|
|
151
|
+
* - `canceled` - The physical card shipment was canceled prior to submission.
|
|
152
|
+
* - `submitted` - The physical card shipment has been submitted to the card
|
|
153
|
+
* fulfillment provider.
|
|
154
|
+
* - `acknowledged` - The physical card shipment has been acknowledged by the card
|
|
155
|
+
* fulfillment provider and will be processed in their next batch.
|
|
156
|
+
* - `rejected` - The physical card shipment was rejected by the card printer due
|
|
157
|
+
* to an error.
|
|
158
|
+
* - `shipped` - The physical card has been shipped.
|
|
159
|
+
* - `returned` - The physical card shipment was returned to the sender and
|
|
160
|
+
* destroyed by the production facility.
|
|
161
|
+
*/
|
|
162
|
+
status: 'pending' | 'canceled' | 'submitted' | 'acknowledged' | 'rejected' | 'shipped' | 'returned';
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* Tracking details for the shipment.
|
|
166
|
+
*/
|
|
167
|
+
tracking: Shipment.Tracking | null;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
export namespace Shipment {
|
|
171
|
+
/**
|
|
172
|
+
* The location to where the card's packing label is addressed.
|
|
173
|
+
*/
|
|
174
|
+
export interface Address {
|
|
175
|
+
/**
|
|
176
|
+
* The city of the shipping address.
|
|
177
|
+
*/
|
|
178
|
+
city: string;
|
|
179
|
+
|
|
180
|
+
/**
|
|
181
|
+
* The first line of the shipping address.
|
|
182
|
+
*/
|
|
183
|
+
line1: string;
|
|
184
|
+
|
|
185
|
+
/**
|
|
186
|
+
* The second line of the shipping address.
|
|
187
|
+
*/
|
|
188
|
+
line2: string | null;
|
|
189
|
+
|
|
190
|
+
/**
|
|
191
|
+
* The third line of the shipping address.
|
|
192
|
+
*/
|
|
193
|
+
line3: string | null;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* The name of the recipient.
|
|
197
|
+
*/
|
|
198
|
+
name: string;
|
|
199
|
+
|
|
200
|
+
/**
|
|
201
|
+
* The postal code of the shipping address.
|
|
202
|
+
*/
|
|
203
|
+
postal_code: string;
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* The US state of the shipping address.
|
|
207
|
+
*/
|
|
208
|
+
state: string;
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Tracking details for the shipment.
|
|
213
|
+
*/
|
|
214
|
+
export interface Tracking {
|
|
215
|
+
/**
|
|
216
|
+
* The tracking number.
|
|
217
|
+
*/
|
|
218
|
+
number: string;
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* For returned shipments, this describes why the package was returned.
|
|
222
|
+
*/
|
|
223
|
+
return_reason: string | null;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
|
|
227
|
+
* the fulfillment provider marked the card as ready for pick-up by the shipment
|
|
228
|
+
* carrier.
|
|
229
|
+
*/
|
|
230
|
+
shipped_at: string;
|
|
231
|
+
}
|
|
232
|
+
}
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
export interface PhysicalCardCreateParams {
|
|
236
|
+
/**
|
|
237
|
+
* The underlying card representing this physical card.
|
|
238
|
+
*/
|
|
239
|
+
card_id: string;
|
|
240
|
+
|
|
241
|
+
/**
|
|
242
|
+
* The card profile to use for this physical card.
|
|
243
|
+
*/
|
|
244
|
+
card_profile_id: string;
|
|
245
|
+
|
|
246
|
+
/**
|
|
247
|
+
* Details about the cardholder, as it will appear on the physical card.
|
|
248
|
+
*/
|
|
249
|
+
cardholder: PhysicalCardCreateParams.Cardholder;
|
|
250
|
+
|
|
251
|
+
/**
|
|
252
|
+
* The details used to ship this physical card.
|
|
253
|
+
*/
|
|
254
|
+
shipment: PhysicalCardCreateParams.Shipment;
|
|
255
|
+
}
|
|
256
|
+
|
|
257
|
+
export namespace PhysicalCardCreateParams {
|
|
258
|
+
/**
|
|
259
|
+
* Details about the cardholder, as it will appear on the physical card.
|
|
260
|
+
*/
|
|
261
|
+
export interface Cardholder {
|
|
262
|
+
/**
|
|
263
|
+
* The cardholder's first name.
|
|
264
|
+
*/
|
|
265
|
+
first_name: string;
|
|
266
|
+
|
|
267
|
+
/**
|
|
268
|
+
* The cardholder's last name.
|
|
269
|
+
*/
|
|
270
|
+
last_name: string;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* The details used to ship this physical card.
|
|
275
|
+
*/
|
|
276
|
+
export interface Shipment {
|
|
277
|
+
/**
|
|
278
|
+
* The address to where the card should be shipped.
|
|
279
|
+
*/
|
|
280
|
+
address: Shipment.Address;
|
|
281
|
+
|
|
282
|
+
/**
|
|
283
|
+
* The shipping method to use.
|
|
284
|
+
*
|
|
285
|
+
* - `usps` - USPS Post with tracking.
|
|
286
|
+
* - `fedex_priority_overnight` - FedEx Priority Overnight, no signature.
|
|
287
|
+
* - `fedex_2_day` - FedEx 2-day.
|
|
288
|
+
*/
|
|
289
|
+
method: 'usps' | 'fedex_priority_overnight' | 'fedex_2_day';
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
export namespace Shipment {
|
|
293
|
+
/**
|
|
294
|
+
* The address to where the card should be shipped.
|
|
295
|
+
*/
|
|
296
|
+
export interface Address {
|
|
297
|
+
/**
|
|
298
|
+
* The city of the shipping address.
|
|
299
|
+
*/
|
|
300
|
+
city: string;
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* The first line of the shipping address.
|
|
304
|
+
*/
|
|
305
|
+
line1: string;
|
|
306
|
+
|
|
307
|
+
/**
|
|
308
|
+
* The name of the recipient.
|
|
309
|
+
*/
|
|
310
|
+
name: string;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* The postal code of the shipping address.
|
|
314
|
+
*/
|
|
315
|
+
postal_code: string;
|
|
316
|
+
|
|
317
|
+
/**
|
|
318
|
+
* The US state of the shipping address.
|
|
319
|
+
*/
|
|
320
|
+
state: string;
|
|
321
|
+
|
|
322
|
+
/**
|
|
323
|
+
* The second line of the shipping address.
|
|
324
|
+
*/
|
|
325
|
+
line2?: string;
|
|
326
|
+
|
|
327
|
+
/**
|
|
328
|
+
* The third line of the shipping address.
|
|
329
|
+
*/
|
|
330
|
+
line3?: string;
|
|
331
|
+
|
|
332
|
+
/**
|
|
333
|
+
* The phone number of the receipient.
|
|
334
|
+
*/
|
|
335
|
+
phone_number?: string;
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
|
|
340
|
+
export interface PhysicalCardUpdateParams {
|
|
341
|
+
/**
|
|
342
|
+
* The status to update the Physical Card to.
|
|
343
|
+
*
|
|
344
|
+
* - `active` - The physical card is active.
|
|
345
|
+
* - `disabled` - The physical card is temporarily disabled.
|
|
346
|
+
* - `canceled` - The physical card is permanently canceled.
|
|
347
|
+
*/
|
|
348
|
+
status: 'active' | 'disabled' | 'canceled';
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
export interface PhysicalCardListParams extends PageParams {
|
|
352
|
+
/**
|
|
353
|
+
* Filter Physical Cards to ones belonging to the specified Card.
|
|
354
|
+
*/
|
|
355
|
+
card_id?: string;
|
|
356
|
+
|
|
357
|
+
created_at?: PhysicalCardListParams.CreatedAt;
|
|
358
|
+
}
|
|
359
|
+
|
|
360
|
+
export namespace PhysicalCardListParams {
|
|
361
|
+
export interface CreatedAt {
|
|
362
|
+
/**
|
|
363
|
+
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
364
|
+
* timestamp.
|
|
365
|
+
*/
|
|
366
|
+
after?: string;
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
|
|
370
|
+
* timestamp.
|
|
371
|
+
*/
|
|
372
|
+
before?: string;
|
|
373
|
+
|
|
374
|
+
/**
|
|
375
|
+
* Return results on or after this
|
|
376
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
377
|
+
*/
|
|
378
|
+
on_or_after?: string;
|
|
379
|
+
|
|
380
|
+
/**
|
|
381
|
+
* Return results on or before this
|
|
382
|
+
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
|
|
383
|
+
*/
|
|
384
|
+
on_or_before?: string;
|
|
385
|
+
}
|
|
386
|
+
}
|
|
387
|
+
|
|
388
|
+
export namespace PhysicalCards {
|
|
389
|
+
export import PhysicalCard = API.PhysicalCard;
|
|
390
|
+
export type PhysicalCardsPage = _PhysicalCardsPage;
|
|
391
|
+
export import PhysicalCardCreateParams = API.PhysicalCardCreateParams;
|
|
392
|
+
export import PhysicalCardUpdateParams = API.PhysicalCardUpdateParams;
|
|
393
|
+
export import PhysicalCardListParams = API.PhysicalCardListParams;
|
|
394
|
+
}
|
|
@@ -1244,10 +1244,10 @@ export namespace ACHTransferSimulation {
|
|
|
1244
1244
|
* - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
|
|
1245
1245
|
* `card_dispute_acceptance` object.
|
|
1246
1246
|
* - `card_refund` - Card Refund: details will be under the `card_refund` object.
|
|
1247
|
-
* - `card_revenue_payment` - Card Revenue Payment: details will be under the
|
|
1248
|
-
* `card_revenue_payment` object.
|
|
1249
1247
|
* - `card_settlement` - Card Settlement: details will be under the
|
|
1250
1248
|
* `card_settlement` object.
|
|
1249
|
+
* - `card_revenue_payment` - Card Revenue Payment: details will be under the
|
|
1250
|
+
* `card_revenue_payment` object.
|
|
1251
1251
|
* - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
|
|
1252
1252
|
* the `check_deposit_acceptance` object.
|
|
1253
1253
|
* - `check_deposit_return` - Check Deposit Return: details will be under the
|
|
@@ -1271,11 +1271,11 @@ export namespace ACHTransferSimulation {
|
|
|
1271
1271
|
* - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
|
|
1272
1272
|
* Payments Transfer Confirmation: details will be under the
|
|
1273
1273
|
* `inbound_real_time_payments_transfer_confirmation` object.
|
|
1274
|
-
* - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
|
|
1275
|
-
* be under the `inbound_wire_drawdown_payment` object.
|
|
1276
1274
|
* - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
|
|
1277
1275
|
* Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
|
|
1278
1276
|
* object.
|
|
1277
|
+
* - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
|
|
1278
|
+
* be under the `inbound_wire_drawdown_payment` object.
|
|
1279
1279
|
* - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
|
|
1280
1280
|
* `inbound_wire_reversal` object.
|
|
1281
1281
|
* - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
|
|
@@ -1302,8 +1302,8 @@ export namespace ACHTransferSimulation {
|
|
|
1302
1302
|
| 'ach_transfer_return'
|
|
1303
1303
|
| 'card_dispute_acceptance'
|
|
1304
1304
|
| 'card_refund'
|
|
1305
|
-
| 'card_revenue_payment'
|
|
1306
1305
|
| 'card_settlement'
|
|
1306
|
+
| 'card_revenue_payment'
|
|
1307
1307
|
| 'check_deposit_acceptance'
|
|
1308
1308
|
| 'check_deposit_return'
|
|
1309
1309
|
| 'check_transfer_deposit'
|
|
@@ -1315,8 +1315,8 @@ export namespace ACHTransferSimulation {
|
|
|
1315
1315
|
| 'inbound_check'
|
|
1316
1316
|
| 'inbound_international_ach_transfer'
|
|
1317
1317
|
| 'inbound_real_time_payments_transfer_confirmation'
|
|
1318
|
-
| 'inbound_wire_drawdown_payment'
|
|
1319
1318
|
| 'inbound_wire_drawdown_payment_reversal'
|
|
1319
|
+
| 'inbound_wire_drawdown_payment'
|
|
1320
1320
|
| 'inbound_wire_reversal'
|
|
1321
1321
|
| 'inbound_wire_transfer'
|
|
1322
1322
|
| 'interest_payment'
|