chargebee 2.41.0 → 3.0.0-beta.2

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 (118) hide show
  1. package/CHANGELOG.md +11 -15
  2. package/LICENSE +1 -1
  3. package/README.md +90 -170
  4. package/cjs/RequestWrapper.js +84 -0
  5. package/cjs/asyncApiSupport.js +39 -0
  6. package/cjs/chargebee.cjs.js +13 -0
  7. package/cjs/chargebee.cjs.worker.js +9 -0
  8. package/cjs/chargebeeError.js +17 -0
  9. package/cjs/coreCommon.js +72 -0
  10. package/cjs/createChargebee.js +92 -0
  11. package/cjs/environment.js +18 -0
  12. package/cjs/filter.js +1 -0
  13. package/cjs/net/ClientInterface.js +40 -0
  14. package/cjs/net/FetchClient.js +86 -0
  15. package/cjs/net/NodeClient.js +61 -0
  16. package/cjs/package.json +1 -0
  17. package/cjs/resources/api_endpoints.js +1086 -0
  18. package/cjs/util.js +218 -0
  19. package/esm/RequestWrapper.js +80 -0
  20. package/esm/asyncApiSupport.js +35 -0
  21. package/esm/chargebee.esm.js +9 -0
  22. package/esm/chargebee.esm.worker.js +5 -0
  23. package/esm/chargebeeError.js +13 -0
  24. package/esm/coreCommon.js +67 -0
  25. package/esm/createChargebee.js +88 -0
  26. package/esm/environment.js +15 -0
  27. package/esm/filter.js +1 -0
  28. package/esm/net/ClientInterface.js +35 -0
  29. package/esm/net/FetchClient.js +81 -0
  30. package/esm/net/NodeClient.js +56 -0
  31. package/esm/package.json +1 -0
  32. package/esm/resources/api_endpoints.js +1083 -0
  33. package/esm/util.js +202 -0
  34. package/package.json +69 -38
  35. package/types/core.d.ts +558 -89
  36. package/types/index.d.ts +90 -55
  37. package/types/resources/Address.d.ts +57 -272
  38. package/types/resources/AdvanceInvoiceSchedule.d.ts +21 -94
  39. package/types/resources/AttachedItem.d.ts +91 -329
  40. package/types/resources/Attribute.d.ts +5 -5
  41. package/types/resources/BusinessEntity.d.ts +49 -69
  42. package/types/resources/BusinessEntityTransfer.d.ts +11 -17
  43. package/types/resources/Card.d.ts +146 -424
  44. package/types/resources/Comment.d.ts +72 -189
  45. package/types/resources/Contact.d.ts +12 -64
  46. package/types/resources/ContractTerm.d.ts +15 -96
  47. package/types/resources/Coupon.d.ts +282 -758
  48. package/types/resources/CouponCode.d.ts +56 -52
  49. package/types/resources/CouponSet.d.ts +92 -234
  50. package/types/resources/CreditNote.d.ts +588 -1758
  51. package/types/resources/CreditNoteEstimate.d.ts +131 -157
  52. package/types/resources/Currency.d.ts +75 -62
  53. package/types/resources/Customer.d.ts +892 -835
  54. package/types/resources/CustomerEntitlement.d.ts +24 -35
  55. package/types/resources/DifferentialPrice.d.ts +116 -314
  56. package/types/resources/Discount.d.ts +20 -125
  57. package/types/resources/Download.d.ts +6 -22
  58. package/types/resources/Entitlement.d.ts +51 -160
  59. package/types/resources/EntitlementOverride.d.ts +58 -139
  60. package/types/resources/Estimate.d.ts +1178 -527
  61. package/types/resources/Event.d.ts +67 -178
  62. package/types/resources/Export.d.ts +563 -723
  63. package/types/resources/Feature.d.ts +117 -433
  64. package/types/resources/GatewayErrorDetail.d.ts +16 -72
  65. package/types/resources/Gift.d.ts +265 -432
  66. package/types/resources/Hierarchy.d.ts +8 -36
  67. package/types/resources/HostedPage.d.ts +1017 -1153
  68. package/types/resources/ImpactedItem.d.ts +13 -50
  69. package/types/resources/ImpactedItemPrice.d.ts +13 -15
  70. package/types/resources/ImpactedSubscription.d.ts +13 -45
  71. package/types/resources/InAppSubscription.d.ts +93 -389
  72. package/types/resources/Installment.d.ts +35 -110
  73. package/types/resources/InstallmentConfig.d.ts +54 -155
  74. package/types/resources/InstallmentDetail.d.ts +19 -27
  75. package/types/resources/Invoice.d.ts +1574 -3157
  76. package/types/resources/InvoiceEstimate.d.ts +131 -161
  77. package/types/resources/Item.d.ts +133 -611
  78. package/types/resources/ItemEntitlement.d.ts +78 -215
  79. package/types/resources/ItemFamily.d.ts +69 -178
  80. package/types/resources/ItemPrice.d.ts +291 -1203
  81. package/types/resources/Metadata.d.ts +3 -5
  82. package/types/resources/Order.d.ts +538 -1471
  83. package/types/resources/PaymentIntent.d.ts +163 -347
  84. package/types/resources/PaymentReferenceNumber.d.ts +7 -29
  85. package/types/resources/PaymentSource.d.ts +476 -1272
  86. package/types/resources/PaymentVoucher.d.ts +87 -306
  87. package/types/resources/PortalSession.d.ts +71 -207
  88. package/types/resources/PriceVariant.d.ts +91 -279
  89. package/types/resources/PricingPageSession.d.ts +92 -41
  90. package/types/resources/PromotionalCredit.d.ts +90 -346
  91. package/types/resources/Purchase.d.ts +185 -315
  92. package/types/resources/Quote.d.ts +1406 -887
  93. package/types/resources/QuoteLineGroup.d.ts +125 -452
  94. package/types/resources/QuotedCharge.d.ts +45 -274
  95. package/types/resources/QuotedSubscription.d.ts +100 -488
  96. package/types/resources/Ramp.d.ts +230 -747
  97. package/types/resources/ResourceMigration.d.ts +25 -80
  98. package/types/resources/SiteMigrationDetail.d.ts +34 -112
  99. package/types/resources/Subscription.d.ts +2390 -4336
  100. package/types/resources/SubscriptionEntitlement.d.ts +59 -160
  101. package/types/resources/SubscriptionEstimate.d.ts +51 -75
  102. package/types/resources/TaxWithheld.d.ts +15 -40
  103. package/types/resources/ThirdPartyPaymentMethod.d.ts +7 -29
  104. package/types/resources/TimeMachine.d.ts +43 -97
  105. package/types/resources/Token.d.ts +15 -85
  106. package/types/resources/Transaction.d.ts +276 -911
  107. package/types/resources/UnbilledCharge.d.ts +189 -164
  108. package/types/resources/Usage.d.ts +89 -279
  109. package/types/resources/VirtualBankAccount.d.ts +103 -255
  110. package/types/resources/filter.d.ts +52 -0
  111. package/.github/ISSUE_TEMPLATE/bug_report.yml +0 -81
  112. package/.github/ISSUE_TEMPLATE/config.yml +0 -6
  113. package/.github/ISSUE_TEMPLATE/feature_request.yml +0 -34
  114. package/.github/PULL_REQUEST_TEMPLATE.md +0 -8
  115. package/lib/chargebee.js +0 -512
  116. package/lib/resources/api_endpoints.js +0 -2935
  117. package/types/resources/NonSubscription.d.ts +0 -30
  118. package/types/resources/Session.d.ts +0 -41
