@stigg/typescript 0.1.0-alpha.21 → 0.1.0-alpha.22

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 (32) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/v1/coupons.d.mts +3 -3
  4. package/resources/v1/coupons.d.ts +3 -3
  5. package/resources/v1/customers/customers.d.mts +780 -0
  6. package/resources/v1/customers/customers.d.mts.map +1 -1
  7. package/resources/v1/customers/customers.d.ts +780 -0
  8. package/resources/v1/customers/customers.d.ts.map +1 -1
  9. package/resources/v1/customers/customers.js.map +1 -1
  10. package/resources/v1/customers/customers.mjs.map +1 -1
  11. package/resources/v1/events/credits/grants.d.mts +1 -1
  12. package/resources/v1/events/credits/grants.d.ts +1 -1
  13. package/resources/v1/products.d.mts +4 -4
  14. package/resources/v1/products.d.mts.map +1 -1
  15. package/resources/v1/products.d.ts +4 -4
  16. package/resources/v1/products.d.ts.map +1 -1
  17. package/resources/v1/subscriptions/subscriptions.d.mts +14 -11
  18. package/resources/v1/subscriptions/subscriptions.d.mts.map +1 -1
  19. package/resources/v1/subscriptions/subscriptions.d.ts +14 -11
  20. package/resources/v1/subscriptions/subscriptions.d.ts.map +1 -1
  21. package/resources/v1/subscriptions/subscriptions.js.map +1 -1
  22. package/resources/v1/subscriptions/subscriptions.mjs.map +1 -1
  23. package/src/resources/v1/coupons.ts +3 -3
  24. package/src/resources/v1/customers/customers.ts +1836 -0
  25. package/src/resources/v1/events/credits/grants.ts +1 -1
  26. package/src/resources/v1/products.ts +4 -4
  27. package/src/resources/v1/subscriptions/subscriptions.ts +14 -11
  28. package/src/version.ts +1 -1
  29. package/version.d.mts +1 -1
  30. package/version.d.ts +1 -1
  31. package/version.js +1 -1
  32. package/version.mjs +1 -1
