increase 0.11.3 → 0.11.5

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 (97) hide show
  1. package/CHANGELOG.md +23 -0
  2. package/README.md +1 -1
  3. package/index.d.mts +12 -0
  4. package/index.d.ts +12 -0
  5. package/index.d.ts.map +1 -1
  6. package/index.js +6 -0
  7. package/index.js.map +1 -1
  8. package/index.mjs +6 -0
  9. package/index.mjs.map +1 -1
  10. package/package.json +1 -1
  11. package/resources/card-payments.d.ts +1797 -0
  12. package/resources/card-payments.d.ts.map +1 -0
  13. package/resources/card-payments.js +28 -0
  14. package/resources/card-payments.js.map +1 -0
  15. package/resources/card-payments.mjs +23 -0
  16. package/resources/card-payments.mjs.map +1 -0
  17. package/resources/cards.d.ts +7 -1
  18. package/resources/cards.d.ts.map +1 -1
  19. package/resources/cards.js.map +1 -1
  20. package/resources/cards.mjs.map +1 -1
  21. package/resources/entities/entities.d.ts +16 -6
  22. package/resources/entities/entities.d.ts.map +1 -1
  23. package/resources/entities/entities.js.map +1 -1
  24. package/resources/entities/entities.mjs.map +1 -1
  25. package/resources/event-subscriptions.d.ts +40 -2
  26. package/resources/event-subscriptions.d.ts.map +1 -1
  27. package/resources/event-subscriptions.js.map +1 -1
  28. package/resources/event-subscriptions.mjs.map +1 -1
  29. package/resources/events.d.ts +21 -2
  30. package/resources/events.d.ts.map +1 -1
  31. package/resources/events.js.map +1 -1
  32. package/resources/events.mjs.map +1 -1
  33. package/resources/files.d.ts +4 -0
  34. package/resources/files.d.ts.map +1 -1
  35. package/resources/files.js.map +1 -1
  36. package/resources/files.mjs.map +1 -1
  37. package/resources/index.d.ts +2 -0
  38. package/resources/index.d.ts.map +1 -1
  39. package/resources/index.js +8 -2
  40. package/resources/index.js.map +1 -1
  41. package/resources/index.mjs +2 -0
  42. package/resources/index.mjs.map +1 -1
  43. package/resources/physical-cards.d.ts +318 -0
  44. package/resources/physical-cards.d.ts.map +1 -0
  45. package/resources/physical-cards.js +40 -0
  46. package/resources/physical-cards.js.map +1 -0
  47. package/resources/physical-cards.mjs +35 -0
  48. package/resources/physical-cards.mjs.map +1 -0
  49. package/resources/simulations/ach-transfers.d.ts +5 -5
  50. package/resources/simulations/ach-transfers.d.ts.map +1 -1
  51. package/resources/simulations/index.d.ts +1 -0
  52. package/resources/simulations/index.d.ts.map +1 -1
  53. package/resources/simulations/index.js +3 -1
  54. package/resources/simulations/index.js.map +1 -1
  55. package/resources/simulations/index.mjs +1 -0
  56. package/resources/simulations/index.mjs.map +1 -1
  57. package/resources/simulations/interest-payments.d.ts +5 -5
  58. package/resources/simulations/interest-payments.d.ts.map +1 -1
  59. package/resources/simulations/physical-cards.d.ts +34 -0
  60. package/resources/simulations/physical-cards.d.ts.map +1 -0
  61. package/resources/simulations/physical-cards.js +19 -0
  62. package/resources/simulations/physical-cards.js.map +1 -0
  63. package/resources/simulations/physical-cards.mjs +15 -0
  64. package/resources/simulations/physical-cards.mjs.map +1 -0
  65. package/resources/simulations/real-time-payments-transfers.d.ts +5 -5
  66. package/resources/simulations/real-time-payments-transfers.d.ts.map +1 -1
  67. package/resources/simulations/simulations.d.ts +4 -0
  68. package/resources/simulations/simulations.d.ts.map +1 -1
  69. package/resources/simulations/simulations.js +3 -0
  70. package/resources/simulations/simulations.js.map +1 -1
  71. package/resources/simulations/simulations.mjs +3 -0
  72. package/resources/simulations/simulations.mjs.map +1 -1
  73. package/resources/simulations/wire-transfers.d.ts +5 -5
  74. package/resources/simulations/wire-transfers.d.ts.map +1 -1
  75. package/resources/transactions.d.ts +6 -6
  76. package/resources/transactions.d.ts.map +1 -1
  77. package/src/index.ts +14 -0
  78. package/src/resources/card-payments.ts +2284 -0
  79. package/src/resources/cards.ts +8 -1
  80. package/src/resources/entities/entities.ts +18 -6
  81. package/src/resources/event-subscriptions.ts +64 -0
  82. package/src/resources/events.ts +45 -0
  83. package/src/resources/files.ts +5 -0
  84. package/src/resources/index.ts +9 -0
  85. package/src/resources/physical-cards.ts +394 -0
  86. package/src/resources/simulations/ach-transfers.ts +6 -6
  87. package/src/resources/simulations/index.ts +1 -0
  88. package/src/resources/simulations/interest-payments.ts +6 -6
  89. package/src/resources/simulations/physical-cards.ts +51 -0
  90. package/src/resources/simulations/real-time-payments-transfers.ts +6 -6
  91. package/src/resources/simulations/simulations.ts +5 -0
  92. package/src/resources/simulations/wire-transfers.ts +6 -6
  93. package/src/resources/transactions.ts +8 -8
  94. package/src/version.ts +1 -1
  95. package/version.d.ts +1 -1
  96. package/version.js +1 -1
  97. package/version.mjs +1 -1