@@ -1,905 +1,962 @@
1
1
  ///<reference path='./../core.d.ts'/>
2
2
  ///<reference path='./../index.d.ts'/>
3
+ ///<reference path='./filter.d.ts'/>
3
4
  declare module 'chargebee' {
4
5
  export interface Customer {
5
- [key : string] : any;
6
- /**
7
- * @description Identifier of the customer.
8
-
9
- */
10
-
11
- id:string;
12
-
13
- /**
14
- * @description First name of the customer
15
-
16
- */
17
-
18
- first_name?:string;
19
-
20
- /**
21
- * @description Last name of the customer
22
-
23
- */
24
-
25
- last_name?:string;
26
-
27
- /**
28
- * @description Email of the customer. Configured email notifications will be sent to this email.
29
-
30
- */
31
-
32
- email?:string;
33
-
34
- phone?:string;
35
-
36
- company?:string;
37
-
38
- vat_number?:string;
39
-
40
- auto_collection:AutoCollection;
41
-
42
- offline_payment_method?:OfflinePaymentMethod;
43
-
44
- net_term_days:number;
45
-
46
- vat_number_validated_time?:number;
47
-
48
- vat_number_status?:'valid' | 'invalid' | 'not_validated' | 'undetermined';
49
-
50
- allow_direct_debit:boolean;
51
-
52
- is_location_valid?:boolean;
53
-
54
- created_at:number;
55
-
56
- created_from_ip?:string;
57
-
58
- exemption_details?:any[];
59
-
60
- taxability?:Taxability;
61
-
62
- entity_code?:EntityCode;
63
-
64
- exempt_number?:string;
65
-
66
- resource_version?:number;
67
-
68
- updated_at?:number;
69
-
70
- locale?:string;
71
-
72
- billing_date?:number;
73
-
74
- billing_month?:number;
75
-
76
- billing_date_mode?:BillingDateMode;
77
-
78
- billing_day_of_week?:'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday';
79
-
80
- billing_day_of_week_mode?:BillingDayOfWeekMode;
81
-
82
- pii_cleared?:'active' | 'scheduled_for_clear' | 'cleared';
83
-
84
- auto_close_invoices?:boolean;
85
-
86
- channel?:Channel;
87
-
88
- active_id?:string;
89
-
90
- card_status?:'no_card' | 'valid' | 'expiring' | 'expired' | 'pending_verification' | 'invalid';
91
-
92
- fraud_flag?:'safe' | 'suspicious' | 'fraudulent';
93
-
94
- primary_payment_source_id?:string;
95
-
96
- backup_payment_source_id?:string;
97
-
98
- billing_address?:Customer.BillingAddress;
99
-
100
- referral_urls?:Customer.ReferralUrl[];
101
-
102
- contacts?:Customer.Contact[];
103
-
104
- payment_method?:Customer.PaymentMethod;
105
-
106
- invoice_notes?:string;
107
-
108
- business_entity_id?:string;
109
-
110
- preferred_currency_code?:string;
111
-
112
- promotional_credits:number;
113
-
114
- unbilled_charges:number;
115
-
116
- refundable_credits:number;
117
-
118
- excess_payments:number;
119
-
120
- balances?:Customer.Balance[];
121
-
122
- entity_identifiers?:Customer.EntityIdentifier[];
123
-
124
- tax_providers_fields?:Customer.TaxProvidersField[];
125
-
126
- is_einvoice_enabled?:boolean;
127
-
128
- einvoicing_method?:EinvoicingMethod;
129
-
130
- meta_data?:object;
131
-
132
- deleted:boolean;
133
-
134
- registered_for_gst?:boolean;
135
-
136
- consolidated_invoicing?:boolean;
137
-
138
- customer_type?:CustomerType;
139
-
140
- business_customer_without_vat_number?:boolean;
141
-
142
- client_profile_id?:string;
143
-
144
- relationship?:Customer.Relationship;
145
-
146
- use_default_hierarchy_settings?:boolean;
147
-
148
- parent_account_access?:Customer.ParentAccountAccess;
149
-
150
- child_account_access?:Customer.ChildAccountAccess;
151
-
152
- vat_number_prefix?:string;
153
-
154
- entity_identifier_scheme?:string;
155
-
156
- entity_identifier_standard?:string;
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;
157
86
  }
87
+
158
88
  export namespace Customer {
159
- export class CustomerResource {
160
- create(input?:CreateInputParam):ChargebeeRequest<CreateResponse>;
161
-
162
- list(input?:ListInputParam):ChargebeeRequest<ListResponse>;
163
-
164
- retrieve(customer_id:string):ChargebeeRequest<RetrieveResponse>;
165
-
166
- update(customer_id:string, input?:UpdateInputParam):ChargebeeRequest<UpdateResponse>;
167
-
168
- update_payment_method(customer_id:string, input:UpdatePaymentMethodInputParam):ChargebeeRequest<UpdatePaymentMethodResponse>;
169
-
170
- update_billing_info(customer_id:string, input?:UpdateBillingInfoInputParam):ChargebeeRequest<UpdateBillingInfoResponse>;
171
-
172
- contacts_for_customer(customer_id:string, input?:ContactsForCustomerInputParam):ChargebeeRequest<ContactsForCustomerResponse>;
173
-
174
- assign_payment_role(customer_id:string, input:AssignPaymentRoleInputParam):ChargebeeRequest<AssignPaymentRoleResponse>;
175
-
176
- add_contact(customer_id:string, input:AddContactInputParam):ChargebeeRequest<AddContactResponse>;
177
-
178
- update_contact(customer_id:string, input:UpdateContactInputParam):ChargebeeRequest<UpdateContactResponse>;
179
-
180
- delete_contact(customer_id:string, input:DeleteContactInputParam):ChargebeeRequest<DeleteContactResponse>;
181
-
182
- add_promotional_credits(customer_id:string, input:AddPromotionalCreditsInputParam):ChargebeeRequest<AddPromotionalCreditsResponse>;
183
-
184
- deduct_promotional_credits(customer_id:string, input:DeductPromotionalCreditsInputParam):ChargebeeRequest<DeductPromotionalCreditsResponse>;
185
-
186
- set_promotional_credits(customer_id:string, input:SetPromotionalCreditsInputParam):ChargebeeRequest<SetPromotionalCreditsResponse>;
187
-
188
- record_excess_payment(customer_id:string, input:RecordExcessPaymentInputParam):ChargebeeRequest<RecordExcessPaymentResponse>;
189
-
190
- collect_payment(customer_id:string, input:CollectPaymentInputParam):ChargebeeRequest<CollectPaymentResponse>;
191
-
192
- delete(customer_id:string, input?:DeleteInputParam):ChargebeeRequest<DeleteResponse>;
193
-
194
- move(input:MoveInputParam):ChargebeeRequest<MoveResponse>;
195
-
196
- change_billing_date(customer_id:string, input?:ChangeBillingDateInputParam):ChargebeeRequest<ChangeBillingDateResponse>;
197
-
198
- merge(input:MergeInputParam):ChargebeeRequest<MergeResponse>;
199
-
200
- clear_personal_data(customer_id:string):ChargebeeRequest<ClearPersonalDataResponse>;
201
-
202
- relationships(customer_id:string, input?:RelationshipsInputParam):ChargebeeRequest<RelationshipsResponse>;
203
-
204
- delete_relationship(customer_id:string):ChargebeeRequest<DeleteRelationshipResponse>;
205
-
206
- hierarchy(customer_id:string, input:HierarchyInputParam):ChargebeeRequest<HierarchyResponse>;
207
-
208
- update_hierarchy_settings(customer_id:string, input?:UpdateHierarchySettingsInputParam):ChargebeeRequest<UpdateHierarchySettingsResponse>;
209
- }
210
- export interface CreateResponse {
211
- customer:Customer;
212
-
213
- card?:Card;
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>>;
214
232
  }
215
- export interface CreateInputParam {
216
- [key : string] : any;
217
- card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway?:Gateway,gateway_account_id?:string,ip_address?:string,last_name?:string,number?:string,tmp_token?:string};
218
-
219
- bank_account?:{account_holder_type?:AccountHolderType,account_number?:string,account_type?:AccountType,bank_code?:string,bank_name?:string,billing_address?:object,company?:string,echeck_type?:EcheckType,email?:string,first_name?:string,gateway_account_id?:string,iban?:string,issuing_country?:string,last_name?:string,phone?:string,routing_number?:string,swedish_identity_number?:string};
220
-
221
- payment_method?:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type?:Type};
222
-
223
- payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
224
-
225
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
226
-
227
- entity_identifiers?:{id?:string,scheme?:string,standard?:string,value?:string}[];
228
-
229
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
230
-
231
- id?:string;
232
-
233
- first_name?:string;
234
-
235
- last_name?:string;
236
-
237
- email?:string;
238
-
239
- preferred_currency_code?:string;
240
-
241
- phone?:string;
242
-
243
- company?:string;
244
-
245
- auto_collection?:AutoCollection;
246
-
247
- net_term_days?:number;
248
-
249
- allow_direct_debit?:boolean;
250
-
251
- vat_number?:string;
252
-
253
- vat_number_prefix?:string;
254
-
255
- entity_identifier_scheme?:string;
256
-
257
- entity_identifier_standard?:string;
258
-
259
- registered_for_gst?:boolean;
260
-
261
- is_einvoice_enabled?:boolean;
262
-
263
- einvoicing_method?:EinvoicingMethod;
264
-
265
- taxability?:Taxability;
266
-
267
- exemption_details?:any[];
268
-
269
- customer_type?:CustomerType;
270
-
271
- client_profile_id?:string;
272
-
273
- taxjar_exemption_category?:TaxjarExemptionCategory;
274
-
275
- business_customer_without_vat_number?:boolean;
276
-
277
- locale?:string;
278
-
279
- entity_code?:EntityCode;
280
-
281
- exempt_number?:string;
282
-
283
- meta_data?:object;
284
-
285
- offline_payment_method?:OfflinePaymentMethod;
286
-
287
- auto_close_invoices?:boolean;
288
-
289
- consolidated_invoicing?:boolean;
290
-
291
- token_id?:string;
292
-
293
- business_entity_id?:string;
294
-
295
- created_from_ip?:string;
296
-
297
- invoice_notes?:string;
298
- }
299
- export interface ListResponse {
300
- list:{customer:Customer,card?:Card}[];
301
-
302
- next_offset?:string;
233
+
234
+ export interface CreateResponse {
235
+ customer: Customer;
236
+ card?: Card;
303
237
  }
304
- export interface ListInputParam {
305
- [key : string]: any;
306
- /**
307
- * @description The number of resources to be returned.
308
238
 
309
- */
310
-
311
- limit?:number;
312
-
313
- /**
314
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
239
+ export interface ListResponse {
240
+ list: { customer: Customer; card?: Card }[];
241
+ next_offset?: string;
242
+ }
315
243
 
316
- */
317
-
318
- offset?:string;
319
-
320
- /**
321
- * @description Parameters for relationship
244
+ export interface RetrieveResponse {
245
+ customer: Customer;
246
+ card?: Card;
247
+ }
322
248
 
323
- */
324
-
325
- relationship?:{invoice_owner_id?:{is?:string,is_not?:string,starts_with?:string},parent_id?:{is?:string,is_not?:string,starts_with?:string},payment_owner_id?:{is?:string,is_not?:string,starts_with?:string}};
326
-
327
- /**
328
- * @description Indicates whether to include deleted objects in the list. The deleted objects have the attribute \&#x60;deleted\&#x60; as \&#x60;true\&#x60;.
329
-
330
- */
331
-
332
- include_deleted?:boolean;
333
-
334
- include_deprecated?:boolean;
335
-
336
- /**
337
- * @description Identifier of the customer.
249
+ export interface UpdateResponse {
250
+ customer: Customer;
251
+ card?: Card;
252
+ }
338
253
 
339
- */
340
-
341
- id?:{in?:string,is?:string,is_not?:string,not_in?:string,starts_with?:string};
342
-
343
- /**
344
- * @description First name of the customer
254
+ export interface UpdatePaymentMethodResponse {
255
+ customer: Customer;
256
+ card?: Card;
257
+ }
345
258
 
346
- */
347
-
348
- first_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
349
-
350
- /**
351
- * @description Last name of the customer
259
+ export interface UpdateBillingInfoResponse {
260
+ customer: Customer;
261
+ card?: Card;
262
+ }
352
263
 
353
- */
354
-
355
- last_name?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
356
-
357
- /**
358
- * @description Email of the customer. Configured email notifications will be sent to this email.
264
+ export interface ContactsForCustomerResponse {
265
+ list: { contact: Contact }[];
266
+ next_offset?: string;
267
+ }
359
268
 
360
- */
361
-
362
- email?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
363
-
364
- /**
365
- * @description Company name of the customer.
269
+ export interface AssignPaymentRoleResponse {
270
+ customer: Customer;
271
+ payment_source: PaymentSource;
272
+ }
366
273
 
367
- */
368
-
369
- company?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
370
-
371
- /**
372
- * @description Phone number of the customer
274
+ export interface AddContactResponse {
275
+ customer: Customer;
276
+ card?: Card;
277
+ }
373
278
 
374
- */
375
-
376
- phone?:{is?:string,is_not?:string,is_present?:'true' | 'false',starts_with?:string};
377
-
378
- /**
379
- * @description Whether payments needs to be collected automatically for this customer
279
+ export interface UpdateContactResponse {
280
+ customer: Customer;
281
+ card?: Card;
282
+ }
380
283
 
381
- */
382
-
383
- auto_collection?:{in?:string,is?:'on' | 'off',is_not?:'on' | 'off',not_in?:string};
384
-
385
- /**
386
- * @description Specifies if the customer is liable for tax
284
+ export interface DeleteContactResponse {
285
+ customer: Customer;
286
+ card?: Card;
287
+ }
387
288
 
388
- */
389
-
390
- taxability?:{in?:string,is?:'taxable' | 'exempt',is_not?:'taxable' | 'exempt',not_in?:string};
391
-
392
- /**
393
- * @description Timestamp indicating when this customer resource is created.
289
+ export interface AddPromotionalCreditsResponse {
290
+ customer: Customer;
291
+ }
394
292
 
395
- */
396
-
397
- created_at?:{after?:string,before?:string,between?:string,on?:string};
398
-
399
- /**
400
- * @description To filter based on &#x60;updated_at&#x60;. This attribute will be present only if the resource has been updated after 2016-09-28. It is advisable when using this filter, to pass the &#x60;sort_by&#x60; input parameter as &#x60;updated_at&#x60; for a faster response.
293
+ export interface DeductPromotionalCreditsResponse {
294
+ customer: Customer;
295
+ }
401
296
 
402
- */
403
-
404
- updated_at?:{after?:string,before?:string,between?:string,on?:string};
405
-
406
- /**
407
- * @description The preferred offline payment method for the customer.
297
+ export interface SetPromotionalCreditsResponse {
298
+ customer: Customer;
299
+ }
408
300
 
409
- */
410
-
411
- offline_payment_method?:{in?:string,is?:'no_preference' | 'cash' | 'check' | 'bank_transfer' | 'ach_credit' | 'sepa_credit' | 'boleto' | 'us_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'uk_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'custom',is_not?:'no_preference' | 'cash' | 'check' | 'bank_transfer' | 'ach_credit' | 'sepa_credit' | 'boleto' | 'us_automated_bank_transfer' | 'eu_automated_bank_transfer' | 'uk_automated_bank_transfer' | 'jp_automated_bank_transfer' | 'mx_automated_bank_transfer' | 'custom',not_in?:string};
412
-
413
- /**
414
- * @description Override for this customer, the [site-level setting](https://www.chargebee.com/docs/2.0/metered_billing.html#configuring-metered-billing) for auto-closing invoices. Only applicable when auto-closing invoices has been enabled for the site. This attribute is also available at the [subscription level](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_auto_close_invoices) which takes precedence.
301
+ export interface RecordExcessPaymentResponse {
302
+ customer: Customer;
303
+ transaction: Transaction;
304
+ }
415
305
 
416
- */
417
-
418
- auto_close_invoices?:{is?:'true' | 'false'};
419
-
420
- /**
421
- * @description The subscription channel this object originated from and is maintained in.
306
+ export interface CollectPaymentResponse {
307
+ customer: Customer;
308
+ transaction: Transaction;
309
+ }
422
310
 
423
- */
424
-
425
- channel?:{in?:string,is?:'web' | 'app_store' | 'play_store',is_not?:'web' | 'app_store' | 'play_store',not_in?:string};
426
-
427
- /**
428
- * @description The unique ID of the [business entity](/docs/api?prod_cat_ver&#x3D;2#mbe) of this subscription. This is always the same as the [business entity](/docs/api/subscriptions?prod_cat_ver&#x3D;2#subscription_customer_id) of the customer.
429
- The ID of the business entity created for the site. For Product Catalog 1.0, all the site data is tied to this business entity.
430
- **Note**
311
+ export interface DeleteResponse {
312
+ customer: Customer;
313
+ card?: Card;
314
+ }
431
315
 
432
- [Multiple Business Entities](/docs/api?prod_cat_ver&#x3D;2#mbe) is a feature available only on Product Catalog 2.0.
316
+ export interface MoveResponse {
317
+ resource_migration: ResourceMigration;
318
+ }
433
319
 
434
- */
435
-
436
- business_entity_id?:{is?:string};
437
-
438
- sort_by?:{asc?:'created_at' | 'updated_at',desc?:'created_at' | 'updated_at'};
320
+ export interface ChangeBillingDateResponse {
321
+ customer: Customer;
439
322
  }
440
- export interface RetrieveResponse {
441
- customer:Customer;
442
-
443
- card?:Card;
323
+
324
+ export interface MergeResponse {
325
+ customer: Customer;
444
326
  }
445
-
446
- export interface UpdateResponse {
447
- customer:Customer;
448
-
449
- card?:Card;
327
+
328
+ export interface ClearPersonalDataResponse {
329
+ customer: Customer;
450
330
  }
451
- export interface UpdateInputParam {
452
- [key : string] : any;
453
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
454
-
455
- first_name?:string;
456
-
457
- last_name?:string;
458
-
459
- email?:string;
460
-
461
- preferred_currency_code?:string;
462
-
463
- phone?:string;
464
-
465
- company?:string;
466
-
467
- auto_collection?:AutoCollection;
468
-
469
- allow_direct_debit?:boolean;
470
-
471
- net_term_days?:number;
472
-
473
- taxability?:Taxability;
474
-
475
- exemption_details?:any[];
476
-
477
- customer_type?:CustomerType;
478
-
479
- client_profile_id?:string;
480
-
481
- taxjar_exemption_category?:TaxjarExemptionCategory;
482
-
483
- locale?:string;
484
-
485
- entity_code?:EntityCode;
486
-
487
- exempt_number?:string;
488
-
489
- offline_payment_method?:OfflinePaymentMethod;
490
-
491
- invoice_notes?:string;
492
-
493
- auto_close_invoices?:boolean;
494
-
495
- meta_data?:object;
496
-
497
- fraud_flag?:'safe' | 'fraudulent';
498
-
499
- consolidated_invoicing?:boolean;
500
- }
501
- export interface UpdatePaymentMethodResponse {
502
- customer:Customer;
503
-
504
- card?:Card;
331
+
332
+ export interface RelationshipsResponse {
333
+ customer: Customer;
505
334
  }
506
- export interface UpdatePaymentMethodInputParam {
507
-
508
- payment_method:{additional_information?:object,gateway?:Gateway,gateway_account_id?:string,issuing_country?:string,reference_id?:string,tmp_token?:string,type:Type};
335
+
336
+ export interface DeleteRelationshipResponse {
337
+ customer: Customer;
509
338
  }
510
- export interface UpdateBillingInfoResponse {
511
- customer:Customer;
512
-
513
- card?:Card;
339
+
340
+ export interface HierarchyResponse {
341
+ hierarchies: Hierarchy[];
514
342
  }
515
- export interface UpdateBillingInfoInputParam {
516
-
517
- billing_address?:{city?:string,company?:string,country?:string,email?:string,first_name?:string,last_name?:string,line1?:string,line2?:string,line3?:string,phone?:string,state?:string,state_code?:string,validation_status?:ValidationStatus,zip?:string};
518
-
519
- entity_identifiers?:{id?:string,operation?:Operation,scheme?:string,standard?:string,value?:string}[];
520
-
521
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
522
-
523
- vat_number?:string;
524
-
525
- vat_number_prefix?:string;
526
-
527
- entity_identifier_scheme?:string;
528
-
529
- entity_identifier_standard?:string;
530
-
531
- registered_for_gst?:boolean;
532
-
533
- business_customer_without_vat_number?:boolean;
534
-
535
- is_einvoice_enabled?:boolean;
536
-
537
- einvoicing_method?:EinvoicingMethod;
538
- }
539
- export interface ContactsForCustomerResponse {
540
- list:{contact:Contact}[];
541
-
542
- next_offset?:string;
343
+
344
+ export interface UpdateHierarchySettingsResponse {
345
+ customer: Customer;
543
346
  }
544
- export interface ContactsForCustomerInputParam {
545
- [key : string]: any;
546
- /**
547
- * @description The number of resources to be returned.
548
347
 
549
- */
550
-
551
- limit?:number;
552
-
553
- /**
554
- * @description Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set \&#x60;offset\&#x60; to the value of \&#x60;next_offset\&#x60; obtained in the previous iteration of the API call.
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
+ //---------------
555
437
 
556
- */
557
-
558
- offset?:string;
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: string]: unknown;
559
484
  }
560
- export interface AssignPaymentRoleResponse {
561
- customer:Customer;
562
-
563
- payment_source:PaymentSource;
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: string]: unknown;
564
507
  }
565
- export interface AssignPaymentRoleInputParam {
566
-
567
- payment_source_id:string;
568
-
569
- role:Role;
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: string]: unknown;
570
534
  }
571
- export interface AddContactResponse {
572
- customer:Customer;
573
-
574
- card?:Card;
535
+ export interface UpdatePaymentMethodInputParam {
536
+ payment_method?: PaymentMethodUpdatePaymentMethodInputParam;
575
537
  }
576
- export interface AddContactInputParam {
577
-
578
- contact:{email:string,enabled?:boolean,first_name?:string,id?:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
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[];
579
550
  }
580
- export interface UpdateContactResponse {
581
- customer:Customer;
582
-
583
- card?:Card;
551
+ export interface ContactsForCustomerInputParam {
552
+ limit?: number;
553
+ offset?: string;
584
554
  }
585
- export interface UpdateContactInputParam {
586
-
587
- contact:{email?:string,enabled?:boolean,first_name?:string,id:string,label?:string,last_name?:string,phone?:string,send_account_email?:boolean,send_billing_email?:boolean};
555
+ export interface AssignPaymentRoleInputParam {
556
+ payment_source_id: string;
557
+ role: Role;
588
558
  }
589
- export interface DeleteContactResponse {
590
- customer:Customer;
591
-
592
- card?:Card;
559
+ export interface AddContactInputParam {
560
+ contact?: ContactAddContactInputParam;
593
561
  }
594
- export interface DeleteContactInputParam {
595
-
596
- contact:{id:string};
562
+ export interface UpdateContactInputParam {
563
+ contact?: ContactUpdateContactInputParam;
597
564
  }
598
- export interface AddPromotionalCreditsResponse {
599
- customer:Customer;
565
+ export interface DeleteContactInputParam {
566
+ contact?: ContactDeleteContactInputParam;
600
567
  }
601
568
  export interface AddPromotionalCreditsInputParam {
602
-
603
- amount:number;
604
-
605
- currency_code?:string;
606
-
607
- description:string;
608
-
609
- credit_type?:CreditType;
610
-
611
- reference?:string;
612
- }
613
- export interface DeductPromotionalCreditsResponse {
614
- customer:Customer;
569
+ amount: number;
570
+ currency_code?: string;
571
+ description: string;
572
+ credit_type?: CreditType;
573
+ reference?: string;
615
574
  }
616
575
  export interface DeductPromotionalCreditsInputParam {
617
-
618
- amount:number;
619
-
620
- currency_code?:string;
621
-
622
- description:string;
623
-
624
- credit_type?:CreditType;
625
-
626
- reference?:string;
627
- }
628
- export interface SetPromotionalCreditsResponse {
629
- customer:Customer;
576
+ amount: number;
577
+ currency_code?: string;
578
+ description: string;
579
+ credit_type?: CreditType;
580
+ reference?: string;
630
581
  }
631
582
  export interface SetPromotionalCreditsInputParam {
632
-
633
- amount:number;
634
-
635
- currency_code?:string;
636
-
637
- description:string;
638
-
639
- credit_type?:CreditType;
640
-
641
- reference?:string;
642
- }
643
- export interface RecordExcessPaymentResponse {
644
- customer:Customer;
645
-
646
- transaction:Transaction;
583
+ amount: number;
584
+ currency_code?: string;
585
+ description: string;
586
+ credit_type?: CreditType;
587
+ reference?: string;
647
588
  }
648
589
  export interface RecordExcessPaymentInputParam {
649
-
650
- transaction:{amount:number,currency_code?:string,custom_payment_method_id?:string,date:number,payment_method:PaymentMethod,reference_number?:string};
651
-
652
- comment?:string;
653
- }
654
- export interface CollectPaymentResponse {
655
- customer:Customer;
656
-
657
- transaction:Transaction;
590
+ comment?: string;
591
+ transaction?: TransactionRecordExcessPaymentInputParam;
658
592
  }
659
593
  export interface CollectPaymentInputParam {
660
-
661
- payment_method?:{additional_information?:object,gateway_account_id?:string,reference_id?:string,tmp_token?:string,type?:Type};
662
-
663
- card?:{additional_information?:object,billing_addr1?:string,billing_addr2?:string,billing_city?:string,billing_country?:string,billing_state?:string,billing_state_code?:string,billing_zip?:string,cvv?:string,expiry_month?:number,expiry_year?:number,first_name?:string,gateway_account_id?:string,last_name?:string,number?:string};
664
-
665
- payment_intent?:{additional_information?:object,gateway_account_id?:string,gw_payment_method_id?:string,gw_token?:string,id?:string,payment_method_type?:'card' | 'ideal' | 'sofort' | 'bancontact' | 'google_pay' | 'dotpay' | 'giropay' | 'apple_pay' | 'upi' | 'netbanking_emandates' | 'paypal_express_checkout' | 'direct_debit' | 'boleto' | 'venmo' | 'amazon_payments' | 'pay_to' | 'faster_payments' | 'sepa_instant_transfer' | 'klarna_pay_now' | 'online_banking_poland',reference_id?:string};
666
-
667
- invoice_allocations:{allocation_amount?:number,invoice_id:string}[];
668
-
669
- amount?:number;
670
-
671
- payment_source_id?:string;
672
-
673
- token_id?:string;
674
-
675
- replace_primary_payment_source?:boolean;
676
-
677
- retain_payment_source?:boolean;
678
-
679
- payment_initiator?:PaymentInitiator;
680
- }
681
- export interface DeleteResponse {
682
- customer:Customer;
683
-
684
- card?:Card;
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[];
685
604
  }
686
605
  export interface DeleteInputParam {
687
-
688
- delete_payment_method?:boolean;
689
- }
690
- export interface MoveResponse {
691
- resource_migration:ResourceMigration;
606
+ delete_payment_method?: boolean;
692
607
  }
693
608
  export interface MoveInputParam {
694
-
695
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
696
-
697
- id_at_from_site:string;
698
-
699
- from_site:string;
700
- }
701
- export interface ChangeBillingDateResponse {
702
- customer:Customer;
609
+ id_at_from_site: string;
610
+ from_site: string;
611
+ tax_providers_fields?: TaxProvidersFieldsMoveInputParam[];
703
612
  }
704
613
  export interface ChangeBillingDateInputParam {
705
-
706
- billing_date?:number;
707
-
708
- billing_month?:number;
709
-
710
- billing_date_mode?:BillingDateMode;
711
-
712
- billing_day_of_week?:'sunday' | 'monday' | 'tuesday' | 'wednesday' | 'thursday' | 'friday' | 'saturday';
713
-
714
- billing_day_of_week_mode?:BillingDayOfWeekMode;
715
- }
716
- export interface MergeResponse {
717
- customer:Customer;
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;
718
626
  }
719
627
  export interface MergeInputParam {
720
-
721
- tax_providers_fields?:{field_id?:string,field_value?:string,provider_name?:string}[];
722
-
723
- from_customer_id:string;
724
-
725
- to_customer_id:string;
726
- }
727
- export interface ClearPersonalDataResponse {
728
- customer:Customer;
729
- }
730
-
731
- export interface RelationshipsResponse {
732
- customer:Customer;
628
+ from_customer_id: string;
629
+ to_customer_id: string;
630
+ tax_providers_fields?: TaxProvidersFieldsMergeInputParam[];
733
631
  }
734
632
  export interface RelationshipsInputParam {
735
-
736
- parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
737
-
738
- child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
739
-
740
- parent_id?:string;
741
-
742
- payment_owner_id?:string;
743
-
744
- invoice_owner_id?:string;
745
-
746
- use_default_hierarchy_settings?:boolean;
747
- }
748
- export interface DeleteRelationshipResponse {
749
- customer:Customer;
750
- }
751
-
752
- export interface HierarchyResponse {
753
- hierarchies:Hierarchy[];
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;
754
639
  }
755
640
  export interface HierarchyInputParam {
756
-
757
- hierarchy_operation_type:'complete_hierarchy' | 'subordinates' | 'path_to_root';
758
- }
759
- export interface UpdateHierarchySettingsResponse {
760
- customer:Customer;
641
+ hierarchy_operation_type:
642
+ | 'complete_hierarchy'
643
+ | 'subordinates'
644
+ | 'path_to_root';
761
645
  }
762
646
  export interface UpdateHierarchySettingsInputParam {
763
-
764
- parent_account_access?:{portal_download_child_invoices?:'yes' | 'view_only' | 'no',portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
765
-
766
- child_account_access?:{portal_download_invoices?:'yes' | 'view_only' | 'no',portal_edit_subscriptions?:'yes' | 'view_only',send_invoice_emails?:boolean,send_payment_emails?:boolean,send_subscription_emails?:boolean};
767
-
768
- use_default_hierarchy_settings?:boolean;
769
- }
770
- export interface BillingAddress {
771
- first_name?:string;
772
-
773
- last_name?:string;
774
-
775
- email?:string;
776
-
777
- company?:string;
778
-
779
- phone?:string;
780
-
781
- line1?:string;
782
-
783
- line2?:string;
784
-
785
- line3?:string;
786
-
787
- city?:string;
788
-
789
- state_code?:string;
790
-
791
- state?:string;
792
-
793
- country?:string;
794
-
795
- zip?:string;
796
-
797
- validation_status?:ValidationStatus;
798
- }
799
- export interface ReferralUrl {
800
- external_customer_id?:string;
801
-
802
- referral_sharing_url:string;
803
-
804
- created_at:number;
805
-
806
- updated_at:number;
807
-
808
- referral_campaign_id:string;
809
-
810
- referral_account_id:string;
811
-
812
- referral_external_campaign_id?:string;
813
-
814
- referral_system:'referral_candy' | 'referral_saasquatch' | 'friendbuy';
815
- }
816
- export interface Contact {
817
- id:string;
818
-
819
- first_name?:string;
820
-
821
- last_name?:string;
822
-
823
- email:string;
824
-
825
- phone?:string;
826
-
827
- label?:string;
828
-
829
- enabled:boolean;
830
-
831
- send_account_email:boolean;
832
-
833
- send_billing_email:boolean;
834
- }
835
- export interface PaymentMethod {
836
- type:Type;
837
-
838
- gateway:Gateway;
839
-
840
- gateway_account_id?:string;
841
-
842
- status:'valid' | 'expiring' | 'expired' | 'invalid' | 'pending_verification';
843
-
844
- reference_id:string;
845
- }
846
- export interface Balance {
847
- promotional_credits:number;
848
-
849
- excess_payments:number;
850
-
851
- refundable_credits:number;
852
-
853
- unbilled_charges:number;
854
-
855
- currency_code:string;
856
-
857
- balance_currency_code:string;
858
- }
859
- export interface EntityIdentifier {
860
- id:string;
861
-
862
- value?:string;
863
-
864
- scheme:string;
865
-
866
- standard?:string;
867
- }
868
- export interface TaxProvidersField {
869
- provider_name:string;
870
-
871
- field_id:string;
872
-
873
- field_value:string;
874
- }
875
- export interface Relationship {
876
- parent_id?:string;
877
-
878
- payment_owner_id:string;
879
-
880
- invoice_owner_id:string;
881
- }
882
- export interface ParentAccountAccess {
883
- portal_edit_child_subscriptions?:'yes' | 'view_only' | 'no';
884
-
885
- portal_download_child_invoices?:'yes' | 'view_only' | 'no';
886
-
887
- send_subscription_emails:boolean;
888
-
889
- send_invoice_emails:boolean;
890
-
891
- send_payment_emails:boolean;
892
- }
893
- export interface ChildAccountAccess {
894
- portal_edit_subscriptions?:'yes' | 'view_only';
895
-
896
- portal_download_invoices?:'yes' | 'view_only' | 'no';
897
-
898
- send_subscription_emails:boolean;
899
-
900
- send_invoice_emails:boolean;
901
-
902
- send_payment_emails:boolean;
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;
903
960
  }
904
961
  }
905
- }
962
+ }