@@ -79,6 +79,10 @@ export declare namespace CustomerResponse {
79
79
  * Timestamp of when the record was last updated
80
80
  */
81
81
  updatedAt: string;
82
+ /**
83
+ * The billing currency of the customer
84
+ */
85
+ billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
82
86
  /**
83
87
  * The unique identifier for the entity in the billing provider
84
88
  */
@@ -99,6 +103,10 @@ export declare namespace CustomerResponse {
99
103
  * List of integrations
100
104
  */
101
105
  integrations?: Array<Data.Integration>;
106
+ /**
107
+ * Language to use for this customer
108
+ */
109
+ language?: string | null;
102
110
  /**
103
111
  * Additional metadata
104
112
  */
@@ -109,6 +117,14 @@ export declare namespace CustomerResponse {
109
117
  * The name of the customer
110
118
  */
111
119
  name?: string | null;
120
+ /**
121
+ * Vendor-specific billing passthrough fields.
122
+ */
123
+ passthrough?: Data.Passthrough;
124
+ /**
125
+ * Timezone to use for this customer
126
+ */
127
+ timezone?: string | null;
112
128
  }
113
129
  namespace Data {
114
130
  /**
@@ -153,6 +169,185 @@ export declare namespace CustomerResponse {
153
169
  */
154
170
  vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
155
171
  }
172
+ /**
173
+ * Vendor-specific billing passthrough fields.
174
+ */
175
+ interface Passthrough {
176
+ /**
177
+ * Stripe-specific billing fields for the customer.
178
+ */
179
+ stripe?: Passthrough.Stripe;
180
+ /**
181
+ * Zuora-specific billing fields for the customer.
182
+ */
183
+ zuora?: Passthrough.Zuora;
184
+ }
185
+ namespace Passthrough {
186
+ /**
187
+ * Stripe-specific billing fields for the customer.
188
+ */
189
+ interface Stripe {
190
+ /**
191
+ * Physical address
192
+ */
193
+ billingAddress?: Stripe.BillingAddress;
194
+ /**
195
+ * Customer name
196
+ */
197
+ customerName?: string;
198
+ /**
199
+ * Invoice custom fields
200
+ */
201
+ invoiceCustomFields?: {
202
+ [key: string]: string;
203
+ };
204
+ /**
205
+ * Additional metadata
206
+ */
207
+ metadata?: {
208
+ [key: string]: string;
209
+ };
210
+ /**
211
+ * Billing provider payment method id, attached to this customer
212
+ */
213
+ paymentMethodId?: string;
214
+ /**
215
+ * Physical address
216
+ */
217
+ shippingAddress?: Stripe.ShippingAddress;
218
+ /**
219
+ * Tax IDs
220
+ */
221
+ taxIds?: Array<Stripe.TaxID>;
222
+ }
223
+ namespace Stripe {
224
+ /**
225
+ * Physical address
226
+ */
227
+ interface BillingAddress {
228
+ /**
229
+ * City name
230
+ */
231
+ city?: string;
232
+ /**
233
+ * Country code or name
234
+ */
235
+ country?: string;
236
+ /**
237
+ * Street address line 1
238
+ */
239
+ line1?: string;
240
+ /**
241
+ * Street address line 2
242
+ */
243
+ line2?: string;
244
+ /**
245
+ * Postal or ZIP code
246
+ */
247
+ postalCode?: string;
248
+ /**
249
+ * State or province
250
+ */
251
+ state?: string;
252
+ }
253
+ /**
254
+ * Physical address
255
+ */
256
+ interface ShippingAddress {
257
+ /**
258
+ * City name
259
+ */
260
+ city?: string;
261
+ /**
262
+ * Country code or name
263
+ */
264
+ country?: string;
265
+ /**
266
+ * Street address line 1
267
+ */
268
+ line1?: string;
269
+ /**
270
+ * Street address line 2
271
+ */
272
+ line2?: string;
273
+ /**
274
+ * Postal or ZIP code
275
+ */
276
+ postalCode?: string;
277
+ /**
278
+ * State or province
279
+ */
280
+ state?: string;
281
+ }
282
+ /**
283
+ * Tax identifier with type and value for customer tax exemptions.
284
+ */
285
+ interface TaxID {
286
+ /**
287
+ * The type of tax exemption identifier, such as VAT.
288
+ */
289
+ type: string;
290
+ /**
291
+ * The actual tax identifier value
292
+ */
293
+ value: string;
294
+ }
295
+ }
296
+ /**
297
+ * Zuora-specific billing fields for the customer.
298
+ */
299
+ interface Zuora {
300
+ /**
301
+ * Physical address
302
+ */
303
+ billingAddress?: Zuora.BillingAddress;
304
+ /**
305
+ * Customers selected currency
306
+ */
307
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
308
+ /**
309
+ * Additional metadata
310
+ */
311
+ metadata?: {
312
+ [key: string]: string;
313
+ };
314
+ /**
315
+ * Billing provider payment method id, attached to this customer
316
+ */
317
+ paymentMethodId?: string;
318
+ }
319
+ namespace Zuora {
320
+ /**
321
+ * Physical address
322
+ */
323
+ interface BillingAddress {
324
+ /**
325
+ * City name
326
+ */
327
+ city?: string;
328
+ /**
329
+ * Country code or name
330
+ */
331
+ country?: string;
332
+ /**
333
+ * Street address line 1
334
+ */
335
+ line1?: string;
336
+ /**
337
+ * Street address line 2
338
+ */
339
+ line2?: string;
340
+ /**
341
+ * Postal or ZIP code
342
+ */
343
+ postalCode?: string;
344
+ /**
345
+ * State or province
346
+ */
347
+ state?: string;
348
+ }
349
+ }
350
+ }
156
351
  }
157
352
  }
158
353
  /**
@@ -175,6 +370,10 @@ export interface CustomerListResponse {
175
370
  * Timestamp of when the record was last updated
176
371
  */
177
372
  updatedAt: string;
