chargebee 3.0.0-beta.4 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (84) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +4 -3
  3. package/cjs/environment.js +1 -1
  4. package/cjs/util.js +1 -1
  5. package/esm/environment.js +1 -1
  6. package/esm/util.js +1 -1
  7. package/package.json +1 -1
  8. package/types/core.d.ts +0 -564
  9. package/types/index.d.ts +0 -167
  10. package/types/resources/Address.d.ts +0 -71
  11. package/types/resources/AdvanceInvoiceSchedule.d.ts +0 -29
  12. package/types/resources/AttachedItem.d.ts +0 -114
  13. package/types/resources/Attribute.d.ts +0 -9
  14. package/types/resources/BusinessEntity.d.ts +0 -64
  15. package/types/resources/BusinessEntityTransfer.d.ts +0 -15
  16. package/types/resources/Card.d.ts +0 -171
  17. package/types/resources/Comment.d.ts +0 -89
  18. package/types/resources/Contact.d.ts +0 -16
  19. package/types/resources/ContractTerm.d.ts +0 -19
  20. package/types/resources/Coupon.d.ts +0 -314
  21. package/types/resources/CouponCode.d.ts +0 -70
  22. package/types/resources/CouponSet.d.ts +0 -111
  23. package/types/resources/CreditNote.d.ts +0 -628
  24. package/types/resources/CreditNoteEstimate.d.ts +0 -143
  25. package/types/resources/Currency.d.ts +0 -91
  26. package/types/resources/Customer.d.ts +0 -962
  27. package/types/resources/CustomerEntitlement.d.ts +0 -36
  28. package/types/resources/DifferentialPrice.d.ts +0 -142
  29. package/types/resources/Discount.d.ts +0 -24
  30. package/types/resources/Download.d.ts +0 -10
  31. package/types/resources/Entitlement.d.ts +0 -66
  32. package/types/resources/EntitlementOverride.d.ts +0 -76
  33. package/types/resources/Estimate.d.ts +0 -1237
  34. package/types/resources/Event.d.ts +0 -81
  35. package/types/resources/Export.d.ts +0 -607
  36. package/types/resources/Feature.d.ts +0 -142
  37. package/types/resources/GatewayErrorDetail.d.ts +0 -20
  38. package/types/resources/Gift.d.ts +0 -296
  39. package/types/resources/Hierarchy.d.ts +0 -12
  40. package/types/resources/HostedPage.d.ts +0 -1112
  41. package/types/resources/ImpactedItem.d.ts +0 -20
  42. package/types/resources/ImpactedItemPrice.d.ts +0 -20
  43. package/types/resources/ImpactedSubscription.d.ts +0 -20
  44. package/types/resources/InAppSubscription.d.ts +0 -116
  45. package/types/resources/Invoice.d.ts +0 -1691
  46. package/types/resources/InvoiceEstimate.d.ts +0 -143
  47. package/types/resources/Item.d.ts +0 -204
  48. package/types/resources/ItemEntitlement.d.ts +0 -103
  49. package/types/resources/ItemFamily.d.ts +0 -89
  50. package/types/resources/ItemPrice.d.ts +0 -328
  51. package/types/resources/Metadata.d.ts +0 -8
  52. package/types/resources/NonSubscription.d.ts +0 -48
  53. package/types/resources/Order.d.ts +0 -586
  54. package/types/resources/PaymentIntent.d.ts +0 -178
  55. package/types/resources/PaymentReferenceNumber.d.ts +0 -11
  56. package/types/resources/PaymentSchedule.d.ts +0 -28
  57. package/types/resources/PaymentScheduleEstimate.d.ts +0 -25
  58. package/types/resources/PaymentScheduleScheme.d.ts +0 -62
  59. package/types/resources/PaymentSource.d.ts +0 -529
  60. package/types/resources/PaymentVoucher.d.ts +0 -107
  61. package/types/resources/PortalSession.d.ts +0 -88
  62. package/types/resources/PriceVariant.d.ts +0 -112
  63. package/types/resources/PricingPageSession.d.ts +0 -130
  64. package/types/resources/PromotionalCredit.d.ts +0 -111
  65. package/types/resources/Purchase.d.ts +0 -202
  66. package/types/resources/Quote.d.ts +0 -1467
  67. package/types/resources/QuoteLineGroup.d.ts +0 -136
  68. package/types/resources/QuotedCharge.d.ts +0 -56
  69. package/types/resources/QuotedSubscription.d.ts +0 -114
  70. package/types/resources/Ramp.d.ts +0 -260
  71. package/types/resources/ResourceMigration.d.ts +0 -36
  72. package/types/resources/SiteMigrationDetail.d.ts +0 -46
  73. package/types/resources/Subscription.d.ts +0 -2443
  74. package/types/resources/SubscriptionEntitlement.d.ts +0 -79
  75. package/types/resources/SubscriptionEstimate.d.ts +0 -59
  76. package/types/resources/TaxWithheld.d.ts +0 -19
  77. package/types/resources/ThirdPartyPaymentMethod.d.ts +0 -11
  78. package/types/resources/TimeMachine.d.ts +0 -57
  79. package/types/resources/Token.d.ts +0 -19
  80. package/types/resources/Transaction.d.ts +0 -313
  81. package/types/resources/UnbilledCharge.d.ts +0 -209
  82. package/types/resources/Usage.d.ts +0 -113
  83. package/types/resources/VirtualBankAccount.d.ts +0 -125
  84. package/types/resources/filter.d.ts +0 -52