@@ -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'
@@ -36,6 +36,7 @@ export {
36
36
  InterestPaymentCreateParams,
37
37
  InterestPayments,
38
38
  } from './interest-payments';
39
+ export { PhysicalCardShipmentAdvanceParams, PhysicalCards } from './physical-cards';
39
40
  export { ProgramCreateParams, Programs } from './programs';
40
41
  export { Simulations } from './simulations';
41
42
  export { WireTransferSimulation, WireTransferCreateInboundParams, WireTransfers } from './wire-transfers';
@@ -183,10 +183,10 @@ export namespace InterestPaymentSimulationResult {
183
183
  * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
184
184
  * `card_dispute_acceptance` object.
185
185
  * - `card_refund` - Card Refund: details will be under the `card_refund` object.
186
- * - `card_revenue_payment` - Card Revenue Payment: details will be under the
187
- * `card_revenue_payment` object.
188
186
  * - `card_settlement` - Card Settlement: details will be under the
189
187
  * `card_settlement` object.
188
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
189
+ * `card_revenue_payment` object.
190
190
  * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
191
191
  * the `check_deposit_acceptance` object.
192
192
  * - `check_deposit_return` - Check Deposit Return: details will be under the
@@ -210,11 +210,11 @@ export namespace InterestPaymentSimulationResult {
210
210
  * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
211
211
  * Payments Transfer Confirmation: details will be under the
212
212
  * `inbound_real_time_payments_transfer_confirmation` object.
213
- * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
214
- * be under the `inbound_wire_drawdown_payment` object.
215
213
  * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
216
214
  * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
217
215
  * object.
216
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
217
+ * be under the `inbound_wire_drawdown_payment` object.
218
218
  * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
219
219
  * `inbound_wire_reversal` object.
220
220
  * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
@@ -241,8 +241,8 @@ export namespace InterestPaymentSimulationResult {
241
241
  | 'ach_transfer_return'
242
242
  | 'card_dispute_acceptance'
243
243
  | 'card_refund'
244
- | 'card_revenue_payment'
245
244
  | 'card_settlement'
245
+ | 'card_revenue_payment'
246
246
  | 'check_deposit_acceptance'
247
247
  | 'check_deposit_return'
248
248
  | 'check_transfer_deposit'
@@ -254,8 +254,8 @@ export namespace InterestPaymentSimulationResult {
254
254
  | 'inbound_check'
255
255
  | 'inbound_international_ach_transfer'
256
256
  | 'inbound_real_time_payments_transfer_confirmation'
257
- | 'inbound_wire_drawdown_payment'
258
257
  | 'inbound_wire_drawdown_payment_reversal'
258
+ | 'inbound_wire_drawdown_payment'
259
259
  | 'inbound_wire_reversal'
260
260
  | 'inbound_wire_transfer'
261
261
  | 'interest_payment'
@@ -0,0 +1,51 @@
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 * as PhysicalCards_ from "../../e/resources/physical-cards";
6
+ import * as API from './index';
7
+
8
+ export class PhysicalCards extends APIResource {
9
+ /**
10
+ * This endpoint allows you to simulate advancing the shipment status of a Physical
11
+ * Card, to simulate e.g., that a physical card was attempted shipped but then
12
+ * failed delivery.
13
+ */
14
+ shipmentAdvance(
15
+ physicalCardId: string,
16
+ body: PhysicalCardShipmentAdvanceParams,
17
+ options?: Core.RequestOptions,
18
+ ): Core.APIPromise<PhysicalCards_.PhysicalCard> {
19
+ return this.post(`/simulations/physical_cards/${physicalCardId}/shipment_advance`, { body, ...options });
20
+ }
21
+ }
22
+
23
+ export interface PhysicalCardShipmentAdvanceParams {
24
+ /**
25
+ * The shipment status to move the Physical Card to.
26
+ *
27
+ * - `pending` - The physical card has not yet been shipped.
28
+ * - `canceled` - The physical card shipment was canceled prior to submission.
29
+ * - `submitted` - The physical card shipment has been submitted to the card
30
+ * fulfillment provider.
31
+ * - `acknowledged` - The physical card shipment has been acknowledged by the card
32
+ * fulfillment provider and will be processed in their next batch.
33
+ * - `rejected` - The physical card shipment was rejected by the card printer due
34
+ * to an error.
35
+ * - `shipped` - The physical card has been shipped.
36
+ * - `returned` - The physical card shipment was returned to the sender and
37
+ * destroyed by the production facility.
38
+ */
39
+ shipment_status:
40
+ | 'pending'
41
+ | 'canceled'
42
+ | 'submitted'
43
+ | 'acknowledged'
44
+ | 'rejected'
45
+ | 'shipped'
46
+ | 'returned';
47
+ }
48
+
49
+ export namespace PhysicalCards {
50
+ export import PhysicalCardShipmentAdvanceParams = API.PhysicalCardShipmentAdvanceParams;
51
+ }
@@ -1224,10 +1224,10 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1224
1224
  * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
1225
1225
  * `card_dispute_acceptance` object.
1226
1226
  * - `card_refund` - Card Refund: details will be under the `card_refund` object.
1227
- * - `card_revenue_payment` - Card Revenue Payment: details will be under the
1228
- * `card_revenue_payment` object.
1229
1227
  * - `card_settlement` - Card Settlement: details will be under the
1230
1228
  * `card_settlement` object.
1229
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
1230
+ * `card_revenue_payment` object.
1231
1231
  * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
1232
1232
  * the `check_deposit_acceptance` object.
1233
1233
  * - `check_deposit_return` - Check Deposit Return: details will be under the
@@ -1251,11 +1251,11 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1251
1251
  * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
1252
1252
  * Payments Transfer Confirmation: details will be under the
1253
1253
  * `inbound_real_time_payments_transfer_confirmation` object.
1254
- * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
1255
- * be under the `inbound_wire_drawdown_payment` object.
1256
1254
  * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
1257
1255
  * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
1258
1256
  * object.
1257
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
1258
+ * be under the `inbound_wire_drawdown_payment` object.
1259
1259
  * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
1260
1260
  * `inbound_wire_reversal` object.
1261
1261
  * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
@@ -1282,8 +1282,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1282
1282
  | 'ach_transfer_return'
1283
1283
  | 'card_dispute_acceptance'
1284
1284
  | 'card_refund'
1285
- | 'card_revenue_payment'
1286
1285
  | 'card_settlement'
1286
+ | 'card_revenue_payment'
1287
1287
  | 'check_deposit_acceptance'
1288
1288
  | 'check_deposit_return'
1289
1289
  | 'check_transfer_deposit'
@@ -1295,8 +1295,8 @@ export namespace InboundRealTimePaymentsTransferSimulationResult {
1295
1295
  | 'inbound_check'
1296
1296
  | 'inbound_international_ach_transfer'
1297
1297
  | 'inbound_real_time_payments_transfer_confirmation'
1298
- | 'inbound_wire_drawdown_payment'
1299
1298
  | 'inbound_wire_drawdown_payment_reversal'
1299
+ | 'inbound_wire_drawdown_payment'
1300
1300
  | 'inbound_wire_reversal'
1301
1301
  | 'inbound_wire_transfer'
1302
1302
  | 'interest_payment'
@@ -18,6 +18,7 @@ import { InterestPayments } from './interest-payments';
18
18
  import { WireTransfers } from './wire-transfers';
19
19
  import { Cards } from './cards';
20
20
  import { RealTimePaymentsTransfers } from './real-time-payments-transfers';
21
+ import { PhysicalCards } from './physical-cards';
21
22
  import * as API from './index';
22
23
 
23
24
  export class Simulations extends APIResource {
@@ -38,6 +39,7 @@ export class Simulations extends APIResource {
38
39
  wireTransfers: WireTransfers = new WireTransfers(this.client);
39
40
  cards: Cards = new Cards(this.client);
40
41
  realTimePaymentsTransfers: RealTimePaymentsTransfers = new RealTimePaymentsTransfers(this.client);
42
+ physicalCards: PhysicalCards = new PhysicalCards(this.client);
41
43
  }
42
44
 
43
45
  export namespace Simulations {
@@ -96,4 +98,7 @@ export namespace Simulations {
96
98
  export import InboundRealTimePaymentsTransferSimulationResult = API.InboundRealTimePaymentsTransferSimulationResult;
97
99
  export import RealTimePaymentsTransferCompleteParams = API.RealTimePaymentsTransferCompleteParams;
98
100
  export import RealTimePaymentsTransferCreateInboundParams = API.RealTimePaymentsTransferCreateInboundParams;
101
+
102
+ export import PhysicalCards = API.PhysicalCards;
103
+ export import PhysicalCardShipmentAdvanceParams = API.PhysicalCardShipmentAdvanceParams;
99
104
  }
@@ -184,10 +184,10 @@ export namespace WireTransferSimulation {
184
184
  * - `card_dispute_acceptance` - Card Dispute Acceptance: details will be under the
185
185
  * `card_dispute_acceptance` object.
186
186
  * - `card_refund` - Card Refund: details will be under the `card_refund` object.
187
- * - `card_revenue_payment` - Card Revenue Payment: details will be under the
188
- * `card_revenue_payment` object.
189
187
  * - `card_settlement` - Card Settlement: details will be under the
190
188
  * `card_settlement` object.
189
+ * - `card_revenue_payment` - Card Revenue Payment: details will be under the
190
+ * `card_revenue_payment` object.
191
191
  * - `check_deposit_acceptance` - Check Deposit Acceptance: details will be under
192
192
  * the `check_deposit_acceptance` object.
193
193
  * - `check_deposit_return` - Check Deposit Return: details will be under the
@@ -211,11 +211,11 @@ export namespace WireTransferSimulation {
211
211
  * - `inbound_real_time_payments_transfer_confirmation` - Inbound Real-Time
212
212
  * Payments Transfer Confirmation: details will be under the
213
213
  * `inbound_real_time_payments_transfer_confirmation` object.
214
- * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
215
- * be under the `inbound_wire_drawdown_payment` object.
216
214
  * - `inbound_wire_drawdown_payment_reversal` - Inbound Wire Drawdown Payment
217
215
  * Reversal: details will be under the `inbound_wire_drawdown_payment_reversal`
218
216
  * object.
217
+ * - `inbound_wire_drawdown_payment` - Inbound Wire Drawdown Payment: details will
218
+ * be under the `inbound_wire_drawdown_payment` object.
219
219
  * - `inbound_wire_reversal` - Inbound Wire Reversal: details will be under the
220
220
  * `inbound_wire_reversal` object.
221
221
  * - `inbound_wire_transfer` - Inbound Wire Transfer: details will be under the
@@ -242,8 +242,8 @@ export namespace WireTransferSimulation {
242
242
  | 'ach_transfer_return'
243
243
  | 'card_dispute_acceptance'
244
244
  | 'card_refund'
245
- | 'card_revenue_payment'
246
245
  | 'card_settlement'
246
+ | 'card_revenue_payment'
247
247
  | 'check_deposit_acceptance'
248
248
  | 'check_deposit_return'
249
249
  | 'check_transfer_deposit'
@@ -255,8 +255,8 @@ export namespace WireTransferSimulation {
255
255
  | 'inbound_check'
256
256
  | 'inbound_international_ach_transfer'
257
257
  | 'inbound_real_time_payments_transfer_confirmation'
258
- | 'inbound_wire_drawdown_payment'
259
258
  | 'inbound_wire_drawdown_payment_reversal'
259
+ | 'inbound_wire_drawdown_payment'
260
260
  | 'inbound_wire_reversal'
261
261
  | 'inbound_wire_transfer'
262
262
  | 'interest_payment'