373
+ /**
374
+ * The billing currency of the customer
375
+ */
376
+ billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
178
377
  /**
179
378
  * The unique identifier for the entity in the billing provider
180
379
  */
@@ -195,6 +394,10 @@ export interface CustomerListResponse {
195
394
  * List of integrations
196
395
  */
197
396
  integrations?: Array<CustomerListResponse.Integration>;
397
+ /**
398
+ * Language to use for this customer
399
+ */
400
+ language?: string | null;
198
401
  /**
199
402
  * Additional metadata
200
403
  */
@@ -205,6 +408,14 @@ export interface CustomerListResponse {
205
408
  * The name of the customer
206
409
  */
207
410
  name?: string | null;
411
+ /**
412
+ * Vendor-specific billing passthrough fields.
413
+ */
414
+ passthrough?: CustomerListResponse.Passthrough;
415
+ /**
416
+ * Timezone to use for this customer
417
+ */
418
+ timezone?: string | null;
208
419
  }
209
420
  export declare namespace CustomerListResponse {
210
421
  /**
@@ -249,6 +460,185 @@ export declare namespace CustomerListResponse {
249
460
  */
250
461
  vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
251
462
  }
463
+ /**
464
+ * Vendor-specific billing passthrough fields.
465
+ */
466
+ interface Passthrough {
467
+ /**
468
+ * Stripe-specific billing fields for the customer.
469
+ */
470
+ stripe?: Passthrough.Stripe;
471
+ /**
472
+ * Zuora-specific billing fields for the customer.
473
+ */
474
+ zuora?: Passthrough.Zuora;
475
+ }
476
+ namespace Passthrough {
477
+ /**
478
+ * Stripe-specific billing fields for the customer.
479
+ */
480
+ interface Stripe {
481
+ /**
482
+ * Physical address
483
+ */
484
+ billingAddress?: Stripe.BillingAddress;
485
+ /**
486
+ * Customer name
487
+ */
488
+ customerName?: string;
489
+ /**
490
+ * Invoice custom fields
491
+ */
492
+ invoiceCustomFields?: {
493
+ [key: string]: string;
494
+ };
495
+ /**
496
+ * Additional metadata
497
+ */
498
+ metadata?: {
499
+ [key: string]: string;
500
+ };
501
+ /**
502
+ * Billing provider payment method id, attached to this customer
503
+ */
504
+ paymentMethodId?: string;
505
+ /**
506
+ * Physical address
507
+ */
508
+ shippingAddress?: Stripe.ShippingAddress;
509
+ /**
510
+ * Tax IDs
511
+ */
512
+ taxIds?: Array<Stripe.TaxID>;
513
+ }
514
+ namespace Stripe {
515
+ /**
516
+ * Physical address
517
+ */
518
+ interface BillingAddress {
519
+ /**
520
+ * City name
521
+ */
522
+ city?: string;
523
+ /**
524
+ * Country code or name
525
+ */
526
+ country?: string;
527
+ /**
528
+ * Street address line 1
529
+ */
530
+ line1?: string;
531
+ /**
532
+ * Street address line 2
533
+ */
534
+ line2?: string;
535
+ /**
536
+ * Postal or ZIP code
537
+ */
538
+ postalCode?: string;
539
+ /**
540
+ * State or province
541
+ */
542
+ state?: string;
543
+ }
544
+ /**
545
+ * Physical address
546
+ */
547
+ interface ShippingAddress {
548
+ /**
549
+ * City name
550
+ */
551
+ city?: string;
552
+ /**
553
+ * Country code or name
554
+ */
555
+ country?: string;
556
+ /**
557
+ * Street address line 1
558
+ */
559
+ line1?: string;
560
+ /**
561
+ * Street address line 2
562
+ */
563
+ line2?: string;
564
+ /**
565
+ * Postal or ZIP code
566
+ */
567
+ postalCode?: string;
568
+ /**
569
+ * State or province
570
+ */
571
+ state?: string;
572
+ }
573
+ /**
574
+ * Tax identifier with type and value for customer tax exemptions.
575
+ */
576
+ interface TaxID {
577
+ /**
578
+ * The type of tax exemption identifier, such as VAT.
579
+ */
580
+ type: string;
581
+ /**
582
+ * The actual tax identifier value
583
+ */
584
+ value: string;
585
+ }
586
+ }
587
+ /**
588
+ * Zuora-specific billing fields for the customer.
589
+ */
590
+ interface Zuora {
591
+ /**
592
+ * Physical address
593
+ */
594
+ billingAddress?: Zuora.BillingAddress;
595
+ /**
596
+ * Customers selected currency
597
+ */
598
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
599
+ /**
600
+ * Additional metadata
601
+ */
602
+ metadata?: {
603
+ [key: string]: string;
604
+ };
605
+ /**
606
+ * Billing provider payment method id, attached to this customer
607
+ */
608
+ paymentMethodId?: string;
609
+ }
610
+ namespace Zuora {
611
+ /**
612
+ * Physical address
613
+ */
614
+ interface BillingAddress {
615
+ /**
616
+ * City name
617
+ */
618
+ city?: string;
619
+ /**
620
+ * Country code or name
621
+ */
622
+ country?: string;
623
+ /**
624
+ * Street address line 1
625
+ */
626
+ line1?: string;
627
+ /**
628
+ * Street address line 2
629
+ */
630
+ line2?: string;
631
+ /**
632
+ * Postal or ZIP code
633
+ */
634
+ postalCode?: string;
635
+ /**
636
+ * State or province
637
+ */
638
+ state?: string;
639
+ }
640
+ }
641
+ }
252
642
  }