@@ -1,962 +0,0 @@
1
- ///<reference path='./../core.d.ts'/>
2
- ///<reference path='./../index.d.ts'/>
3
- ///<reference path='./filter.d.ts'/>
4
- declare module 'chargebee' {
5
- export interface Customer {
6
- [key: string]: unknown;
7
- id: string;
8
- first_name?: string;
9
- last_name?: string;
10
- email?: string;
11
- phone?: string;
12
- company?: string;
13
- vat_number?: string;
14
- auto_collection: AutoCollection;
15
- offline_payment_method?: OfflinePaymentMethod;
16
- net_term_days: number;
17
- vat_number_validated_time?: number;
18
- vat_number_status?: 'valid' | 'invalid' | 'not_validated' | 'undetermined';
19
- allow_direct_debit: boolean;
20
- is_location_valid?: boolean;
21
- created_at: number;
22
- created_from_ip?: string;
23
- exemption_details?: any;
24
- taxability?: Taxability;
25
- entity_code?: EntityCode;
26
- exempt_number?: string;
27
- resource_version?: number;
28
- updated_at?: number;
29
- locale?: string;
30
- billing_date?: number;
31
- billing_month?: number;
32
- billing_date_mode?: BillingDateMode;
33
- billing_day_of_week?:
34
- | 'sunday'
35
- | 'monday'
36
- | 'tuesday'
37
- | 'wednesday'
38
- | 'thursday'
39
- | 'friday'
40
- | 'saturday';
41
- billing_day_of_week_mode?: BillingDayOfWeekMode;
42
- pii_cleared?: 'active' | 'scheduled_for_clear' | 'cleared';
43
- auto_close_invoices?: boolean;
44
- channel?: Channel;
45
- active_id?: string;
46
- card_status?:
47
- | 'no_card'
48
- | 'valid'
49
- | 'expiring'
50
- | 'expired'
51
- | 'pending_verification'
52
- | 'invalid';
53
- fraud_flag?: 'safe' | 'suspicious' | 'fraudulent';
54
- primary_payment_source_id?: string;
55
- backup_payment_source_id?: string;
56
- billing_address?: Customer.BillingAddress;
57
- referral_urls?: Customer.ReferralUrl[];
58
- contacts?: Customer.Contact[];
59
- payment_method?: Customer.PaymentMethod;
60
- invoice_notes?: string;
61
- business_entity_id?: string;
62
- preferred_currency_code?: string;
63
- promotional_credits: number;
64
- unbilled_charges: number;
65
- refundable_credits: number;
66
- excess_payments: number;
67
- balances?: Customer.Balance[];
68
- entity_identifiers?: Customer.EntityIdentifier[];
69
- tax_providers_fields?: Customer.TaxProvidersField[];
70
- is_einvoice_enabled?: boolean;
71
- einvoicing_method?: EinvoicingMethod;
72
- meta_data?: any;
73
- deleted: boolean;
74
- registered_for_gst?: boolean;
75
- consolidated_invoicing?: boolean;
76
- customer_type?: CustomerType;
77
- business_customer_without_vat_number?: boolean;
78
- client_profile_id?: string;
79
- relationship?: Customer.Relationship;
80
- use_default_hierarchy_settings?: boolean;
81
- parent_account_access?: Customer.ParentAccountAccess;
82
- child_account_access?: Customer.ChildAccountAccess;
83
- vat_number_prefix?: string;
84
- entity_identifier_scheme?: string;
85
- entity_identifier_standard?: string;
86
- }
87
-
88
- export namespace Customer {
89
- export class CustomerResource {
90
- create(
91
- input?: CreateInputParam,
92
- headers?: ChargebeeRequestHeader,
93
- ): Promise<ChargebeeResponse<CreateResponse>>;
94
-
95
- list(
96
- input?: ListInputParam,
97
- headers?: ChargebeeRequestHeader,
98
- ): Promise<ChargebeeResponse<ListResponse>>;
99
-
100
- retrieve(
101
- customer_id: string,
102
- headers?: ChargebeeRequestHeader,
103
- ): Promise<ChargebeeResponse<RetrieveResponse>>;
104
-
105
- update(
106
- customer_id: string,
107
- input?: UpdateInputParam,
108
- headers?: ChargebeeRequestHeader,
109
- ): Promise<ChargebeeResponse<UpdateResponse>>;
110
-
111
- updatePaymentMethod(
112
- customer_id: string,
113
- input: UpdatePaymentMethodInputParam,
114
- headers?: ChargebeeRequestHeader,
115
- ): Promise<ChargebeeResponse<UpdatePaymentMethodResponse>>;
116
-
117
- updateBillingInfo(
118
- customer_id: string,
119
- input?: UpdateBillingInfoInputParam,
120
- headers?: ChargebeeRequestHeader,
121
- ): Promise<ChargebeeResponse<UpdateBillingInfoResponse>>;
122
-
123
- contactsForCustomer(
124
- customer_id: string,
125
- input?: ContactsForCustomerInputParam,
126
- headers?: ChargebeeRequestHeader,
127
- ): Promise<ChargebeeResponse<ContactsForCustomerResponse>>;
128
-
129
- assignPaymentRole(
130
- customer_id: string,
131
- input: AssignPaymentRoleInputParam,
132
- headers?: ChargebeeRequestHeader,
133
- ): Promise<ChargebeeResponse<AssignPaymentRoleResponse>>;
134
-
135
- addContact(
136
- customer_id: string,
137
- input: AddContactInputParam,
138
- headers?: ChargebeeRequestHeader,
139
- ): Promise<ChargebeeResponse<AddContactResponse>>;
140
-
141
- updateContact(
142
- customer_id: string,
143
- input: UpdateContactInputParam,
144
- headers?: ChargebeeRequestHeader,
145
- ): Promise<ChargebeeResponse<UpdateContactResponse>>;
146
-
147
- deleteContact(
148
- customer_id: string,
149
- input: DeleteContactInputParam,
150
- headers?: ChargebeeRequestHeader,
151
- ): Promise<ChargebeeResponse<DeleteContactResponse>>;
152
-
153
- addPromotionalCredits(
154
- customer_id: string,
155
- input: AddPromotionalCreditsInputParam,
156
- headers?: ChargebeeRequestHeader,
157
- ): Promise<ChargebeeResponse<AddPromotionalCreditsResponse>>;
158
-
159
- deductPromotionalCredits(
160
- customer_id: string,
161
- input: DeductPromotionalCreditsInputParam,
162
- headers?: ChargebeeRequestHeader,
163
- ): Promise<ChargebeeResponse<DeductPromotionalCreditsResponse>>;
164
-
165
- setPromotionalCredits(
166
- customer_id: string,
167
- input: SetPromotionalCreditsInputParam,
168
- headers?: ChargebeeRequestHeader,
169
- ): Promise<ChargebeeResponse<SetPromotionalCreditsResponse>>;
170
-
171
- recordExcessPayment(
172
- customer_id: string,
173
- input: RecordExcessPaymentInputParam,
174
- headers?: ChargebeeRequestHeader,
175
- ): Promise<ChargebeeResponse<RecordExcessPaymentResponse>>;
176
-
177
- collectPayment(
178
- customer_id: string,
179
- input: CollectPaymentInputParam,
180
- headers?: ChargebeeRequestHeader,
181
- ): Promise<ChargebeeResponse<CollectPaymentResponse>>;
182
-
183
- delete(
184
- customer_id: string,
185
- input?: DeleteInputParam,
186
- headers?: ChargebeeRequestHeader,
187
- ): Promise<ChargebeeResponse<DeleteResponse>>;
188
-
189
- move(
190
- input: MoveInputParam,
191
- headers?: ChargebeeRequestHeader,
192
- ): Promise<ChargebeeResponse<MoveResponse>>;
193
-
194
- changeBillingDate(
195
- customer_id: string,
196
- input?: ChangeBillingDateInputParam,
197
- headers?: ChargebeeRequestHeader,
198
- ): Promise<ChargebeeResponse<ChangeBillingDateResponse>>;
199
-
200
- merge(
201
- input: MergeInputParam,
202
- headers?: ChargebeeRequestHeader,
203
- ): Promise<ChargebeeResponse<MergeResponse>>;
204
-
205
- clearPersonalData(
206
- customer_id: string,
207
- headers?: ChargebeeRequestHeader,
208
- ): Promise<ChargebeeResponse<ClearPersonalDataResponse>>;
209
-
210
- relationships(
211
- customer_id: string,
212
- input?: RelationshipsInputParam,
213
- headers?: ChargebeeRequestHeader,
214
- ): Promise<ChargebeeResponse<RelationshipsResponse>>;
215
-
216
- deleteRelationship(
217
- customer_id: string,
218
- headers?: ChargebeeRequestHeader,
219
- ): Promise<ChargebeeResponse<DeleteRelationshipResponse>>;
220
-
221
- hierarchy(
222
- customer_id: string,
223
- input: HierarchyInputParam,
224
- headers?: ChargebeeRequestHeader,
225
- ): Promise<ChargebeeResponse<HierarchyResponse>>;
226
-
227
- updateHierarchySettings(
228
- customer_id: string,
229
- input?: UpdateHierarchySettingsInputParam,
230
- headers?: ChargebeeRequestHeader,
231
- ): Promise<ChargebeeResponse<UpdateHierarchySettingsResponse>>;
232
- }
233
-
234
- export interface CreateResponse {
235
- customer: Customer;
236
- card?: Card;
237
- }
238
-
239
- export interface ListResponse {
240
- list: { customer: Customer; card?: Card }[];
241
- next_offset?: string;
242
- }
243
-
244
- export interface RetrieveResponse {
245
- customer: Customer;
246
- card?: Card;
247
- }
248
-
249
- export interface UpdateResponse {
250
- customer: Customer;
251
- card?: Card;
252
- }
253
-
254
- export interface UpdatePaymentMethodResponse {
255
- customer: Customer;
256
- card?: Card;
257
- }
258
-
259
- export interface UpdateBillingInfoResponse {
260
- customer: Customer;
261
- card?: Card;
262
- }
263
-
264
- export interface ContactsForCustomerResponse {
265
- list: { contact: Contact }[];
266
- next_offset?: string;
267
- }
268
-
269
- export interface AssignPaymentRoleResponse {
270
- customer: Customer;
271
- payment_source: PaymentSource;
272
- }
273
-
274
- export interface AddContactResponse {
275
- customer: Customer;
276
- card?: Card;
277
- }
278
-
279
- export interface UpdateContactResponse {
280
- customer: Customer;
281
- card?: Card;
282
- }
283
-
284
- export interface DeleteContactResponse {
285
- customer: Customer;
286
- card?: Card;
287
- }
288
-
289
- export interface AddPromotionalCreditsResponse {
290
- customer: Customer;
291
- }
292
-
293
- export interface DeductPromotionalCreditsResponse {
294
- customer: Customer;
295
- }
296
-
297
- export interface SetPromotionalCreditsResponse {
298
- customer: Customer;
299
- }
300
-
301
- export interface RecordExcessPaymentResponse {
302
- customer: Customer;
303
- transaction: Transaction;
304
- }
305
-
306
- export interface CollectPaymentResponse {
307
- customer: Customer;
308
- transaction: Transaction;
309
- }
310
-
311
- export interface DeleteResponse {
312
- customer: Customer;
313
- card?: Card;
314
- }
315
-
316
- export interface MoveResponse {
317
- resource_migration: ResourceMigration;
318
- }
319
-
320
- export interface ChangeBillingDateResponse {
321
- customer: Customer;
322
- }
323
-
324
- export interface MergeResponse {
325
- customer: Customer;
326
- }
327
-
328
- export interface ClearPersonalDataResponse {
329
- customer: Customer;
330
- }
331
-
332
- export interface RelationshipsResponse {
333
- customer: Customer;
334
- }
335
-
336
- export interface DeleteRelationshipResponse {
337
- customer: Customer;
338
- }
339
-
340
- export interface HierarchyResponse {
341
- hierarchies: Hierarchy[];
342
- }
343
-
344
- export interface UpdateHierarchySettingsResponse {
345
- customer: Customer;
346
- }
347
-
348
- export interface BillingAddress {
349
- first_name?: string;
350
- last_name?: string;
351
- email?: string;
352
- company?: string;
353
- phone?: string;
354
- line1?: string;
355
- line2?: string;
356
- line3?: string;
357
- city?: string;
358
- state_code?: string;
359
- state?: string;
360
- country?: string;
361
- zip?: string;
362
- validation_status?: ValidationStatus;
363
- }
364
- export interface ReferralUrl {
365
- external_customer_id?: string;
366
- referral_sharing_url: string;
367
- created_at: number;
368
- updated_at: number;
369
- referral_campaign_id: string;
370
- referral_account_id: string;
371
- referral_external_campaign_id?: string;
372
- referral_system: 'referral_candy' | 'referral_saasquatch' | 'friendbuy';
373
- }
374
- export interface Contact {
375
- id: string;
376
- first_name?: string;
377
- last_name?: string;
378
- email: string;
379
- phone?: string;
380
- label?: string;
381
- enabled: boolean;
382
- send_account_email: boolean;
383
- send_billing_email: boolean;
384
- }
385
- export interface PaymentMethod {
386
- type: Type;
387
- gateway: Gateway;
388
- gateway_account_id?: string;
389
- status:
390
- | 'valid'
391
- | 'expiring'
392
- | 'expired'
393
- | 'invalid'
394
- | 'pending_verification';
395
- reference_id: string;
396
- }
397
- export interface Balance {
398
- promotional_credits: number;
399
- excess_payments: number;
400
- refundable_credits: number;
401
- unbilled_charges: number;
402
- currency_code: string;
403
- balance_currency_code: string;
404
- }
405
- export interface EntityIdentifier {
406
- id: string;
407
- value?: string;
408
- scheme: string;
409
- standard?: string;
410
- }
411
- export interface TaxProvidersField {
412
- provider_name: string;
413
- field_id: string;
414
- field_value: string;
415
- }
416
- export interface Relationship {
417
- parent_id?: string;
418
- payment_owner_id: string;
419
- invoice_owner_id: string;
420
- }
421
- export interface ParentAccountAccess {
422
- portal_edit_child_subscriptions?: 'yes' | 'view_only' | 'no';
423
- portal_download_child_invoices?: 'yes' | 'view_only' | 'no';
424
- send_subscription_emails: boolean;
425
- send_invoice_emails: boolean;
426
- send_payment_emails: boolean;
427
- }
428
- export interface ChildAccountAccess {
429
- portal_edit_subscriptions?: 'yes' | 'view_only';
430
- portal_download_invoices?: 'yes' | 'view_only' | 'no';
431
- send_subscription_emails: boolean;
432
- send_invoice_emails: boolean;
433
- send_payment_emails: boolean;
434
- }
435
- // REQUEST PARAMS
436
- //---------------
437
-
438
- export interface CreateInputParam {
439
- id?: string;
440
- first_name?: string;
441
- last_name?: string;
442
- email?: string;
443
- preferred_currency_code?: string;
444
- phone?: string;
445
- company?: string;
446
- auto_collection?: AutoCollection;
447
- net_term_days?: number;
448
- allow_direct_debit?: boolean;
449
- vat_number?: string;
450
- vat_number_prefix?: string;
451
- entity_identifier_scheme?: string;
452
- entity_identifier_standard?: string;
453
- registered_for_gst?: boolean;
454
- is_einvoice_enabled?: boolean;
455
- einvoicing_method?: EinvoicingMethod;
456
- taxability?: Taxability;
457
- exemption_details?: any;
458
- customer_type?: CustomerType;
459
- client_profile_id?: string;
460
- taxjar_exemption_category?: TaxjarExemptionCategory;
461
- business_customer_without_vat_number?: boolean;
462
- locale?: string;
463
- entity_code?: EntityCode;
464
- exempt_number?: string;
465
- meta_data?: any;
466
- offline_payment_method?: OfflinePaymentMethod;
467
- auto_close_invoices?: boolean;
468
- consolidated_invoicing?: boolean;
469
- token_id?: string;
470
- business_entity_id?: string /**
471
- * @deprecated Please refer API docs to use other attributes
472
- */;
473
-
474
- created_from_ip?: string;
475
- invoice_notes?: string;
476
- card?: CardCreateInputParam;
477
- bank_account?: BankAccountCreateInputParam;
478
- payment_method?: PaymentMethodCreateInputParam;
479
- payment_intent?: PaymentIntentCreateInputParam;
480
- billing_address?: BillingAddressCreateInputParam;
481
- entity_identifiers?: EntityIdentifiersCreateInputParam[];
482
- tax_providers_fields?: TaxProvidersFieldsCreateInputParam[];
483
- [key: `cf_${string}`]: unknown;
484
- }
485
- export interface ListInputParam {
486
- limit?: number;
487
- offset?: string;
488
- relationship?: RelationshipCustomerListInputParam;
489
- include_deleted?: boolean;
490
- id?: filter.String;
491
- first_name?: filter.String;
492
- last_name?: filter.String;
493
- email?: filter.String;
494
- company?: filter.String;
495
- phone?: filter.String;
496
- auto_collection?: filter.Enum;
497
- taxability?: filter.Enum;
498
- created_at?: filter.Timestamp;
499
- updated_at?: filter.Timestamp;
500
- offline_payment_method?: filter.Enum;
501
- auto_close_invoices?: filter.Boolean;
502
- channel?: filter.Enum;
503
- business_entity_id?: filter.String;
504
- 'sort_by[asc]'?: string;
505
- 'sort_by[desc]'?: string;
506
- [key: `cf_${string}`]: unknown;
507
- }
508
- export interface UpdateInputParam {
509
- first_name?: string;
510
- last_name?: string;
511
- email?: string;
512
- preferred_currency_code?: string;
513
- phone?: string;
514
- company?: string;
515
- auto_collection?: AutoCollection;
516
- allow_direct_debit?: boolean;
517
- net_term_days?: number;
518
- taxability?: Taxability;
519
- exemption_details?: any;
520
- customer_type?: CustomerType;
521
- client_profile_id?: string;
522
- taxjar_exemption_category?: TaxjarExemptionCategory;
523
- locale?: string;
524
- entity_code?: EntityCode;
525
- exempt_number?: string;
526
- offline_payment_method?: OfflinePaymentMethod;
527
- invoice_notes?: string;
528
- auto_close_invoices?: boolean;
529
- meta_data?: any;
530
- fraud_flag?: 'safe' | 'fraudulent';
531
- consolidated_invoicing?: boolean;
532
- tax_providers_fields?: TaxProvidersFieldsUpdateInputParam[];
533
- [key: `cf_${string}`]: unknown;
534
- }
535
- export interface UpdatePaymentMethodInputParam {
536
- payment_method?: PaymentMethodUpdatePaymentMethodInputParam;
537
- }
538
- export interface UpdateBillingInfoInputParam {
539
- vat_number?: string;
540
- vat_number_prefix?: string;
541
- entity_identifier_scheme?: string;
542
- entity_identifier_standard?: string;
543
- registered_for_gst?: boolean;
544
- business_customer_without_vat_number?: boolean;
545
- is_einvoice_enabled?: boolean;
546
- einvoicing_method?: EinvoicingMethod;
547
- billing_address?: BillingAddressUpdateBillingInfoInputParam;
548
- entity_identifiers?: EntityIdentifiersUpdateBillingInfoInputParam[];
549
- tax_providers_fields?: TaxProvidersFieldsUpdateBillingInfoInputParam[];
550
- }
551
- export interface ContactsForCustomerInputParam {
552
- limit?: number;
553
- offset?: string;
554
- }
555
- export interface AssignPaymentRoleInputParam {
556
- payment_source_id: string;
557
- role: Role;
558
- }
559
- export interface AddContactInputParam {
560
- contact?: ContactAddContactInputParam;
561
- }
562
- export interface UpdateContactInputParam {
563
- contact?: ContactUpdateContactInputParam;
564
- }
565
- export interface DeleteContactInputParam {
566
- contact?: ContactDeleteContactInputParam;
567
- }
568
- export interface AddPromotionalCreditsInputParam {
569
- amount: number;
570
- currency_code?: string;
571
- description: string;
572
- credit_type?: CreditType;
573
- reference?: string;
574
- }
575
- export interface DeductPromotionalCreditsInputParam {
576
- amount: number;
577
- currency_code?: string;
578
- description: string;
579
- credit_type?: CreditType;
580
- reference?: string;
581
- }
582
- export interface SetPromotionalCreditsInputParam {
583
- amount: number;
584
- currency_code?: string;
585
- description: string;
586
- credit_type?: CreditType;
587
- reference?: string;
588
- }
589
- export interface RecordExcessPaymentInputParam {
590
- comment?: string;
591
- transaction?: TransactionRecordExcessPaymentInputParam;
592
- }
593
- export interface CollectPaymentInputParam {
594
- amount?: number;
595
- payment_source_id?: string;
596
- token_id?: string;
597
- replace_primary_payment_source?: boolean;
598
- retain_payment_source?: boolean;
599
- payment_initiator?: PaymentInitiator;
600
- payment_method?: PaymentMethodCollectPaymentInputParam;
601
- card?: CardCollectPaymentInputParam;
602
- payment_intent?: PaymentIntentCollectPaymentInputParam;
603
- invoice_allocations?: InvoiceAllocationsCollectPaymentInputParam[];
604
- }
605
- export interface DeleteInputParam {
606
- delete_payment_method?: boolean;
607
- }
608
- export interface MoveInputParam {
609
- id_at_from_site: string;
610
- from_site: string;
611
- tax_providers_fields?: TaxProvidersFieldsMoveInputParam[];
612
- }
613
- export interface ChangeBillingDateInputParam {
614
- billing_date?: number;
615
- billing_month?: number;
616
- billing_date_mode?: BillingDateMode;
617
- billing_day_of_week?:
618
- | 'sunday'
619
- | 'monday'
620
- | 'tuesday'
621
- | 'wednesday'
622
- | 'thursday'
623
- | 'friday'
624
- | 'saturday';
625
- billing_day_of_week_mode?: BillingDayOfWeekMode;
626
- }
627
- export interface MergeInputParam {
628
- from_customer_id: string;
629
- to_customer_id: string;
630
- tax_providers_fields?: TaxProvidersFieldsMergeInputParam[];
631
- }
632
- export interface RelationshipsInputParam {
633
- parent_id?: string;
634
- payment_owner_id?: string;
635
- invoice_owner_id?: string;
636
- use_default_hierarchy_settings?: boolean;
637
- parent_account_access?: ParentAccountAccessRelationshipsInputParam;
638
- child_account_access?: ChildAccountAccessRelationshipsInputParam;
639
- }
640
- export interface HierarchyInputParam {
641
- hierarchy_operation_type:
642
- | 'complete_hierarchy'
643
- | 'subordinates'
644
- | 'path_to_root';
645
- }
646
- export interface UpdateHierarchySettingsInputParam {
647
- use_default_hierarchy_settings?: boolean;
648
- parent_account_access?: ParentAccountAccessUpdateHierarchySettingsInputParam;
649
- child_account_access?: ChildAccountAccessUpdateHierarchySettingsInputParam;
650
- }
651
- export interface BillingAddressCreateInputParam {
652
- first_name?: string;
653
- last_name?: string;
654
- email?: string;
655
- company?: string;
656
- phone?: string;
657
- line1?: string;
658
- line2?: string;
659
- line3?: string;
660
- city?: string;
661
- state_code?: string;
662
- state?: string;
663
- zip?: string;
664
- country?: string;
665
- validation_status?: ValidationStatus;
666
- }
667
- export interface PaymentMethodCreateInputParam {
668
- type?: Type;
669
- /**
670
- * @deprecated Please refer API docs to use other attributes
671
- */
672
- gateway?: Gateway;
673
- gateway_account_id?: string;
674
- reference_id?: string;
675
- tmp_token?: string;
676
- issuing_country?: string;
677
- additional_information?: any;
678
- }
679
- export interface BankAccountCreateInputParam {
680
- gateway_account_id?: string;
681
- iban?: string;
682
- first_name?: string;
683
- last_name?: string;
684
- company?: string;
685
- email?: string;
686
- phone?: string;
687
- bank_name?: string;
688
- account_number?: string;
689
- routing_number?: string;
690
- bank_code?: string;
691
- account_type?: AccountType;
692
- account_holder_type?: AccountHolderType;
693
- echeck_type?: EcheckType;
694
- issuing_country?: string;
695
- swedish_identity_number?: string;
696
- billing_address?: any;
697
- }
698
- export interface PaymentIntentCreateInputParam {
699
- id?: string;
700
- gateway_account_id?: string;
701
- gw_token?: string;
702
- payment_method_type?:
703
- | 'card'
704
- | 'ideal'
705
- | 'sofort'
706
- | 'bancontact'
707
- | 'google_pay'
708
- | 'dotpay'
709
- | 'giropay'
710
- | 'apple_pay'
711
- | 'upi'
712
- | 'netbanking_emandates'
713
- | 'paypal_express_checkout'
714
- | 'direct_debit'
715
- | 'boleto'
716
- | 'venmo'
717
- | 'amazon_payments'
718
- | 'pay_to'
719
- | 'faster_payments'
720
- | 'sepa_instant_transfer'
721
- | 'klarna_pay_now'
722
- | 'online_banking_poland';
723
- reference_id?: string;
724
- /**
725
- * @deprecated Please refer API docs to use other attributes
726
- */
727
- gw_payment_method_id?: string;
728
- additional_information?: any;
729
- }
730
- export interface CardCreateInputParam {
731
- /**
732
- * @deprecated Please refer API docs to use other attributes
733
- */
734
- gateway?: Gateway;
735
- gateway_account_id?: string;
736
- /**
737
- * @deprecated Please refer API docs to use other attributes
738
- */
739
- tmp_token?: string;
740
- first_name?: string;
741
- last_name?: string;
742
- number?: string;
743
- expiry_month?: number;
744
- expiry_year?: number;
745
- cvv?: string;
746
- billing_addr1?: string;
747
- billing_addr2?: string;
748
- billing_city?: string;
749
- billing_state_code?: string;
750
- billing_state?: string;
751
- billing_zip?: string;
752
- billing_country?: string;
753
- /**
754
- * @deprecated Please refer API docs to use other attributes
755
- */
756
- ip_address?: string;
757
- additional_information?: any;
758
- }
759
-
760
- export interface EntityIdentifiersCreateInputParam {
761
- id?: string;
762
- scheme?: string;
763
- value?: string;
764
- standard?: string;
765
- }
766
- export interface TaxProvidersFieldsCreateInputParam {
767
- provider_name?: string;
768
- field_id?: string;
769
- field_value?: string;
770
- }
771
- export interface RelationshipCustomerListInputParam {
772
- parent_id?: filter.String;
773
- payment_owner_id?: filter.String;
774
- invoice_owner_id?: filter.String;
775
- }
776
-
777
- export interface TaxProvidersFieldsUpdateInputParam {
778
- provider_name?: string;
779
- field_id?: string;
780
- field_value?: string;
781
- }
782
- export interface PaymentMethodUpdatePaymentMethodInputParam {
783
- type: Type;
784
- /**
785
- * @deprecated Please refer API docs to use other attributes
786
- */
787
- gateway?: Gateway;
788
- gateway_account_id?: string;
789
- reference_id?: string;
790
- tmp_token?: string;
791
- issuing_country?: string;
792
- additional_information?: any;
793
- }
794
-
795
- export interface BillingAddressUpdateBillingInfoInputParam {
796
- first_name?: string;
797
- last_name?: string;
798
- email?: string;
799
- company?: string;
800
- phone?: string;
801
- line1?: string;
802
- line2?: string;
803
- line3?: string;
804
- city?: string;
805
- state_code?: string;
806
- state?: string;
807
- zip?: string;
808
- country?: string;
809
- validation_status?: ValidationStatus;
810
- }
811
-
812
- export interface EntityIdentifiersUpdateBillingInfoInputParam {
813
- id?: string;
814
- scheme?: string;
815
- value?: string;
816
- operation?: Operation;
817
- standard?: string;
818
- }
819
- export interface TaxProvidersFieldsUpdateBillingInfoInputParam {
820
- provider_name?: string;
821
- field_id?: string;
822
- field_value?: string;
823
- }
824
- export interface ContactAddContactInputParam {
825
- id?: string;
826
- first_name?: string;
827
- last_name?: string;
828
- email: string;
829
- phone?: string;
830
- label?: string;
831
- enabled?: boolean;
832
- send_billing_email?: boolean;
833
- send_account_email?: boolean;
834
- }
835
-
836
- export interface ContactUpdateContactInputParam {
837
- id: string;
838
- first_name?: string;
839
- last_name?: string;
840
- email?: string;
841
- phone?: string;
842
- label?: string;
843
- enabled?: boolean;
844
- send_billing_email?: boolean;
845
- send_account_email?: boolean;
846
- }
847
-
848
- export interface ContactDeleteContactInputParam {
849
- id: string;
850
- }
851
-
852
- export interface TransactionRecordExcessPaymentInputParam {
853
- amount: number;
854
- currency_code?: string;
855
- date: number;
856
- payment_method: PaymentMethod;
857
- reference_number?: string;
858
- custom_payment_method_id?: string;
859
- }
860
-
861
- export interface PaymentMethodCollectPaymentInputParam {
862
- type?: Type;
863
- gateway_account_id?: string;
864
- reference_id?: string;
865
- tmp_token?: string;
866
- additional_information?: any;
867
- }
868
- export interface PaymentIntentCollectPaymentInputParam {
869
- id?: string;
870
- gateway_account_id?: string;
871
- gw_token?: string;
872
- payment_method_type?:
873
- | 'card'
874
- | 'ideal'
875
- | 'sofort'
876
- | 'bancontact'
877
- | 'google_pay'
878
- | 'dotpay'
879
- | 'giropay'
880
- | 'apple_pay'
881
- | 'upi'
882
- | 'netbanking_emandates'
883
- | 'paypal_express_checkout'
884
- | 'direct_debit'
885
- | 'boleto'
886
- | 'venmo'
887
- | 'amazon_payments'
888
- | 'pay_to'
889
- | 'faster_payments'
890
- | 'sepa_instant_transfer'
891
- | 'klarna_pay_now'
892
- | 'online_banking_poland';
893
- /**
894
- * @deprecated Please refer API docs to use other attributes
895
- */
896
- gw_payment_method_id?: string;
897
- reference_id?: string;
898
- additional_information?: any;
899
- }
900
- export interface CardCollectPaymentInputParam {
901
- gateway_account_id?: string;
902
- first_name?: string;
903
- last_name?: string;
904
- number?: string;
905
- expiry_month?: number;
906
- expiry_year?: number;
907
- cvv?: string;
908
- billing_addr1?: string;
909
- billing_addr2?: string;
910
- billing_city?: string;
911
- billing_state_code?: string;
912
- billing_state?: string;
913
- billing_zip?: string;
914
- billing_country?: string;
915
- additional_information?: any;
916
- }
917
-
918
- export interface InvoiceAllocationsCollectPaymentInputParam {
919
- invoice_id: string;
920
- allocation_amount?: number;
921
- }
922
- export interface TaxProvidersFieldsMoveInputParam {
923
- provider_name?: string;
924
- field_id?: string;
925
- field_value?: string;
926
- }
927
- export interface TaxProvidersFieldsMergeInputParam {
928
- provider_name?: string;
929
- field_id?: string;
930
- field_value?: string;
931
- }
932
- export interface ParentAccountAccessRelationshipsInputParam {
933
- portal_edit_child_subscriptions?: 'yes' | 'view_only' | 'no';
934
- portal_download_child_invoices?: 'yes' | 'view_only' | 'no';
935
- send_subscription_emails?: boolean;
936
- send_payment_emails?: boolean;
937
- send_invoice_emails?: boolean;
938
- }
939
- export interface ChildAccountAccessRelationshipsInputParam {
940
- portal_edit_subscriptions?: 'yes' | 'view_only';
941
- portal_download_invoices?: 'yes' | 'view_only' | 'no';
942
- send_subscription_emails?: boolean;
943
- send_payment_emails?: boolean;
944
- send_invoice_emails?: boolean;
945
- }
946
-
947
- export interface ParentAccountAccessUpdateHierarchySettingsInputParam {
948
- portal_edit_child_subscriptions?: 'yes' | 'view_only' | 'no';
949
- portal_download_child_invoices?: 'yes' | 'view_only' | 'no';
950
- send_subscription_emails?: boolean;
951
- send_payment_emails?: boolean;
952
- send_invoice_emails?: boolean;
953
- }
954
- export interface ChildAccountAccessUpdateHierarchySettingsInputParam {
955
- portal_edit_subscriptions?: 'yes' | 'view_only';
956
- portal_download_invoices?: 'yes' | 'view_only' | 'no';
957
- send_subscription_emails?: boolean;
958
- send_payment_emails?: boolean;
959
- send_invoice_emails?: boolean;
960
- }
961
- }
962
- }