253
643
  /**
254
644
  * Response object
@@ -288,6 +678,10 @@ export interface CustomerListResourcesResponse {
288
678
  updatedAt: string;
289
679
  }
290
680
  export interface CustomerUpdateParams {
681
+ /**
682
+ * The billing currency of the customer
683
+ */
684
+ billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
291
685
  /**
292
686
  * The unique identifier for the entity in the billing provider
293
687
  */
@@ -304,6 +698,10 @@ export interface CustomerUpdateParams {
304
698
  * List of integrations
305
699
  */
306
700
  integrations?: Array<CustomerUpdateParams.Integration>;
701
+ /**
702
+ * Language to use for this customer
703
+ */
704
+ language?: string | null;
307
705
  /**
308
706
  * Additional metadata
309
707
  */
@@ -314,6 +712,14 @@ export interface CustomerUpdateParams {
314
712
  * The name of the customer
315
713
  */
316
714
  name?: string | null;
715
+ /**
716
+ * Vendor-specific billing passthrough fields.
717
+ */
718
+ passthrough?: CustomerUpdateParams.Passthrough;
719
+ /**
720
+ * Timezone to use for this customer
721
+ */
722
+ timezone?: string | null;
317
723
  }
318
724
  export declare namespace CustomerUpdateParams {
319
725
  /**
@@ -333,6 +739,185 @@ export declare namespace CustomerUpdateParams {
333
739
  */
334
740
  vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
335
741
  }
742
+ /**
743
+ * Vendor-specific billing passthrough fields.
744
+ */
745
+ interface Passthrough {
746
+ /**
747
+ * Stripe-specific billing fields for the customer.
748
+ */
749
+ stripe?: Passthrough.Stripe;
750
+ /**
751
+ * Zuora-specific billing fields for the customer.
752
+ */
753
+ zuora?: Passthrough.Zuora;
754
+ }
755
+ namespace Passthrough {
756
+ /**
757
+ * Stripe-specific billing fields for the customer.
758
+ */
759
+ interface Stripe {
760
+ /**
761
+ * Physical address
762
+ */
763
+ billingAddress?: Stripe.BillingAddress;
764
+ /**
765
+ * Customer name
766
+ */
767
+ customerName?: string;
768
+ /**
769
+ * Invoice custom fields
770
+ */
771
+ invoiceCustomFields?: {
772
+ [key: string]: string;
773
+ };
774
+ /**
775
+ * Additional metadata
776
+ */
777
+ metadata?: {
778
+ [key: string]: string;
779
+ };
780
+ /**
781
+ * Billing provider payment method id, attached to this customer
782
+ */
783
+ paymentMethodId?: string;
784
+ /**
785
+ * Physical address
786
+ */
787
+ shippingAddress?: Stripe.ShippingAddress;
788
+ /**
789
+ * Tax IDs
790
+ */
791
+ taxIds?: Array<Stripe.TaxID>;
792
+ }
793
+ namespace Stripe {
794
+ /**
795
+ * Physical address
796
+ */
797
+ interface BillingAddress {
798
+ /**
799
+ * City name
800
+ */
801
+ city?: string;
802
+ /**
803
+ * Country code or name
804
+ */
805
+ country?: string;
806
+ /**
807
+ * Street address line 1
808
+ */
809
+ line1?: string;
810
+ /**
811
+ * Street address line 2
812
+ */
813
+ line2?: string;
814
+ /**
815
+ * Postal or ZIP code
816
+ */
817
+ postalCode?: string;
818
+ /**
819
+ * State or province
820
+ */
821
+ state?: string;
822
+ }
823
+ /**
824
+ * Physical address
825
+ */
826
+ interface ShippingAddress {
827
+ /**
828
+ * City name
829
+ */
830
+ city?: string;
831
+ /**
832
+ * Country code or name
833
+ */
834
+ country?: string;
835
+ /**
836
+ * Street address line 1
837
+ */
838
+ line1?: string;
839
+ /**
840
+ * Street address line 2
841
+ */
842
+ line2?: string;
843
+ /**
844
+ * Postal or ZIP code
845
+ */
846
+ postalCode?: string;
847
+ /**
848
+ * State or province
849
+ */
850
+ state?: string;
851
+ }
852
+ /**
853
+ * Tax identifier with type and value for customer tax exemptions.
854
+ */
855
+ interface TaxID {
856
+ /**
857
+ * The type of tax exemption identifier, such as VAT.
858
+ */
859
+ type: string;
860
+ /**
861
+ * The actual tax identifier value
862
+ */
863
+ value: string;
864
+ }
865
+ }
866
+ /**
867
+ * Zuora-specific billing fields for the customer.
868
+ */
869
+ interface Zuora {
870
+ /**
871
+ * Physical address
872
+ */
873
+ billingAddress?: Zuora.BillingAddress;
874
+ /**
875
+ * Customers selected currency
876
+ */
877
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
878
+ /**
879
+ * Additional metadata
880
+ */
881
+ metadata?: {
882
+ [key: string]: string;
883
+ };
884
+ /**
885
+ * Billing provider payment method id, attached to this customer
886
+ */
887
+ paymentMethodId?: string;
888
+ }
889
+ namespace Zuora {
890
+ /**
891
+ * Physical address
892
+ */
893
+ interface BillingAddress {
894
+ /**
895
+ * City name
896
+ */
897
+ city?: string;
898
+ /**
899
+ * Country code or name
900
+ */
901
+ country?: string;
902
+ /**
903
+ * Street address line 1
904
+ */
905
+ line1?: string;
906
+ /**
907
+ * Street address line 2
908
+ */
909
+ line2?: string;
910
+ /**
911
+ * Postal or ZIP code
912
+ */
913
+ postalCode?: string;
914
+ /**
915
+ * State or province
916
+ */
917
+ state?: string;
918
+ }
919
+ }
920
+ }
336
921
  }
337
922
  export interface CustomerListParams extends MyCursorIDPageParams {
338
923
  /**
@@ -426,6 +1011,10 @@ export interface CustomerProvisionParams {
426
1011
  * Customer slug
427
1012
  */
428
1013
  id: string;
1014
+ /**
1015
+ * The billing currency of the customer
1016
+ */
1017
+ billingCurrency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf' | null;
429
1018
  /**
430
1019
  * The unique identifier for the entity in the billing provider
431
1020
  */
@@ -446,6 +1035,10 @@ export interface CustomerProvisionParams {
446
1035
  * List of integrations
447
1036
  */
448
1037
  integrations?: Array<CustomerProvisionParams.Integration>;
1038
+ /**
1039
+ * Language to use for this customer
1040
+ */
1041
+ language?: string | null;
449
1042
  /**
450
1043
  * Additional metadata
451
1044
  */
@@ -456,6 +1049,14 @@ export interface CustomerProvisionParams {
456
1049
  * The name of the customer
457
1050
  */
458
1051
  name?: string | null;
1052
+ /**
1053
+ * Vendor-specific billing passthrough fields.
1054
+ */
1055
+ passthrough?: CustomerProvisionParams.Passthrough;
1056
+ /**
1057
+ * Timezone to use for this customer
1058
+ */
1059
+ timezone?: string | null;
459
1060
  }
460
1061
  export declare namespace CustomerProvisionParams {
461
1062
  /**
@@ -500,6 +1101,185 @@ export declare namespace CustomerProvisionParams {
500
1101
  */
501
1102
  vendorIdentifier: 'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE';
502
1103
  }
1104
+ /**
1105
+ * Vendor-specific billing passthrough fields.
1106
+ */
1107
+ interface Passthrough {
1108
+ /**
1109
+ * Stripe-specific billing fields for the customer.
1110
+ */
1111
+ stripe?: Passthrough.Stripe;
1112
+ /**
1113
+ * Zuora-specific billing fields for the customer.
1114
+ */
1115
+ zuora?: Passthrough.Zuora;
1116
+ }
1117
+ namespace Passthrough {
1118
+ /**
1119
+ * Stripe-specific billing fields for the customer.
1120
+ */
1121
+ interface Stripe {
1122
+ /**
1123
+ * Physical address
1124
+ */
1125
+ billingAddress?: Stripe.BillingAddress;
1126
+ /**
1127
+ * Customer name
1128
+ */
1129
+ customerName?: string;
1130
+ /**
1131
+ * Invoice custom fields
1132
+ */
1133
+ invoiceCustomFields?: {
1134
+ [key: string]: string;
1135
+ };
1136
+ /**
1137
+ * Additional metadata
1138
+ */
1139
+ metadata?: {
1140
+ [key: string]: string;
1141
+ };
1142
+ /**
1143
+ * Billing provider payment method id, attached to this customer
1144
+ */
1145
+ paymentMethodId?: string;
1146
+ /**
1147
+ * Physical address
1148
+ */
1149
+ shippingAddress?: Stripe.ShippingAddress;
1150
+ /**
1151
+ * Tax IDs
1152
+ */
1153
+ taxIds?: Array<Stripe.TaxID>;
1154
+ }
1155
+ namespace Stripe {
1156
+ /**
1157
+ * Physical address
1158
+ */
1159
+ interface BillingAddress {
1160
+ /**
1161
+ * City name
1162
+ */
1163
+ city?: string;
1164
+ /**
1165
+ * Country code or name
1166
+ */
1167
+ country?: string;
1168
+ /**
1169
+ * Street address line 1
1170
+ */
1171
+ line1?: string;
1172
+ /**
1173
+ * Street address line 2
1174
+ */
1175
+ line2?: string;
1176
+ /**
1177
+ * Postal or ZIP code
1178
+ */
1179
+ postalCode?: string;
1180
+ /**
1181
+ * State or province
1182
+ */
1183
+ state?: string;
1184
+ }
1185
+ /**
1186
+ * Physical address
1187
+ */
1188
+ interface ShippingAddress {
1189
+ /**
1190
+ * City name
1191
+ */
1192
+ city?: string;
1193
+ /**
1194
+ * Country code or name
1195
+ */
1196
+ country?: string;
1197
+ /**
1198
+ * Street address line 1
1199
+ */
1200
+ line1?: string;
1201
+ /**
1202
+ * Street address line 2
1203
+ */
1204
+ line2?: string;
1205
+ /**
1206
+ * Postal or ZIP code
1207
+ */
1208
+ postalCode?: string;
1209
+ /**
1210
+ * State or province
1211
+ */
1212
+ state?: string;
1213
+ }
1214
+ /**
1215
+ * Tax identifier with type and value for customer tax exemptions.
1216
+ */
1217
+ interface TaxID {
1218
+ /**
1219
+ * The type of tax exemption identifier, such as VAT.
1220
+ */
1221
+ type: string;
1222
+ /**
1223
+ * The actual tax identifier value
1224
+ */
1225
+ value: string;
1226
+ }
1227
+ }
1228
+ /**
1229
+ * Zuora-specific billing fields for the customer.
1230
+ */
1231
+ interface Zuora {
1232
+ /**
1233
+ * Physical address
1234
+ */
1235
+ billingAddress?: Zuora.BillingAddress;
1236
+ /**
1237
+ * Customers selected currency
1238
+ */
1239
+ currency?: 'usd' | 'aed' | 'all' | 'amd' | 'ang' | 'aud' | 'awg' | 'azn' | 'bam' | 'bbd' | 'bdt' | 'bgn' | 'bif' | 'bmd' | 'bnd' | 'bsd' | 'bwp' | 'byn' | 'bzd' | 'brl' | 'cad' | 'cdf' | 'chf' | 'cny' | 'czk' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'etb' | 'eur' | 'fjd' | 'gbp' | 'gel' | 'gip' | 'gmd' | 'gyd' | 'hkd' | 'hrk' | 'htg' | 'idr' | 'ils' | 'inr' | 'isk' | 'jmd' | 'jpy' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kyd' | 'kzt' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mad' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mro' | 'mvr' | 'mwk' | 'mxn' | 'myr' | 'mzn' | 'nad' | 'ngn' | 'nok' | 'npr' | 'nzd' | 'pgk' | 'php' | 'pkr' | 'pln' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sek' | 'sgd' | 'sle' | 'sll' | 'sos' | 'szl' | 'thb' | 'tjs' | 'top' | 'try' | 'ttd' | 'tzs' | 'uah' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'xaf' | 'xcd' | 'yer' | 'zar' | 'zmw' | 'clp' | 'djf' | 'gnf' | 'ugx' | 'pyg' | 'xof' | 'xpf';
1240
+ /**
1241
+ * Additional metadata
1242
+ */
1243
+ metadata?: {
1244
+ [key: string]: string;
1245
+ };
1246
+ /**
1247
+ * Billing provider payment method id, attached to this customer
1248
+ */
1249
+ paymentMethodId?: string;
1250
+ }
1251
+ namespace Zuora {
1252
+ /**
1253
+ * Physical address
1254
+ */
1255
+ interface BillingAddress {
1256
+ /**
1257
+ * City name
1258
+ */
1259
+ city?: string;
1260
+ /**
1261
+ * Country code or name
1262
+ */
1263
+ country?: string;
1264
+ /**
1265
+ * Street address line 1
1266
+ */
1267
+ line1?: string;
1268
+ /**
1269
+ * Street address line 2
1270
+ */
1271
+ line2?: string;
1272
+ /**
1273
+ * Postal or ZIP code
1274
+ */
1275
+ postalCode?: string;
1276
+ /**
1277
+ * State or province
1278
+ */
1279
+ state?: string;
1280
+ }
1281
+ }
1282
+ }
503
1283
  }
504
1284
  export declare namespace Customers {
505
1285
  export { type CustomerResponse as CustomerResponse, type CustomerListResponse as CustomerListResponse, type CustomerImportResponse as CustomerImportResponse, type CustomerListResourcesResponse as CustomerListResourcesResponse, type CustomerListResponsesMyCursorIDPage as CustomerListResponsesMyCursorIDPage, type CustomerListResourcesResponsesMyCursorIDPage as CustomerListResourcesResponsesMyCursorIDPage, type CustomerUpdateParams as CustomerUpdateParams, type CustomerListParams as CustomerListParams, type CustomerImportParams as CustomerImportParams, type CustomerListResourcesParams as CustomerListResourcesParams, type CustomerProvisionParams as CustomerProvisionParams, };