rebilly-js-sdk 47.10.0 → 47.11.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.
- package/dist/rebilly-js-sdk.d.ts +939 -573
- package/dist/rebilly-js-sdk.es.js +23 -2
- package/dist/rebilly-js-sdk.umd.js +7 -7
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -176,11 +176,6 @@ declare module rebilly {
|
|
|
176
176
|
type GetCustomerTimelineCustomEventTypeResponse = operations['GetCustomerTimelineCustomEventType']['responses']['200']['content']['application/json']
|
|
177
177
|
type GetCustomerTimelineCustomEventTypeResponsePromise = Promise<{fields: GetCustomerTimelineCustomEventTypeResponse}>
|
|
178
178
|
|
|
179
|
-
type GetCustomerTimelineEventCollectionRequest = operations['GetCustomerTimelineEventCollection']['parameters']["query"] & (operations['GetCustomerTimelineEventCollection']['parameters'] extends {path: {}} ? operations['GetCustomerTimelineEventCollection']['parameters']["path"] : {})
|
|
180
|
-
|
|
181
|
-
type GetCustomerTimelineEventCollectionResponse = operations['GetCustomerTimelineEventCollection']['responses']['200']['content']['application/json'][0]
|
|
182
|
-
type GetCustomerTimelineEventCollectionResponsePromise = Promise<{ items: {fields: GetCustomerTimelineEventCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
183
|
-
|
|
184
179
|
type GetCustomerAmlEntryCollectionRequest = { id : String }
|
|
185
180
|
|
|
186
181
|
type GetCustomerAmlEntryCollectionResponse = operations['GetCustomerAmlEntryCollection']['responses']['200']['content']['application/json'][0]
|
|
@@ -385,7 +380,7 @@ declare module rebilly {
|
|
|
385
380
|
type GetInvoiceCreditMemoAllocationResponse = operations['GetInvoiceCreditMemoAllocation']['responses']['200']['content']['application/json']
|
|
386
381
|
type GetInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: GetInvoiceCreditMemoAllocationResponse}>
|
|
387
382
|
type PutInvoiceCreditMemoAllocationRequest = operations['PutInvoiceCreditMemoAllocation']['requestBody']['content']['application/json']
|
|
388
|
-
type PutInvoiceCreditMemoAllocationResponse = operations['PutInvoiceCreditMemoAllocation']['responses']['
|
|
383
|
+
type PutInvoiceCreditMemoAllocationResponse = operations['PutInvoiceCreditMemoAllocation']['responses']['201']['content']['application/json']
|
|
389
384
|
type PutInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: PutInvoiceCreditMemoAllocationResponse}>
|
|
390
385
|
type DeleteInvoiceCreditMemoAllocationResponse = operations['DeleteInvoiceCreditMemoAllocation']['responses']['204']
|
|
391
386
|
type DeleteInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: DeleteInvoiceCreditMemoAllocationResponse}>
|
|
@@ -1123,8 +1118,8 @@ declare module rebilly {
|
|
|
1123
1118
|
type DeleteCustomDomainResponse = operations['DeleteCustomDomain']['responses']['204']
|
|
1124
1119
|
type DeleteCustomDomainResponsePromise = Promise<{fields: DeleteCustomDomainResponse}>
|
|
1125
1120
|
|
|
1126
|
-
type
|
|
1127
|
-
type
|
|
1121
|
+
type PutEmailDeliverySettingsVerificationResponse = operations['PutEmailDeliverySettingsVerification']['responses']['200']['content']['application/json']
|
|
1122
|
+
type PutEmailDeliverySettingsVerificationResponsePromise = Promise<{fields: PutEmailDeliverySettingsVerificationResponse}>
|
|
1128
1123
|
|
|
1129
1124
|
type GetEmailDeliverySettingCollectionRequest = operations['GetEmailDeliverySettingCollection']['parameters']["query"] & (operations['GetEmailDeliverySettingCollection']['parameters'] extends {path: {}} ? operations['GetEmailDeliverySettingCollection']['parameters']["path"] : {})
|
|
1130
1125
|
|
|
@@ -1145,8 +1140,8 @@ declare module rebilly {
|
|
|
1145
1140
|
type DeleteEmailDeliverySettingResponse = operations['DeleteEmailDeliverySetting']['responses']['204']
|
|
1146
1141
|
type DeleteEmailDeliverySettingResponsePromise = Promise<{fields: DeleteEmailDeliverySettingResponse}>
|
|
1147
1142
|
|
|
1148
|
-
type
|
|
1149
|
-
type
|
|
1143
|
+
type PostResendEmailDeliverySettingVerificationResponse = operations['PostResendEmailDeliverySettingVerification']['responses']['200']['content']['application/json']
|
|
1144
|
+
type PostResendEmailDeliverySettingVerificationResponsePromise = Promise<{fields: PostResendEmailDeliverySettingVerificationResponse}>
|
|
1150
1145
|
|
|
1151
1146
|
type GetEmailMessageCollectionRequest = operations['GetEmailMessageCollection']['parameters']["query"] & (operations['GetEmailMessageCollection']['parameters'] extends {path: {}} ? operations['GetEmailMessageCollection']['parameters']["path"] : {})
|
|
1152
1147
|
|
|
@@ -1303,7 +1298,7 @@ declare module rebilly {
|
|
|
1303
1298
|
type GetGatewayAccountLimitResponse = operations['GetGatewayAccountLimit']['responses']['200']['content']['application/json']
|
|
1304
1299
|
type GetGatewayAccountLimitResponsePromise = Promise<{fields: GetGatewayAccountLimitResponse}>
|
|
1305
1300
|
type PutGatewayAccountLimitRequest = operations['PutGatewayAccountLimit']['requestBody']['content']['application/json']
|
|
1306
|
-
type PutGatewayAccountLimitResponse = operations['PutGatewayAccountLimit']['responses']['
|
|
1301
|
+
type PutGatewayAccountLimitResponse = operations['PutGatewayAccountLimit']['responses']['201']['content']['application/json']
|
|
1307
1302
|
type PutGatewayAccountLimitResponsePromise = Promise<{fields: PutGatewayAccountLimitResponse}>
|
|
1308
1303
|
type DeleteGatewayAccountLimitResponse = operations['DeleteGatewayAccountLimit']['responses']['204']
|
|
1309
1304
|
type DeleteGatewayAccountLimitResponsePromise = Promise<{fields: DeleteGatewayAccountLimitResponse}>
|
|
@@ -1636,6 +1631,20 @@ declare module rebilly {
|
|
|
1636
1631
|
type DeleteWebsiteResponse = operations['DeleteWebsite']['responses']['204']
|
|
1637
1632
|
type DeleteWebsiteResponsePromise = Promise<{fields: DeleteWebsiteResponse}>
|
|
1638
1633
|
|
|
1634
|
+
type GetOrganizationExportCollectionRequest = operations['GetOrganizationExportCollection']['parameters']["query"] & (operations['GetOrganizationExportCollection']['parameters'] extends {path: {}} ? operations['GetOrganizationExportCollection']['parameters']["path"] : {})
|
|
1635
|
+
|
|
1636
|
+
type GetOrganizationExportCollectionResponse = operations['GetOrganizationExportCollection']['responses']['200']['content']['application/json'][0]
|
|
1637
|
+
type GetOrganizationExportCollectionResponsePromise = Promise<{ items: {fields: GetOrganizationExportCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1638
|
+
type PostOrganizationExportRequest = operations['PostOrganizationExport']['requestBody']['content']['application/json']
|
|
1639
|
+
type CreateOrganizationExportRequest = { id: String, data: PostOrganizationExportRequest, expand?: String }
|
|
1640
|
+
type PostOrganizationExportResponse = operations['PostOrganizationExport']['responses']['201']['content']['application/json']
|
|
1641
|
+
type PostOrganizationExportResponsePromise = Promise<{fields: PostOrganizationExportResponse}>
|
|
1642
|
+
|
|
1643
|
+
type GetOrganizationExportRequest = { id : String }
|
|
1644
|
+
|
|
1645
|
+
type GetOrganizationExportResponse = operations['GetOrganizationExport']['responses']['200']['content']['application/json']
|
|
1646
|
+
type GetOrganizationExportResponsePromise = Promise<{fields: GetOrganizationExportResponse}>
|
|
1647
|
+
|
|
1639
1648
|
|
|
1640
1649
|
type StorefrontGetAccountResponse = operations['StorefrontGetAccount']['responses']['200']['content']['application/json']
|
|
1641
1650
|
type StorefrontGetAccountResponsePromise = Promise<{fields: StorefrontGetAccountResponse}>
|
|
@@ -2201,7 +2210,7 @@ export interface corePaths {
|
|
|
2201
2210
|
post: operations["PostCustomerTimelineCustomEventType"];
|
|
2202
2211
|
};
|
|
2203
2212
|
"/customer-timeline-custom-events/{id}": {
|
|
2204
|
-
/** Retrieve customer timeline custom event type. */
|
|
2213
|
+
/** Retrieve customer timeline custom event type with the specified identifier. */
|
|
2205
2214
|
get: operations["GetCustomerTimelineCustomEventType"];
|
|
2206
2215
|
parameters: {
|
|
2207
2216
|
path: {
|
|
@@ -2210,10 +2219,6 @@ export interface corePaths {
|
|
|
2210
2219
|
};
|
|
2211
2220
|
};
|
|
2212
2221
|
};
|
|
2213
|
-
"/customer-timeline-events": {
|
|
2214
|
-
/** Retrieve a list of customer timeline messages for all customers. */
|
|
2215
|
-
get: operations["GetCustomerTimelineEventCollection"];
|
|
2216
|
-
};
|
|
2217
2222
|
"/customers/{id}/aml": {
|
|
2218
2223
|
/**
|
|
2219
2224
|
* Search customer in multiple PEP/Sanctions/Adverse Media lists to find any blocklisted identities.
|
|
@@ -2585,8 +2590,7 @@ export interface corePaths {
|
|
|
2585
2590
|
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
2586
2591
|
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
2587
2592
|
* When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
|
|
2588
|
-
* If a `credit-file-proof` is successful with the decision `single-source`, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
2589
|
-
* If a `credit-file-proof` is successful with the decision `dual-source`, then one of the corresponding `identity-proof` and `address-proof` documents are required.
|
|
2593
|
+
* If a `credit-file-proof` is successful with the decision `single-source` or `dual-source`, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
2590
2594
|
*/
|
|
2591
2595
|
post: operations["PostKycRequest"];
|
|
2592
2596
|
};
|
|
@@ -3277,7 +3281,7 @@ export interface corePaths {
|
|
|
3277
3281
|
"/customers/{id}/edd-timeline": {
|
|
3278
3282
|
/** Retrieve a list of EDD timeline messages. */
|
|
3279
3283
|
get: operations["GetEddTimelineCollection"];
|
|
3280
|
-
/** Create
|
|
3284
|
+
/** Create an EDD Timeline comment or custom defined event. */
|
|
3281
3285
|
post: operations["PostEddTimeline"];
|
|
3282
3286
|
parameters: {
|
|
3283
3287
|
path: {
|
|
@@ -3885,6 +3889,7 @@ export interface coreComponents {
|
|
|
3885
3889
|
| "Apple Pay"
|
|
3886
3890
|
| "AstroPay Card"
|
|
3887
3891
|
| "AstroPay-GO"
|
|
3892
|
+
| "BankSEND"
|
|
3888
3893
|
| "BankReferenced"
|
|
3889
3894
|
| "bank-transfer"
|
|
3890
3895
|
| "bank-transfer-2"
|
|
@@ -4051,7 +4056,7 @@ export interface coreComponents {
|
|
|
4051
4056
|
AlternativePaymentInstrument: {
|
|
4052
4057
|
method: coreComponents["schemas"]["PaymentMethod"];
|
|
4053
4058
|
/** The payment instrument ID. */
|
|
4054
|
-
paymentInstrumentId?:
|
|
4059
|
+
paymentInstrumentId?: coreComponents["schemas"]["ResourceId"];
|
|
4055
4060
|
};
|
|
4056
4061
|
/** Cash payment instrument object. */
|
|
4057
4062
|
CashInstrument: {
|
|
@@ -4065,7 +4070,9 @@ export interface coreComponents {
|
|
|
4065
4070
|
/** Reference data. */
|
|
4066
4071
|
reference?: string;
|
|
4067
4072
|
};
|
|
4068
|
-
|
|
4073
|
+
PaymentInstrumentValueObject: Partial<
|
|
4074
|
+
coreComponents["schemas"]["VaultedInstrument"]
|
|
4075
|
+
> &
|
|
4069
4076
|
Partial<coreComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
4070
4077
|
Partial<coreComponents["schemas"]["CashInstrument"]> &
|
|
4071
4078
|
Partial<coreComponents["schemas"]["CheckInstrument"]>;
|
|
@@ -4215,7 +4222,7 @@ export interface coreComponents {
|
|
|
4215
4222
|
* before it is expired.
|
|
4216
4223
|
*/
|
|
4217
4224
|
paymentToken?: string;
|
|
4218
|
-
defaultPaymentInstrument?: coreComponents["schemas"]["
|
|
4225
|
+
defaultPaymentInstrument?: coreComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
4219
4226
|
/** The customer created time. */
|
|
4220
4227
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4221
4228
|
/** The customer updated time. */
|
|
@@ -4294,7 +4301,7 @@ export interface coreComponents {
|
|
|
4294
4301
|
/** Data table footer. */
|
|
4295
4302
|
footer?: string;
|
|
4296
4303
|
};
|
|
4297
|
-
"three-columns": coreComponents["schemas"]["TimelineTable"] & {
|
|
4304
|
+
"three-columns-timeline-table": coreComponents["schemas"]["TimelineTable"] & {
|
|
4298
4305
|
/** Table data. Each array element represents a table row. */
|
|
4299
4306
|
data?: {
|
|
4300
4307
|
attribute?: string;
|
|
@@ -4302,21 +4309,21 @@ export interface coreComponents {
|
|
|
4302
4309
|
newValue?: string;
|
|
4303
4310
|
}[];
|
|
4304
4311
|
};
|
|
4305
|
-
"two-columns": coreComponents["schemas"]["TimelineTable"] & {
|
|
4312
|
+
"two-columns-timeline-table": coreComponents["schemas"]["TimelineTable"] & {
|
|
4306
4313
|
/** Table data. Each array element represents a table row. */
|
|
4307
4314
|
data?: {
|
|
4308
4315
|
attribute?: string;
|
|
4309
4316
|
value?: string;
|
|
4310
4317
|
}[];
|
|
4311
4318
|
};
|
|
4312
|
-
"one-column": coreComponents["schemas"]["TimelineTable"] & {
|
|
4319
|
+
"one-column-timeline-table": coreComponents["schemas"]["TimelineTable"] & {
|
|
4313
4320
|
/** Table data. Each array element represents a table row. */
|
|
4314
4321
|
data?: {
|
|
4315
4322
|
attribute?: string;
|
|
4316
4323
|
value?: string;
|
|
4317
4324
|
}[];
|
|
4318
4325
|
};
|
|
4319
|
-
list: coreComponents["schemas"]["TimelineTable"] & {
|
|
4326
|
+
"list-timeline-table": coreComponents["schemas"]["TimelineTable"] & {
|
|
4320
4327
|
/** Table data. Each array element represents a line. */
|
|
4321
4328
|
data?: string[];
|
|
4322
4329
|
};
|
|
@@ -4475,6 +4482,7 @@ export interface coreComponents {
|
|
|
4475
4482
|
| "AuthorizeNet"
|
|
4476
4483
|
| "Awepay"
|
|
4477
4484
|
| "Bambora"
|
|
4485
|
+
| "BankSEND"
|
|
4478
4486
|
| "BitPay"
|
|
4479
4487
|
| "BlueSnap"
|
|
4480
4488
|
| "BraintreePayments"
|
|
@@ -4561,6 +4569,7 @@ export interface coreComponents {
|
|
|
4561
4569
|
| "NGenius"
|
|
4562
4570
|
| "NinjaWallet"
|
|
4563
4571
|
| "NMI"
|
|
4572
|
+
| "NOWPayments"
|
|
4564
4573
|
| "NuaPay"
|
|
4565
4574
|
| "OchaPay"
|
|
4566
4575
|
| "Onlineueberweisen"
|
|
@@ -4582,6 +4591,7 @@ export interface coreComponents {
|
|
|
4582
4591
|
| "PaymentsOS"
|
|
4583
4592
|
| "Paymero"
|
|
4584
4593
|
| "PayPal"
|
|
4594
|
+
| "Payper"
|
|
4585
4595
|
| "Payr"
|
|
4586
4596
|
| "Paysafe"
|
|
4587
4597
|
| "Paysafecard"
|
|
@@ -4747,6 +4757,7 @@ export interface coreComponents {
|
|
|
4747
4757
|
| "Bank of Moscow"
|
|
4748
4758
|
| "Bank of Rebilly"
|
|
4749
4759
|
| "Bank One"
|
|
4760
|
+
| "BankSEND"
|
|
4750
4761
|
| "BMO Harris Bank"
|
|
4751
4762
|
| "Borgun"
|
|
4752
4763
|
| "BraintreePayments"
|
|
@@ -4829,6 +4840,7 @@ export interface coreComponents {
|
|
|
4829
4840
|
| "Neteller"
|
|
4830
4841
|
| "NinjaWallet"
|
|
4831
4842
|
| "NMI"
|
|
4843
|
+
| "NOWPayments"
|
|
4832
4844
|
| "NuaPay"
|
|
4833
4845
|
| "Nuvei"
|
|
4834
4846
|
| "OchaPay"
|
|
@@ -4849,6 +4861,7 @@ export interface coreComponents {
|
|
|
4849
4861
|
| "Paymero"
|
|
4850
4862
|
| "Paynetics"
|
|
4851
4863
|
| "PayPal"
|
|
4864
|
+
| "Payper"
|
|
4852
4865
|
| "Payr"
|
|
4853
4866
|
| "PayTabs"
|
|
4854
4867
|
| "PayULatam"
|
|
@@ -5131,7 +5144,7 @@ export interface coreComponents {
|
|
|
5131
5144
|
referenceData?: { [key: string]: string } | null;
|
|
5132
5145
|
/** Payment Card BIN. */
|
|
5133
5146
|
bin?: string;
|
|
5134
|
-
paymentInstrument?: coreComponents["schemas"]["
|
|
5147
|
+
paymentInstrument?: coreComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
5135
5148
|
/** True if transaction has Dynamic Currency Conversion applied. */
|
|
5136
5149
|
hasDcc?: boolean;
|
|
5137
5150
|
/** Dynamic Currency Conversion detailed information. Null if hasDcc is false. */
|
|
@@ -5596,6 +5609,14 @@ export interface coreComponents {
|
|
|
5596
5609
|
apiPasscode: string;
|
|
5597
5610
|
};
|
|
5598
5611
|
};
|
|
5612
|
+
/** BankSEND config. */
|
|
5613
|
+
BankSEND: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5614
|
+
/** BankSEND credentials object. */
|
|
5615
|
+
credentials: {
|
|
5616
|
+
merchantId: string;
|
|
5617
|
+
merchantToken: string;
|
|
5618
|
+
};
|
|
5619
|
+
};
|
|
5599
5620
|
/** BitPay Gateway config. */
|
|
5600
5621
|
BitPay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5601
5622
|
/** BitPay credentials object. */
|
|
@@ -6748,6 +6769,18 @@ export interface coreComponents {
|
|
|
6748
6769
|
passphrase: string;
|
|
6749
6770
|
};
|
|
6750
6771
|
};
|
|
6772
|
+
/** NOWPayments config. */
|
|
6773
|
+
NOWPayments: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6774
|
+
/** NOWPayments credentials object. */
|
|
6775
|
+
credentials: {
|
|
6776
|
+
apiKey: string;
|
|
6777
|
+
ipnSecret: string;
|
|
6778
|
+
};
|
|
6779
|
+
/** NOWPayments settings object. */
|
|
6780
|
+
settings?: {
|
|
6781
|
+
tolerancePercentage: coreComponents["schemas"]["AmountAdjustmentTolerance"];
|
|
6782
|
+
};
|
|
6783
|
+
};
|
|
6751
6784
|
/** NuaPay Gateway config. */
|
|
6752
6785
|
NuaPay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6753
6786
|
/** NuaPay credentials object. */
|
|
@@ -7416,6 +7449,10 @@ export interface coreComponents {
|
|
|
7416
7449
|
/** Password used during MQI/API requests. */
|
|
7417
7450
|
mqiPassword?: string;
|
|
7418
7451
|
};
|
|
7452
|
+
settings?: {
|
|
7453
|
+
/** A comma-separated list of name-value merchant field pairs (key1:value1,key2:value2). */
|
|
7454
|
+
merchantFields?: string;
|
|
7455
|
+
};
|
|
7419
7456
|
};
|
|
7420
7457
|
/** SmartInvoice 3DS Servers. */
|
|
7421
7458
|
SmartInvoice3dsServers: {
|
|
@@ -8256,6 +8293,25 @@ export interface coreComponents {
|
|
|
8256
8293
|
description: string;
|
|
8257
8294
|
/** Tax rate. */
|
|
8258
8295
|
rate?: number | null;
|
|
8296
|
+
/** Amount of sales tax to collect for the state. */
|
|
8297
|
+
stateAmount?: number | null;
|
|
8298
|
+
/** Amount of sales tax to collect for the county. */
|
|
8299
|
+
countyAmount?: number | null;
|
|
8300
|
+
/** Amount of sales tax to collect for the city. */
|
|
8301
|
+
cityAmount?: number | null;
|
|
8302
|
+
/** Amount of sales tax to collect for the special district. */
|
|
8303
|
+
specialDistrictAmount?: number | null;
|
|
8304
|
+
/** Jurisdiction names for the invoice. */
|
|
8305
|
+
jurisdictions?: {
|
|
8306
|
+
/** Two-letter ISO country code for the provided location. */
|
|
8307
|
+
country?: string | null;
|
|
8308
|
+
/** Postal abbreviated state name for the provided location. */
|
|
8309
|
+
state?: string | null;
|
|
8310
|
+
/** County name for the provided location. */
|
|
8311
|
+
county?: string | null;
|
|
8312
|
+
/** City name for the provided location. */
|
|
8313
|
+
city?: string | null;
|
|
8314
|
+
} | null;
|
|
8259
8315
|
};
|
|
8260
8316
|
/** Manually set tax items. */
|
|
8261
8317
|
manual: coreComponents["schemas"]["InvoiceTax"] & {
|
|
@@ -8639,8 +8695,8 @@ export interface coreComponents {
|
|
|
8639
8695
|
| "draft"
|
|
8640
8696
|
| "unpaid"
|
|
8641
8697
|
| "paid"
|
|
8698
|
+
| "partially-paid"
|
|
8642
8699
|
| "past-due"
|
|
8643
|
-
| "delinquent"
|
|
8644
8700
|
| "abandoned"
|
|
8645
8701
|
| "voided"
|
|
8646
8702
|
| "partially-refunded"
|
|
@@ -8790,75 +8846,6 @@ export interface coreComponents {
|
|
|
8790
8846
|
/** Desired time to go live. */
|
|
8791
8847
|
launchTiming?: string;
|
|
8792
8848
|
};
|
|
8793
|
-
KycSettingsIdentity: {
|
|
8794
|
-
/** The weights of all matched properties. */
|
|
8795
|
-
weights?: {
|
|
8796
|
-
/** The weight of containsImage. */
|
|
8797
|
-
containsImage?: number;
|
|
8798
|
-
/** The weight of isIdentityDocument. */
|
|
8799
|
-
isIdentityDocument?: number;
|
|
8800
|
-
/** The weight of isPublishedOnline. */
|
|
8801
|
-
isPublishedOnline?: number;
|
|
8802
|
-
/** The weight of firstName. */
|
|
8803
|
-
firstName?: number;
|
|
8804
|
-
/** The weight of lastName. */
|
|
8805
|
-
lastName?: number;
|
|
8806
|
-
/** The weight of `expirationDate`. */
|
|
8807
|
-
expirationDate?: number;
|
|
8808
|
-
/** The weight of dateOfBirth. */
|
|
8809
|
-
dateOfBirth?: number;
|
|
8810
|
-
/** The weight of matchesDateOfBirth. */
|
|
8811
|
-
matchesDateOfBirth?: number;
|
|
8812
|
-
/** The weight of issueDate. */
|
|
8813
|
-
issueDate?: number;
|
|
8814
|
-
/** The weight of hasMinimalAge. */
|
|
8815
|
-
hasMinimalAge?: number;
|
|
8816
|
-
/** The weight of hasMatchingFaceProof. */
|
|
8817
|
-
hasMatchingFaceProof?: number;
|
|
8818
|
-
/** The weight of nationality. */
|
|
8819
|
-
nationality?: number;
|
|
8820
|
-
};
|
|
8821
|
-
/** The thresholds to determine the document status. */
|
|
8822
|
-
thresholds?: {
|
|
8823
|
-
/** The weight of rejectBelow. */
|
|
8824
|
-
rejectBelow?: number;
|
|
8825
|
-
/** The weight of acceptAbove. */
|
|
8826
|
-
acceptAbove?: number;
|
|
8827
|
-
};
|
|
8828
|
-
};
|
|
8829
|
-
KycSettingsAddress: {
|
|
8830
|
-
/** The weights of all matched properties. */
|
|
8831
|
-
weights?: {
|
|
8832
|
-
/** The weight of firstName. */
|
|
8833
|
-
firstName?: number;
|
|
8834
|
-
/** The weight of lastName. */
|
|
8835
|
-
lastName?: number;
|
|
8836
|
-
/** The weight of line1. */
|
|
8837
|
-
line1?: number;
|
|
8838
|
-
/** The weight of city. */
|
|
8839
|
-
city?: number;
|
|
8840
|
-
/** The weight of region. */
|
|
8841
|
-
region?: number;
|
|
8842
|
-
/** The weight of postalCode. */
|
|
8843
|
-
postalCode?: number;
|
|
8844
|
-
/** The weight of date. */
|
|
8845
|
-
date?: number;
|
|
8846
|
-
/** The weight of phone. */
|
|
8847
|
-
phone?: number;
|
|
8848
|
-
};
|
|
8849
|
-
/** The thresholds to determine the document status. */
|
|
8850
|
-
thresholds?: {
|
|
8851
|
-
/** The weight of rejectBelow. */
|
|
8852
|
-
rejectBelow?: number;
|
|
8853
|
-
/** The weight of acceptAbove. */
|
|
8854
|
-
acceptAbove?: number;
|
|
8855
|
-
};
|
|
8856
|
-
};
|
|
8857
|
-
/** The settings for score calculation. */
|
|
8858
|
-
KycSettings: {
|
|
8859
|
-
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
8860
|
-
addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
8861
|
-
};
|
|
8862
8849
|
TaxLocation: {
|
|
8863
8850
|
/** The tax location street address. */
|
|
8864
8851
|
address?: string;
|
|
@@ -8879,7 +8866,6 @@ export interface coreComponents {
|
|
|
8879
8866
|
/** The rate for flat tax calculation. */
|
|
8880
8867
|
rate?: number | null;
|
|
8881
8868
|
};
|
|
8882
|
-
kyc?: coreComponents["schemas"]["KycSettings"];
|
|
8883
8869
|
/**
|
|
8884
8870
|
* Additional organization addresses where a merchant may wish to collect taxes using the `taxjar` tax calculator.
|
|
8885
8871
|
* Available only for US-based organizations.
|
|
@@ -8889,12 +8875,10 @@ export interface coreComponents {
|
|
|
8889
8875
|
Organization: {
|
|
8890
8876
|
/** The organization identifier string. */
|
|
8891
8877
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
8892
|
-
/** The organization created time. */
|
|
8893
|
-
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8894
|
-
/** The organization updated time. */
|
|
8895
|
-
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8896
8878
|
/** The organization name. */
|
|
8897
8879
|
name: string;
|
|
8880
|
+
/** The organization website. */
|
|
8881
|
+
website?: string;
|
|
8898
8882
|
/** The organization street address. */
|
|
8899
8883
|
address?: string;
|
|
8900
8884
|
/** The organization street address. */
|
|
@@ -8917,6 +8901,10 @@ export interface coreComponents {
|
|
|
8917
8901
|
isPrimary?: boolean;
|
|
8918
8902
|
questionnaire?: coreComponents["schemas"]["OrganizationQuestionnaire"];
|
|
8919
8903
|
settings?: coreComponents["schemas"]["OrganizationSettings"];
|
|
8904
|
+
/** The organization created time. */
|
|
8905
|
+
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8906
|
+
/** The organization updated time. */
|
|
8907
|
+
updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8920
8908
|
/** The links related to resource. */
|
|
8921
8909
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
8922
8910
|
};
|
|
@@ -9393,9 +9381,7 @@ export interface coreComponents {
|
|
|
9393
9381
|
shippingAmount: number;
|
|
9394
9382
|
/** The (invoice's) tax amount to credit. */
|
|
9395
9383
|
taxAmount: number;
|
|
9396
|
-
/** The
|
|
9397
|
-
discountAmount: number;
|
|
9398
|
-
/** The sum of all credits in the credit memo (items, shipping, tax, discount). */
|
|
9384
|
+
/** The sum of all credits in the credit memo (items, shipping, tax). */
|
|
9399
9385
|
totalAmount: number;
|
|
9400
9386
|
/** The amount of `totalAmount` which hasn't been allocated anywhere yet. */
|
|
9401
9387
|
unusedAmount: number;
|
|
@@ -9477,19 +9463,20 @@ export interface coreComponents {
|
|
|
9477
9463
|
| "ewallet-holder-details"
|
|
9478
9464
|
| "ewallet-transaction-statement"
|
|
9479
9465
|
| "other";
|
|
9466
|
+
/** Documents to request from the customer. */
|
|
9467
|
+
KycRequestDocuments: {
|
|
9468
|
+
/** Type of document to request from the customer. */
|
|
9469
|
+
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
9470
|
+
/** Allowed document subtype. */
|
|
9471
|
+
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
9472
|
+
/** Total number of allowed document upload attempts. Use `0` to allow unlimited upload attempts. */
|
|
9473
|
+
maxAttempts: number;
|
|
9474
|
+
/** Specifies whether the customer must upload a photo of their face (selfie) that matches a provided KYC document. */
|
|
9475
|
+
faceProofRequired?: boolean;
|
|
9476
|
+
}[];
|
|
9480
9477
|
CommonKycRequest: {
|
|
9481
9478
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
9482
|
-
|
|
9483
|
-
documents: {
|
|
9484
|
-
/** Document type to be requested from customer. */
|
|
9485
|
-
type: coreComponents["schemas"]["KycDocumentTypes"];
|
|
9486
|
-
/** Document subtype allowed for customer. */
|
|
9487
|
-
subtypes?: coreComponents["schemas"]["KycDocumentSubtypes"][];
|
|
9488
|
-
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
9489
|
-
maxAttempts: number;
|
|
9490
|
-
/** If `true` uploading matching face photo (selfie) is required. */
|
|
9491
|
-
faceProofRequired?: boolean;
|
|
9492
|
-
}[];
|
|
9479
|
+
documents: coreComponents["schemas"]["KycRequestDocuments"];
|
|
9493
9480
|
/** Status of the request. */
|
|
9494
9481
|
status?:
|
|
9495
9482
|
| "gathering"
|
|
@@ -9532,12 +9519,17 @@ export interface coreComponents {
|
|
|
9532
9519
|
| "document-unreadable"
|
|
9533
9520
|
| "document-expired"
|
|
9534
9521
|
| "document-not-matching"
|
|
9522
|
+
| "document-duplicate"
|
|
9523
|
+
| "document-invalid"
|
|
9524
|
+
| "document-not-open"
|
|
9535
9525
|
| "underage-person"
|
|
9536
9526
|
| "third-party-or-mismatch"
|
|
9537
9527
|
| "expiration-date-missing"
|
|
9538
9528
|
| "issue-date-missing"
|
|
9539
9529
|
| "dob-mismatch"
|
|
9540
9530
|
| "name-mismatch"
|
|
9531
|
+
| "critical-info-missing"
|
|
9532
|
+
| "old-address-on-id"
|
|
9541
9533
|
| "other";
|
|
9542
9534
|
KycDocumentRejection: {
|
|
9543
9535
|
type?: coreComponents["schemas"]["KycDocumentRejectionReasonTypes"];
|
|
@@ -9572,7 +9564,7 @@ export interface coreComponents {
|
|
|
9572
9564
|
/** The links related to resource. */
|
|
9573
9565
|
_links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
|
|
9574
9566
|
};
|
|
9575
|
-
|
|
9567
|
+
BaseKycDocument: coreComponents["schemas"]["CommonKycDocument"] & {
|
|
9576
9568
|
/** The customer ID. */
|
|
9577
9569
|
customerId?: coreComponents["schemas"]["ResourceId"];
|
|
9578
9570
|
/** Reviewer's user ID. */
|
|
@@ -9599,27 +9591,6 @@ export interface coreComponents {
|
|
|
9599
9591
|
*/
|
|
9600
9592
|
revision?: number;
|
|
9601
9593
|
};
|
|
9602
|
-
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
9603
|
-
/** The customer ID. */
|
|
9604
|
-
customerId: coreComponents["schemas"]["ResourceId"];
|
|
9605
|
-
/** Reason for uploading. */
|
|
9606
|
-
reason?: string;
|
|
9607
|
-
/**
|
|
9608
|
-
* The level of strictness for the document matches.
|
|
9609
|
-
* The value of `1` is less strict and `2` is strict.
|
|
9610
|
-
*/
|
|
9611
|
-
matchLevel: number;
|
|
9612
|
-
/** The number of times the KYC request data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. */
|
|
9613
|
-
revision?: number;
|
|
9614
|
-
/** The links related to the resource. */
|
|
9615
|
-
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9616
|
-
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
9617
|
-
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9618
|
-
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
9619
|
-
_embedded?: {
|
|
9620
|
-
documents?: coreComponents["schemas"]["KycDocument"][];
|
|
9621
|
-
};
|
|
9622
|
-
};
|
|
9623
9594
|
IdentityMatches: {
|
|
9624
9595
|
/** Flag that indicates if there is an image that contains a face on it. */
|
|
9625
9596
|
containsImage?: boolean;
|
|
@@ -9646,7 +9617,43 @@ export interface coreComponents {
|
|
|
9646
9617
|
/** The interpreted subtype of the uploaded document. */
|
|
9647
9618
|
documentSubtype?: string | null;
|
|
9648
9619
|
};
|
|
9649
|
-
|
|
9620
|
+
KycSettingsIdentity: {
|
|
9621
|
+
/** The weights of all matched properties. */
|
|
9622
|
+
weights?: {
|
|
9623
|
+
/** The weight of containsImage. */
|
|
9624
|
+
containsImage?: number;
|
|
9625
|
+
/** The weight of isIdentityDocument. */
|
|
9626
|
+
isIdentityDocument?: number;
|
|
9627
|
+
/** The weight of isPublishedOnline. */
|
|
9628
|
+
isPublishedOnline?: number;
|
|
9629
|
+
/** The weight of firstName. */
|
|
9630
|
+
firstName?: number;
|
|
9631
|
+
/** The weight of lastName. */
|
|
9632
|
+
lastName?: number;
|
|
9633
|
+
/** The weight of `expirationDate`. */
|
|
9634
|
+
expirationDate?: number;
|
|
9635
|
+
/** The weight of dateOfBirth. */
|
|
9636
|
+
dateOfBirth?: number;
|
|
9637
|
+
/** The weight of matchesDateOfBirth. */
|
|
9638
|
+
matchesDateOfBirth?: number;
|
|
9639
|
+
/** The weight of issueDate. */
|
|
9640
|
+
issueDate?: number;
|
|
9641
|
+
/** The weight of hasMinimalAge. */
|
|
9642
|
+
hasMinimalAge?: number;
|
|
9643
|
+
/** The weight of hasMatchingFaceProof. */
|
|
9644
|
+
hasMatchingFaceProof?: number;
|
|
9645
|
+
/** The weight of nationality. */
|
|
9646
|
+
nationality?: number;
|
|
9647
|
+
};
|
|
9648
|
+
/** The thresholds to determine the document status. */
|
|
9649
|
+
thresholds?: {
|
|
9650
|
+
/** The weight of rejectBelow. */
|
|
9651
|
+
rejectBelow?: number;
|
|
9652
|
+
/** The weight of acceptAbove. */
|
|
9653
|
+
acceptAbove?: number;
|
|
9654
|
+
};
|
|
9655
|
+
};
|
|
9656
|
+
ProofOfIdentityKycDocument: coreComponents["schemas"]["BaseKycDocument"] & {
|
|
9650
9657
|
documentMatches?: {
|
|
9651
9658
|
/** The calculated score that represents the % of confidence that this ID represents the given customer. */
|
|
9652
9659
|
score?: number;
|
|
@@ -9687,7 +9694,35 @@ export interface coreComponents {
|
|
|
9687
9694
|
/** The interpreted subtype of the uploaded document. */
|
|
9688
9695
|
documentSubtype?: string | null;
|
|
9689
9696
|
};
|
|
9690
|
-
|
|
9697
|
+
KycSettingsAddress: {
|
|
9698
|
+
/** The weights of all matched properties. */
|
|
9699
|
+
weights?: {
|
|
9700
|
+
/** The weight of firstName. */
|
|
9701
|
+
firstName?: number;
|
|
9702
|
+
/** The weight of lastName. */
|
|
9703
|
+
lastName?: number;
|
|
9704
|
+
/** The weight of line1. */
|
|
9705
|
+
line1?: number;
|
|
9706
|
+
/** The weight of city. */
|
|
9707
|
+
city?: number;
|
|
9708
|
+
/** The weight of region. */
|
|
9709
|
+
region?: number;
|
|
9710
|
+
/** The weight of postalCode. */
|
|
9711
|
+
postalCode?: number;
|
|
9712
|
+
/** The weight of date. */
|
|
9713
|
+
date?: number;
|
|
9714
|
+
/** The weight of phone. */
|
|
9715
|
+
phone?: number;
|
|
9716
|
+
};
|
|
9717
|
+
/** The thresholds to determine the document status. */
|
|
9718
|
+
thresholds?: {
|
|
9719
|
+
/** The weight of rejectBelow. */
|
|
9720
|
+
rejectBelow?: number;
|
|
9721
|
+
/** The weight of acceptAbove. */
|
|
9722
|
+
acceptAbove?: number;
|
|
9723
|
+
};
|
|
9724
|
+
};
|
|
9725
|
+
ProofOfAddressKycDocument: coreComponents["schemas"]["BaseKycDocument"] & {
|
|
9691
9726
|
documentMatches?: {
|
|
9692
9727
|
/** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
|
|
9693
9728
|
score?: number;
|
|
@@ -9712,7 +9747,7 @@ export interface coreComponents {
|
|
|
9712
9747
|
/** The interpreted subtype of the uploaded document. */
|
|
9713
9748
|
documentSubtype?: string | null;
|
|
9714
9749
|
};
|
|
9715
|
-
|
|
9750
|
+
ProofOfFundsKycDocument: coreComponents["schemas"]["BaseKycDocument"] & {
|
|
9716
9751
|
documentMatches?: {
|
|
9717
9752
|
data?: coreComponents["schemas"]["FundsMatches"];
|
|
9718
9753
|
};
|
|
@@ -9738,7 +9773,7 @@ export interface coreComponents {
|
|
|
9738
9773
|
/** The link type. */
|
|
9739
9774
|
rel: "paymentInstrument";
|
|
9740
9775
|
};
|
|
9741
|
-
|
|
9776
|
+
ProofOfPurchaseKycDocument: coreComponents["schemas"]["BaseKycDocument"] & {
|
|
9742
9777
|
documentMatches?: {
|
|
9743
9778
|
data?: coreComponents["schemas"]["PurchaseMatches"];
|
|
9744
9779
|
};
|
|
@@ -9772,7 +9807,7 @@ export interface coreComponents {
|
|
|
9772
9807
|
/** Extra data from credit bureau. */
|
|
9773
9808
|
referenceData?: { [key: string]: any } | null;
|
|
9774
9809
|
};
|
|
9775
|
-
|
|
9810
|
+
ProofOfCreditFileKycDocument: coreComponents["schemas"]["BaseKycDocument"] & {
|
|
9776
9811
|
documentMatches?: {
|
|
9777
9812
|
data?: coreComponents["schemas"]["CreditFileMatches"];
|
|
9778
9813
|
};
|
|
@@ -9780,12 +9815,38 @@ export interface coreComponents {
|
|
|
9780
9815
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9781
9816
|
Partial<coreComponents["schemas"]["CustomerLink"]>)[];
|
|
9782
9817
|
};
|
|
9783
|
-
|
|
9784
|
-
| coreComponents["schemas"]["
|
|
9785
|
-
| coreComponents["schemas"]["
|
|
9786
|
-
| coreComponents["schemas"]["
|
|
9787
|
-
| coreComponents["schemas"]["
|
|
9788
|
-
| coreComponents["schemas"]["
|
|
9818
|
+
KycDocument:
|
|
9819
|
+
| coreComponents["schemas"]["ProofOfIdentityKycDocument"]
|
|
9820
|
+
| coreComponents["schemas"]["ProofOfAddressKycDocument"]
|
|
9821
|
+
| coreComponents["schemas"]["ProofOfFundsKycDocument"]
|
|
9822
|
+
| coreComponents["schemas"]["ProofOfPurchaseKycDocument"]
|
|
9823
|
+
| coreComponents["schemas"]["ProofOfCreditFileKycDocument"];
|
|
9824
|
+
KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
|
|
9825
|
+
/** The customer ID. */
|
|
9826
|
+
customerId: coreComponents["schemas"]["ResourceId"];
|
|
9827
|
+
/** Reason for uploading. */
|
|
9828
|
+
reason?: string;
|
|
9829
|
+
/**
|
|
9830
|
+
* The level of strictness for the document matches.
|
|
9831
|
+
* The value of `1` is less strict and `2` is strict.
|
|
9832
|
+
*/
|
|
9833
|
+
matchLevel: number;
|
|
9834
|
+
/** The number of times the KYC request data has been modified. The revision is useful when analyzing webhook data to determine if the change takes precedence over the current representation. */
|
|
9835
|
+
revision?: number;
|
|
9836
|
+
/** The links related to the resource. */
|
|
9837
|
+
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
9838
|
+
Partial<coreComponents["schemas"]["KycDocumentsLink"]> &
|
|
9839
|
+
Partial<coreComponents["schemas"]["KycGathererLink"]>)[];
|
|
9840
|
+
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
9841
|
+
_embedded?: {
|
|
9842
|
+
documents?: coreComponents["schemas"]["KycDocument"][];
|
|
9843
|
+
};
|
|
9844
|
+
};
|
|
9845
|
+
/** The settings for score calculation. */
|
|
9846
|
+
KycSettings: {
|
|
9847
|
+
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
9848
|
+
addressProof?: coreComponents["schemas"]["KycSettingsAddress"];
|
|
9849
|
+
};
|
|
9789
9850
|
ResetPasswordToken: {
|
|
9790
9851
|
/** The token's identifier string. */
|
|
9791
9852
|
token?: string;
|
|
@@ -10043,7 +10104,7 @@ export interface coreComponents {
|
|
|
10043
10104
|
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
10044
10105
|
_embedded?: Partial<coreComponents["schemas"]["CustomerEmbed"]>[];
|
|
10045
10106
|
};
|
|
10046
|
-
|
|
10107
|
+
PaymentInstrument:
|
|
10047
10108
|
| coreComponents["schemas"]["PaymentCard"]
|
|
10048
10109
|
| coreComponents["schemas"]["BankAccount"]
|
|
10049
10110
|
| coreComponents["schemas"]["PayPalAccount"]
|
|
@@ -10078,56 +10139,57 @@ export interface coreComponents {
|
|
|
10078
10139
|
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
10079
10140
|
useAsBackup: boolean;
|
|
10080
10141
|
};
|
|
10142
|
+
BankAccountCreatePlain: {
|
|
10143
|
+
accountNumberType: "IBAN" | "BBAN";
|
|
10144
|
+
};
|
|
10081
10145
|
/** BBAN type object. */
|
|
10082
|
-
BBANType: {
|
|
10083
|
-
/**
|
|
10084
|
-
method
|
|
10085
|
-
/**
|
|
10086
|
-
customerId
|
|
10146
|
+
BBANType: coreComponents["schemas"]["BankAccountCreatePlain"] & {
|
|
10147
|
+
/** Payment method of the payment instrument. */
|
|
10148
|
+
method?: "ach";
|
|
10149
|
+
/** ID of the customer who is initiating the payment. */
|
|
10150
|
+
customerId?: coreComponents["schemas"]["ResourceId"];
|
|
10087
10151
|
/**
|
|
10088
|
-
* Bank
|
|
10089
|
-
*
|
|
10152
|
+
* Bank account number type. A valid value is Basic Bank Account Number (BBAN) or International Bank Account Number (IBAN).
|
|
10153
|
+
* BBAN object.
|
|
10090
10154
|
*/
|
|
10091
10155
|
accountNumberType: "IBAN" | "BBAN";
|
|
10092
10156
|
/** Bank's account number. */
|
|
10093
|
-
accountNumber
|
|
10157
|
+
accountNumber?: string;
|
|
10094
10158
|
/** Bank's routing number. */
|
|
10095
|
-
routingNumber
|
|
10159
|
+
routingNumber?: string;
|
|
10096
10160
|
/** Bank's account type. */
|
|
10097
|
-
accountType
|
|
10098
|
-
/** Bank
|
|
10161
|
+
accountType?: "checking" | "savings" | "other";
|
|
10162
|
+
/** Bank name. */
|
|
10099
10163
|
bankName?: string;
|
|
10100
|
-
/** Bank Identifier Code. */
|
|
10164
|
+
/** Bank Identifier Code (BIC). */
|
|
10101
10165
|
bic?: string;
|
|
10102
|
-
/** The billing address. */
|
|
10103
|
-
billingAddress
|
|
10166
|
+
/** The customer's billing address. */
|
|
10167
|
+
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
10104
10168
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
10105
10169
|
riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
|
|
10106
10170
|
};
|
|
10107
10171
|
/** IBAN type object. */
|
|
10108
|
-
IBANType: {
|
|
10109
|
-
/**
|
|
10110
|
-
method
|
|
10111
|
-
/**
|
|
10112
|
-
customerId
|
|
10172
|
+
IBANType: coreComponents["schemas"]["BankAccountCreatePlain"] & {
|
|
10173
|
+
/** Payment method of the payment instrument. */
|
|
10174
|
+
method?: "ach";
|
|
10175
|
+
/** ID of the customer who is initiating a payment. */
|
|
10176
|
+
customerId?: coreComponents["schemas"]["ResourceId"];
|
|
10113
10177
|
/**
|
|
10114
|
-
*
|
|
10115
|
-
*
|
|
10178
|
+
* Customer's bank account number type. A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
|
|
10179
|
+
* IBAN object.
|
|
10116
10180
|
*/
|
|
10117
10181
|
accountNumberType: "IBAN" | "BBAN";
|
|
10118
|
-
/**
|
|
10119
|
-
accountNumber
|
|
10120
|
-
/** Bank
|
|
10182
|
+
/** Customer's bank account number. Detailed information on all ISO 13616-compliant national IBAN formats is available in the [SWIFT IBAN Registry](https://www.swift.com/standards/data-standards/iban). */
|
|
10183
|
+
accountNumber?: string;
|
|
10184
|
+
/** Bank name. */
|
|
10121
10185
|
bankName?: string;
|
|
10122
|
-
/** Bank Identifier Code. */
|
|
10186
|
+
/** Bank Identifier Code (BIC). */
|
|
10123
10187
|
bic?: string;
|
|
10124
|
-
/** The billing address. */
|
|
10125
|
-
billingAddress
|
|
10188
|
+
/** The customer's billing address. */
|
|
10189
|
+
billingAddress?: coreComponents["schemas"]["ContactObject"];
|
|
10126
10190
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
10127
10191
|
riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
|
|
10128
10192
|
};
|
|
10129
|
-
BankAccountCreatePlain: Partial<coreComponents["schemas"]["BBANType"]> &
|
|
10130
|
-
Partial<coreComponents["schemas"]["IBANType"]>;
|
|
10131
10193
|
PaymentInstrumentUpdateToken: {
|
|
10132
10194
|
/** Payment token ID. */
|
|
10133
10195
|
token?: string;
|
|
@@ -10270,12 +10332,32 @@ export interface coreComponents {
|
|
|
10270
10332
|
feature?: coreComponents["schemas"]["PayPalBillingAgreementFeature"] | null;
|
|
10271
10333
|
filters?: coreComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
10272
10334
|
};
|
|
10335
|
+
KlarnaFeature: {
|
|
10336
|
+
/** The feature name. */
|
|
10337
|
+
name: "Klarna";
|
|
10338
|
+
/** Klarna client token. */
|
|
10339
|
+
clientToken: string;
|
|
10340
|
+
/** Klarna session token. */
|
|
10341
|
+
sessionId: string;
|
|
10342
|
+
};
|
|
10343
|
+
ReadyToPayKlarnaMethod: {
|
|
10344
|
+
/** The payment method. */
|
|
10345
|
+
method: "Klarna";
|
|
10346
|
+
/** The specific feature of this method. For example, a digital wallet or a processor. If the method does not have any features, this value will be null. */
|
|
10347
|
+
feature?: coreComponents["schemas"]["KlarnaFeature"] | null;
|
|
10348
|
+
filters?: coreComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
10349
|
+
};
|
|
10273
10350
|
ReadyToPayMethods: (Partial<
|
|
10274
10351
|
coreComponents["schemas"]["ReadyToPayPaymentCardMethod"]
|
|
10275
10352
|
> &
|
|
10276
10353
|
Partial<coreComponents["schemas"]["ReadyToPayAchMethod"]> &
|
|
10277
10354
|
Partial<coreComponents["schemas"]["ReadyToPayGenericMethod"]> &
|
|
10278
|
-
Partial<coreComponents["schemas"]["ReadyToPayPayPalMethod"]>
|
|
10355
|
+
Partial<coreComponents["schemas"]["ReadyToPayPayPalMethod"]> &
|
|
10356
|
+
Partial<coreComponents["schemas"]["ReadyToPayKlarnaMethod"]>)[];
|
|
10357
|
+
Subscription: {
|
|
10358
|
+
/** Specifies the type of order, a subscription or a one-time purchase. */
|
|
10359
|
+
orderType?: "subscription-order" | "one-time-order";
|
|
10360
|
+
};
|
|
10279
10361
|
/** Plan without changes. */
|
|
10280
10362
|
OriginalPlan: {
|
|
10281
10363
|
/** The ID of plan to use. */
|
|
@@ -10283,7 +10365,24 @@ export interface coreComponents {
|
|
|
10283
10365
|
};
|
|
10284
10366
|
FlexiblePlan: coreComponents["schemas"]["CommonPlan"] & {
|
|
10285
10367
|
/** The ID of plan to modify with given settings. */
|
|
10286
|
-
id
|
|
10368
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
10369
|
+
} & { [key: string]: any };
|
|
10370
|
+
OrderItem: {
|
|
10371
|
+
/** The plan identifier string. */
|
|
10372
|
+
planId?: coreComponents["schemas"]["ResourceId"];
|
|
10373
|
+
/** Number of units of the product on the given plan. */
|
|
10374
|
+
quantity?: number;
|
|
10375
|
+
plan:
|
|
10376
|
+
| coreComponents["schemas"]["OriginalPlan"]
|
|
10377
|
+
| coreComponents["schemas"]["FlexiblePlan"];
|
|
10378
|
+
/** Increments with each override change to this specific item. */
|
|
10379
|
+
revision?: number;
|
|
10380
|
+
/** Indicates if the plan information was modified for this subscription. */
|
|
10381
|
+
isModified?: boolean;
|
|
10382
|
+
/** Indicates if the plan's current revision is greater than this item's plan revision. */
|
|
10383
|
+
isGrandfathered?: boolean;
|
|
10384
|
+
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
10385
|
+
_embedded?: Partial<coreComponents["schemas"]["ProductEmbed"]>[];
|
|
10287
10386
|
};
|
|
10288
10387
|
CommonOrder: {
|
|
10289
10388
|
/** The order identifier string. */
|
|
@@ -10314,21 +10413,7 @@ export interface coreComponents {
|
|
|
10314
10413
|
initialInvoiceId?: coreComponents["schemas"]["ResourceId"];
|
|
10315
10414
|
/** Most recently issued invoice identifier string. It might not be `paid` yet. */
|
|
10316
10415
|
recentInvoiceId?: coreComponents["schemas"]["ResourceId"];
|
|
10317
|
-
items?:
|
|
10318
|
-
/** The plan identifier string. */
|
|
10319
|
-
planId?: coreComponents["schemas"]["ResourceId"];
|
|
10320
|
-
/** Number of units of the product on the given plan. */
|
|
10321
|
-
quantity?: number;
|
|
10322
|
-
plan:
|
|
10323
|
-
| coreComponents["schemas"]["OriginalPlan"]
|
|
10324
|
-
| coreComponents["schemas"]["FlexiblePlan"];
|
|
10325
|
-
/** Increments with each override change to this specific item. */
|
|
10326
|
-
revision?: number;
|
|
10327
|
-
/** Indicates if the plan information was modified for this subscription. */
|
|
10328
|
-
isModified?: boolean;
|
|
10329
|
-
/** Indicates if the plan's current revision is greater than this item's plan revision. */
|
|
10330
|
-
isGrandfathered?: boolean;
|
|
10331
|
-
}[];
|
|
10416
|
+
items?: coreComponents["schemas"]["OrderItem"][];
|
|
10332
10417
|
/** Order delivery address. */
|
|
10333
10418
|
deliveryAddress?: coreComponents["schemas"]["ContactObject"] | null;
|
|
10334
10419
|
/** Order billing address. */
|
|
@@ -10400,8 +10485,8 @@ export interface coreComponents {
|
|
|
10400
10485
|
trial?: {
|
|
10401
10486
|
/** Enable or disable the trial for this subscription. If enabled for plans without trial prices, the trial will be free. */
|
|
10402
10487
|
enabled?: boolean;
|
|
10403
|
-
/**
|
|
10404
|
-
endTime
|
|
10488
|
+
/** Time and date at which the trial ends. If a trial is enabled on this subscription, a value must be provided. */
|
|
10489
|
+
endTime?: string;
|
|
10405
10490
|
};
|
|
10406
10491
|
/** Whether a subscription ends after a trial period. Recurring settings are ignored if it's `true`. */
|
|
10407
10492
|
isTrialOnly: boolean;
|
|
@@ -10437,6 +10522,8 @@ export interface coreComponents {
|
|
|
10437
10522
|
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
10438
10523
|
amount?: number;
|
|
10439
10524
|
};
|
|
10525
|
+
/** ID of the payment instrument to use for autopay. If not provided or inactive, the customer's default payment instrument will be used. */
|
|
10526
|
+
paymentInstrumentId?: coreComponents["schemas"]["ResourceId"] | null;
|
|
10440
10527
|
};
|
|
10441
10528
|
SubscriptionCancellationState: {
|
|
10442
10529
|
/** Subscription order canceled time. */
|
|
@@ -10476,6 +10563,14 @@ export interface coreComponents {
|
|
|
10476
10563
|
InitialInvoiceEmbed: {
|
|
10477
10564
|
initialInvoice?: coreComponents["schemas"]["Invoice"];
|
|
10478
10565
|
};
|
|
10566
|
+
/** Payment instrument object. */
|
|
10567
|
+
PaymentInstrumentEmbed: {
|
|
10568
|
+
paymentInstrument?: coreComponents["schemas"]["PaymentInstrument"];
|
|
10569
|
+
};
|
|
10570
|
+
/** Upcoming invoice object. */
|
|
10571
|
+
UpcomingInvoiceEmbed: {
|
|
10572
|
+
upcomingInvoice?: coreComponents["schemas"]["Invoice"];
|
|
10573
|
+
};
|
|
10479
10574
|
SubscriptionMetadata: {
|
|
10480
10575
|
/**
|
|
10481
10576
|
* The number of times the order data has been modified.
|
|
@@ -10502,33 +10597,37 @@ export interface coreComponents {
|
|
|
10502
10597
|
Partial<coreComponents["schemas"]["CustomerEmbed"]> &
|
|
10503
10598
|
Partial<coreComponents["schemas"]["WebsiteEmbed"]> &
|
|
10504
10599
|
Partial<coreComponents["schemas"]["LeadSourceEmbed"]> &
|
|
10505
|
-
Partial<coreComponents["schemas"]["ShippingRateEmbed"]>
|
|
10600
|
+
Partial<coreComponents["schemas"]["ShippingRateEmbed"]> &
|
|
10601
|
+
Partial<coreComponents["schemas"]["PaymentInstrumentEmbed"]> &
|
|
10602
|
+
Partial<coreComponents["schemas"]["UpcomingInvoiceEmbed"]>)[];
|
|
10506
10603
|
};
|
|
10507
|
-
SubscriptionOrder: coreComponents["schemas"]["
|
|
10508
|
-
|
|
10509
|
-
|
|
10510
|
-
|
|
10511
|
-
|
|
10512
|
-
|
|
10513
|
-
|
|
10514
|
-
|
|
10515
|
-
|
|
10516
|
-
|
|
10517
|
-
|
|
10518
|
-
|
|
10604
|
+
SubscriptionOrder: coreComponents["schemas"]["Subscription"] &
|
|
10605
|
+
coreComponents["schemas"]["CommonSubscriptionOrder"] & {
|
|
10606
|
+
/** The customer identifier string. */
|
|
10607
|
+
customerId?: coreComponents["schemas"]["ResourceId"];
|
|
10608
|
+
/** Time renewal reminder event will be triggered. */
|
|
10609
|
+
renewalReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
10610
|
+
/** Number of renewal reminder events triggered. */
|
|
10611
|
+
renewalReminderNumber?: number | null;
|
|
10612
|
+
/** Time renewal reminder event will be triggered. */
|
|
10613
|
+
trialReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
|
|
10614
|
+
/** Number of renewal reminder events triggered. */
|
|
10615
|
+
trialReminderNumber?: number | null;
|
|
10616
|
+
/** Organization ID. */
|
|
10617
|
+
organizationId?: coreComponents["schemas"]["ResourceId"];
|
|
10618
|
+
} & coreComponents["schemas"]["SubscriptionCancellationState"] &
|
|
10519
10619
|
coreComponents["schemas"]["SubscriptionMetadata"];
|
|
10520
10620
|
CommonOneTimeOrder: coreComponents["schemas"]["CommonOrder"] & {
|
|
10521
10621
|
/** One-time order status. */
|
|
10522
10622
|
status?: "pending" | "completed" | "canceled";
|
|
10523
10623
|
};
|
|
10524
|
-
OneTimeOrder: coreComponents["schemas"]["
|
|
10525
|
-
|
|
10526
|
-
|
|
10527
|
-
|
|
10528
|
-
|
|
10529
|
-
|
|
10530
|
-
|
|
10531
|
-
};
|
|
10624
|
+
OneTimeOrder: coreComponents["schemas"]["Subscription"] &
|
|
10625
|
+
coreComponents["schemas"]["CommonOneTimeOrder"] & {
|
|
10626
|
+
/** The customer identifier string. */
|
|
10627
|
+
customerId?: coreComponents["schemas"]["ResourceId"];
|
|
10628
|
+
/** Organization ID. */
|
|
10629
|
+
organizationId?: coreComponents["schemas"]["ResourceId"];
|
|
10630
|
+
} & coreComponents["schemas"]["SubscriptionMetadata"];
|
|
10532
10631
|
Search: {
|
|
10533
10632
|
/** List of returned customers. */
|
|
10534
10633
|
customers?: coreComponents["schemas"]["Customer"][];
|
|
@@ -10913,6 +11012,19 @@ export interface coreComponents {
|
|
|
10913
11012
|
/** The billing address object. */
|
|
10914
11013
|
billingAddress: coreComponents["schemas"]["ContactObject"];
|
|
10915
11014
|
};
|
|
11015
|
+
KlarnaToken: coreComponents["schemas"]["CommonPaymentToken"] & {
|
|
11016
|
+
/** The token payment method. */
|
|
11017
|
+
method: "Klarna";
|
|
11018
|
+
/** The Klarna instrument details required for express checkout. */
|
|
11019
|
+
paymentInstrument: {
|
|
11020
|
+
/** The Klarna authorization token. */
|
|
11021
|
+
klarnaAuthorizationToken: string;
|
|
11022
|
+
/** The Klarna session ID. */
|
|
11023
|
+
klarnaSessionId: string;
|
|
11024
|
+
};
|
|
11025
|
+
/** The billing address object. */
|
|
11026
|
+
billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
|
|
11027
|
+
};
|
|
10916
11028
|
CompositeToken: Partial<coreComponents["schemas"]["FullPaymentCardToken"]> &
|
|
10917
11029
|
Partial<coreComponents["schemas"]["PartialPaymentCardToken"]> &
|
|
10918
11030
|
Partial<coreComponents["schemas"]["PayPalToken"]> &
|
|
@@ -10920,7 +11032,8 @@ export interface coreComponents {
|
|
|
10920
11032
|
Partial<coreComponents["schemas"]["DigitalWalletToken"]> &
|
|
10921
11033
|
Partial<coreComponents["schemas"]["PlaidAccountToken"]> &
|
|
10922
11034
|
Partial<coreComponents["schemas"]["KhelocardCardToken"]> &
|
|
10923
|
-
Partial<coreComponents["schemas"]["AlternativePaymentToken"]
|
|
11035
|
+
Partial<coreComponents["schemas"]["AlternativePaymentToken"]> &
|
|
11036
|
+
Partial<coreComponents["schemas"]["KlarnaToken"]>;
|
|
10924
11037
|
DigitalWalletValidation: {
|
|
10925
11038
|
/** Type of the digital wallet to validate. */
|
|
10926
11039
|
type: "Apple Pay";
|
|
@@ -10944,7 +11057,7 @@ export interface coreComponents {
|
|
|
10944
11057
|
/** Payment Token ID. */
|
|
10945
11058
|
token: string;
|
|
10946
11059
|
};
|
|
10947
|
-
|
|
11060
|
+
PaymentInstructionInstrument: {
|
|
10948
11061
|
/** The Payment Instrument identifier string. */
|
|
10949
11062
|
paymentInstrumentId: coreComponents["schemas"]["ResourceId"];
|
|
10950
11063
|
};
|
|
@@ -10966,7 +11079,7 @@ export interface coreComponents {
|
|
|
10966
11079
|
};
|
|
10967
11080
|
PaymentInstruction:
|
|
10968
11081
|
| coreComponents["schemas"]["PaymentToken"]
|
|
10969
|
-
| coreComponents["schemas"]["
|
|
11082
|
+
| coreComponents["schemas"]["PaymentInstructionInstrument"]
|
|
10970
11083
|
| coreComponents["schemas"]["PaymentMethods"]
|
|
10971
11084
|
| coreComponents["schemas"]["PaymentCardCreatePlain"]
|
|
10972
11085
|
| coreComponents["schemas"]["BankAccountCreatePlain"];
|
|
@@ -11389,7 +11502,7 @@ export interface coreComponents {
|
|
|
11389
11502
|
EddSearchResult: {
|
|
11390
11503
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
11391
11504
|
type?: "occupation" | "arrest" | "fraud" | "bankruptcy";
|
|
11392
|
-
|
|
11505
|
+
searchResultData?: coreComponents["schemas"]["EddScoreDetails"][];
|
|
11393
11506
|
/** The EDD search result created time. */
|
|
11394
11507
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
11395
11508
|
};
|
|
@@ -11489,10 +11602,14 @@ export interface coreComponents {
|
|
|
11489
11602
|
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
11490
11603
|
* To expand multiple objects, it accepts a comma-separated list of objects (example: `expand=recentInvoice,initialInvoice`).
|
|
11491
11604
|
* Available arguments are:
|
|
11492
|
-
* - recentInvoice
|
|
11493
|
-
* - initialInvoice
|
|
11494
11605
|
* - customer
|
|
11606
|
+
* - leadSource
|
|
11495
11607
|
* - website
|
|
11608
|
+
* - shippingRate
|
|
11609
|
+
* - initialInvoice
|
|
11610
|
+
* - recentInvoice
|
|
11611
|
+
* - upcomingInvoice
|
|
11612
|
+
* - paymentInstrument
|
|
11496
11613
|
*
|
|
11497
11614
|
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
11498
11615
|
*/
|
|
@@ -11628,7 +11745,7 @@ export interface coreComponents {
|
|
|
11628
11745
|
};
|
|
11629
11746
|
};
|
|
11630
11747
|
/** Customer webhook request body resource. */
|
|
11631
|
-
|
|
11748
|
+
CustomerWebhook: {
|
|
11632
11749
|
content: {
|
|
11633
11750
|
"application/json": {
|
|
11634
11751
|
/** The customer ID. */
|
|
@@ -11643,7 +11760,7 @@ export interface coreComponents {
|
|
|
11643
11760
|
};
|
|
11644
11761
|
};
|
|
11645
11762
|
/** Credit memo webhook request body resource. */
|
|
11646
|
-
|
|
11763
|
+
CreditMemoWebhook: {
|
|
11647
11764
|
content: {
|
|
11648
11765
|
"application/json": {
|
|
11649
11766
|
/** The credit memo ID. */
|
|
@@ -11703,7 +11820,7 @@ export interface coreComponents {
|
|
|
11703
11820
|
};
|
|
11704
11821
|
};
|
|
11705
11822
|
/** Dispute webhook request body resource. */
|
|
11706
|
-
|
|
11823
|
+
DisputeWebhook: {
|
|
11707
11824
|
content: {
|
|
11708
11825
|
"application/json": {
|
|
11709
11826
|
/** The dispute ID. */
|
|
@@ -11760,7 +11877,7 @@ export interface coreComponents {
|
|
|
11760
11877
|
};
|
|
11761
11878
|
};
|
|
11762
11879
|
/** Transaction webhook request body resource. */
|
|
11763
|
-
|
|
11880
|
+
TransactionWebhook: {
|
|
11764
11881
|
content: {
|
|
11765
11882
|
"application/json": {
|
|
11766
11883
|
/** The transaction ID. */
|
|
@@ -11775,7 +11892,7 @@ export interface coreComponents {
|
|
|
11775
11892
|
};
|
|
11776
11893
|
};
|
|
11777
11894
|
/** Invoice webhook request body resource. */
|
|
11778
|
-
|
|
11895
|
+
InvoiceWebhook: {
|
|
11779
11896
|
content: {
|
|
11780
11897
|
"application/json": {
|
|
11781
11898
|
/** The invoice ID. */
|
|
@@ -11790,7 +11907,7 @@ export interface coreComponents {
|
|
|
11790
11907
|
};
|
|
11791
11908
|
};
|
|
11792
11909
|
/** KYC document webhook request body resource. */
|
|
11793
|
-
|
|
11910
|
+
KycDocumentWebhook: {
|
|
11794
11911
|
content: {
|
|
11795
11912
|
"application/json": {
|
|
11796
11913
|
/** The customer ID. */
|
|
@@ -11802,7 +11919,7 @@ export interface coreComponents {
|
|
|
11802
11919
|
eventType?: coreComponents["schemas"]["GlobalWebhookEventType"];
|
|
11803
11920
|
_embedded?: {
|
|
11804
11921
|
customer?: coreComponents["schemas"]["Customer"];
|
|
11805
|
-
kycDocument?: coreComponents["schemas"]["KycDocument
|
|
11922
|
+
kycDocument?: coreComponents["schemas"]["KycDocument"];
|
|
11806
11923
|
};
|
|
11807
11924
|
/** The links related to resource. */
|
|
11808
11925
|
_links?: (Partial<coreComponents["schemas"]["CustomerLink"]> &
|
|
@@ -11812,7 +11929,7 @@ export interface coreComponents {
|
|
|
11812
11929
|
};
|
|
11813
11930
|
};
|
|
11814
11931
|
/** KYC request webhook body resource. */
|
|
11815
|
-
|
|
11932
|
+
KycRequestWebhook: {
|
|
11816
11933
|
content: {
|
|
11817
11934
|
"application/json": {
|
|
11818
11935
|
/** The customer ID. */
|
|
@@ -11836,7 +11953,7 @@ export interface coreComponents {
|
|
|
11836
11953
|
};
|
|
11837
11954
|
};
|
|
11838
11955
|
/** Order webhook request body resource. */
|
|
11839
|
-
|
|
11956
|
+
SubscriptionWebhook: {
|
|
11840
11957
|
content: {
|
|
11841
11958
|
"application/json": {
|
|
11842
11959
|
/** The order ID. */
|
|
@@ -11851,7 +11968,7 @@ export interface coreComponents {
|
|
|
11851
11968
|
};
|
|
11852
11969
|
};
|
|
11853
11970
|
/** Payment card webhook request body resource. */
|
|
11854
|
-
|
|
11971
|
+
PaymentCardWebhook: {
|
|
11855
11972
|
content: {
|
|
11856
11973
|
"application/json": {
|
|
11857
11974
|
/** The payment card ID. */
|
|
@@ -12931,7 +13048,7 @@ export interface operations {
|
|
|
12931
13048
|
};
|
|
12932
13049
|
};
|
|
12933
13050
|
};
|
|
12934
|
-
/** Retrieve customer timeline custom event type. */
|
|
13051
|
+
/** Retrieve customer timeline custom event type with the specified identifier. */
|
|
12935
13052
|
GetCustomerTimelineCustomEventType: {
|
|
12936
13053
|
parameters: {
|
|
12937
13054
|
path: {
|
|
@@ -12951,34 +13068,6 @@ export interface operations {
|
|
|
12951
13068
|
403: coreComponents["responses"]["Forbidden"];
|
|
12952
13069
|
};
|
|
12953
13070
|
};
|
|
12954
|
-
/** Retrieve a list of customer timeline messages for all customers. */
|
|
12955
|
-
GetCustomerTimelineEventCollection: {
|
|
12956
|
-
parameters: {
|
|
12957
|
-
query: {
|
|
12958
|
-
/** The collection items limit. */
|
|
12959
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
12960
|
-
/** The collection items offset. */
|
|
12961
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
12962
|
-
/**
|
|
12963
|
-
* The collection items filter requires a special format.
|
|
12964
|
-
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
12965
|
-
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
12966
|
-
*/
|
|
12967
|
-
filter?: coreComponents["parameters"]["collectionFilter"];
|
|
12968
|
-
};
|
|
12969
|
-
};
|
|
12970
|
-
responses: {
|
|
12971
|
-
/** A list of customer timeline messages was retrieved successfully. */
|
|
12972
|
-
200: {
|
|
12973
|
-
headers: {};
|
|
12974
|
-
content: {
|
|
12975
|
-
"application/json": coreComponents["schemas"]["CustomerTimeline"][];
|
|
12976
|
-
};
|
|
12977
|
-
};
|
|
12978
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
12979
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
12980
|
-
};
|
|
12981
|
-
};
|
|
12982
13071
|
/**
|
|
12983
13072
|
* Search customer in multiple PEP/Sanctions/Adverse Media lists to find any blocklisted identities.
|
|
12984
13073
|
* Performs a fuzzy search including soundex. Not all fields are guaranteed to be filled.
|
|
@@ -14285,12 +14374,18 @@ export interface operations {
|
|
|
14285
14374
|
};
|
|
14286
14375
|
};
|
|
14287
14376
|
responses: {
|
|
14288
|
-
/** Credit memo was
|
|
14377
|
+
/** Credit memo allocation was updated. */
|
|
14289
14378
|
200: {
|
|
14290
14379
|
content: {
|
|
14291
14380
|
"application/json": coreComponents["schemas"]["CreditMemoAllocation"];
|
|
14292
14381
|
};
|
|
14293
14382
|
};
|
|
14383
|
+
/** Credit memo allocation was created. */
|
|
14384
|
+
201: {
|
|
14385
|
+
content: {
|
|
14386
|
+
"application/json": coreComponents["schemas"]["CreditMemoAllocation"];
|
|
14387
|
+
};
|
|
14388
|
+
};
|
|
14294
14389
|
401: coreComponents["responses"]["Unauthorized"];
|
|
14295
14390
|
403: coreComponents["responses"]["Forbidden"];
|
|
14296
14391
|
404: coreComponents["responses"]["NotFound"];
|
|
@@ -14361,8 +14456,7 @@ export interface operations {
|
|
|
14361
14456
|
* After the customer completes the KYC process, they will be redirected back to the `redirectUrl`.
|
|
14362
14457
|
* Corresponding webhooks (such as KYC document accepted, KYC document rejected) are sent to webhooks subscribers.
|
|
14363
14458
|
* When the complete list of documents is received and accepted, the KYC request fulfilled webhook will be sent to subscribers.
|
|
14364
|
-
* If a `credit-file-proof` is successful with the decision `single-source`, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
14365
|
-
* If a `credit-file-proof` is successful with the decision `dual-source`, then one of the corresponding `identity-proof` and `address-proof` documents are required.
|
|
14459
|
+
* If a `credit-file-proof` is successful with the decision `single-source` or `dual-source`, then corresponding `identity-proof` and `address-proof` documents are not requested.
|
|
14366
14460
|
*/
|
|
14367
14461
|
PostKycRequest: {
|
|
14368
14462
|
responses: {
|
|
@@ -14463,7 +14557,7 @@ export interface operations {
|
|
|
14463
14557
|
200: {
|
|
14464
14558
|
headers: {};
|
|
14465
14559
|
content: {
|
|
14466
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14560
|
+
"application/json": coreComponents["schemas"]["KycDocument"][];
|
|
14467
14561
|
};
|
|
14468
14562
|
};
|
|
14469
14563
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14476,7 +14570,7 @@ export interface operations {
|
|
|
14476
14570
|
/** Kyc document was created. */
|
|
14477
14571
|
201: {
|
|
14478
14572
|
content: {
|
|
14479
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14573
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14480
14574
|
};
|
|
14481
14575
|
};
|
|
14482
14576
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14486,7 +14580,7 @@ export interface operations {
|
|
|
14486
14580
|
/** Kyc document resource. */
|
|
14487
14581
|
requestBody: {
|
|
14488
14582
|
content: {
|
|
14489
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14583
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14490
14584
|
};
|
|
14491
14585
|
};
|
|
14492
14586
|
};
|
|
@@ -14502,7 +14596,7 @@ export interface operations {
|
|
|
14502
14596
|
/** KYC document was retrieved successfully. */
|
|
14503
14597
|
200: {
|
|
14504
14598
|
content: {
|
|
14505
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14599
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14506
14600
|
};
|
|
14507
14601
|
};
|
|
14508
14602
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14522,13 +14616,13 @@ export interface operations {
|
|
|
14522
14616
|
/** KYC document was updated. */
|
|
14523
14617
|
200: {
|
|
14524
14618
|
content: {
|
|
14525
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14619
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14526
14620
|
};
|
|
14527
14621
|
};
|
|
14528
14622
|
/** KYC document was created. */
|
|
14529
14623
|
201: {
|
|
14530
14624
|
content: {
|
|
14531
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14625
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14532
14626
|
};
|
|
14533
14627
|
};
|
|
14534
14628
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14539,7 +14633,7 @@ export interface operations {
|
|
|
14539
14633
|
/** KYC document resource. */
|
|
14540
14634
|
requestBody: {
|
|
14541
14635
|
content: {
|
|
14542
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14636
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14543
14637
|
};
|
|
14544
14638
|
};
|
|
14545
14639
|
};
|
|
@@ -14555,7 +14649,7 @@ export interface operations {
|
|
|
14555
14649
|
/** KYC document acceptance was created. */
|
|
14556
14650
|
201: {
|
|
14557
14651
|
content: {
|
|
14558
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14652
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14559
14653
|
};
|
|
14560
14654
|
};
|
|
14561
14655
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14598,7 +14692,7 @@ export interface operations {
|
|
|
14598
14692
|
/** KYC document rejection was created. */
|
|
14599
14693
|
201: {
|
|
14600
14694
|
content: {
|
|
14601
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14695
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14602
14696
|
};
|
|
14603
14697
|
};
|
|
14604
14698
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14625,7 +14719,7 @@ export interface operations {
|
|
|
14625
14719
|
/** KYC document was reviewed. */
|
|
14626
14720
|
201: {
|
|
14627
14721
|
content: {
|
|
14628
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14722
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14629
14723
|
};
|
|
14630
14724
|
};
|
|
14631
14725
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14646,7 +14740,7 @@ export interface operations {
|
|
|
14646
14740
|
/** KYC document review started. */
|
|
14647
14741
|
201: {
|
|
14648
14742
|
content: {
|
|
14649
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14743
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14650
14744
|
};
|
|
14651
14745
|
};
|
|
14652
14746
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14667,7 +14761,7 @@ export interface operations {
|
|
|
14667
14761
|
/** KYC document review stopped. */
|
|
14668
14762
|
201: {
|
|
14669
14763
|
content: {
|
|
14670
|
-
"application/json": coreComponents["schemas"]["KycDocument
|
|
14764
|
+
"application/json": coreComponents["schemas"]["KycDocument"];
|
|
14671
14765
|
};
|
|
14672
14766
|
};
|
|
14673
14767
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14820,7 +14914,7 @@ export interface operations {
|
|
|
14820
14914
|
200: {
|
|
14821
14915
|
headers: {};
|
|
14822
14916
|
content: {
|
|
14823
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
14917
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"][];
|
|
14824
14918
|
};
|
|
14825
14919
|
};
|
|
14826
14920
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14837,14 +14931,14 @@ export interface operations {
|
|
|
14837
14931
|
/** Payment instrument was created. */
|
|
14838
14932
|
201: {
|
|
14839
14933
|
content: {
|
|
14840
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
14934
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"];
|
|
14841
14935
|
};
|
|
14842
14936
|
};
|
|
14843
14937
|
/** Payment instrument was updated. */
|
|
14844
14938
|
303: {
|
|
14845
14939
|
headers: {};
|
|
14846
14940
|
content: {
|
|
14847
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
14941
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"];
|
|
14848
14942
|
};
|
|
14849
14943
|
};
|
|
14850
14944
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14865,7 +14959,7 @@ export interface operations {
|
|
|
14865
14959
|
/** Payment Instrument was retrieved successfully. */
|
|
14866
14960
|
200: {
|
|
14867
14961
|
content: {
|
|
14868
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
14962
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"];
|
|
14869
14963
|
};
|
|
14870
14964
|
};
|
|
14871
14965
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14885,7 +14979,7 @@ export interface operations {
|
|
|
14885
14979
|
/** Payment instrument was updated. */
|
|
14886
14980
|
200: {
|
|
14887
14981
|
content: {
|
|
14888
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
14982
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"];
|
|
14889
14983
|
};
|
|
14890
14984
|
};
|
|
14891
14985
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -14907,7 +15001,7 @@ export interface operations {
|
|
|
14907
15001
|
/** Payment instrument was deactivated. */
|
|
14908
15002
|
201: {
|
|
14909
15003
|
content: {
|
|
14910
|
-
"application/json": coreComponents["schemas"]["PaymentInstrument
|
|
15004
|
+
"application/json": coreComponents["schemas"]["PaymentInstrument"];
|
|
14911
15005
|
};
|
|
14912
15006
|
};
|
|
14913
15007
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -15337,10 +15431,14 @@ export interface operations {
|
|
|
15337
15431
|
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
15338
15432
|
* To expand multiple objects, it accepts a comma-separated list of objects (example: `expand=recentInvoice,initialInvoice`).
|
|
15339
15433
|
* Available arguments are:
|
|
15340
|
-
* - recentInvoice
|
|
15341
|
-
* - initialInvoice
|
|
15342
15434
|
* - customer
|
|
15435
|
+
* - leadSource
|
|
15343
15436
|
* - website
|
|
15437
|
+
* - shippingRate
|
|
15438
|
+
* - initialInvoice
|
|
15439
|
+
* - recentInvoice
|
|
15440
|
+
* - upcomingInvoice
|
|
15441
|
+
* - paymentInstrument
|
|
15344
15442
|
*
|
|
15345
15443
|
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
15346
15444
|
*/
|
|
@@ -15370,10 +15468,14 @@ export interface operations {
|
|
|
15370
15468
|
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
15371
15469
|
* To expand multiple objects, it accepts a comma-separated list of objects (example: `expand=recentInvoice,initialInvoice`).
|
|
15372
15470
|
* Available arguments are:
|
|
15373
|
-
* - recentInvoice
|
|
15374
|
-
* - initialInvoice
|
|
15375
15471
|
* - customer
|
|
15472
|
+
* - leadSource
|
|
15376
15473
|
* - website
|
|
15474
|
+
* - shippingRate
|
|
15475
|
+
* - initialInvoice
|
|
15476
|
+
* - recentInvoice
|
|
15477
|
+
* - upcomingInvoice
|
|
15478
|
+
* - paymentInstrument
|
|
15377
15479
|
*
|
|
15378
15480
|
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
15379
15481
|
*/
|
|
@@ -15405,10 +15507,14 @@ export interface operations {
|
|
|
15405
15507
|
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
15406
15508
|
* To expand multiple objects, it accepts a comma-separated list of objects (example: `expand=recentInvoice,initialInvoice`).
|
|
15407
15509
|
* Available arguments are:
|
|
15408
|
-
* - recentInvoice
|
|
15409
|
-
* - initialInvoice
|
|
15410
15510
|
* - customer
|
|
15511
|
+
* - leadSource
|
|
15411
15512
|
* - website
|
|
15513
|
+
* - shippingRate
|
|
15514
|
+
* - initialInvoice
|
|
15515
|
+
* - recentInvoice
|
|
15516
|
+
* - upcomingInvoice
|
|
15517
|
+
* - paymentInstrument
|
|
15412
15518
|
*
|
|
15413
15519
|
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
15414
15520
|
*/
|
|
@@ -15439,10 +15545,14 @@ export interface operations {
|
|
|
15439
15545
|
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
15440
15546
|
* To expand multiple objects, it accepts a comma-separated list of objects (example: `expand=recentInvoice,initialInvoice`).
|
|
15441
15547
|
* Available arguments are:
|
|
15442
|
-
* - recentInvoice
|
|
15443
|
-
* - initialInvoice
|
|
15444
15548
|
* - customer
|
|
15549
|
+
* - leadSource
|
|
15445
15550
|
* - website
|
|
15551
|
+
* - shippingRate
|
|
15552
|
+
* - initialInvoice
|
|
15553
|
+
* - recentInvoice
|
|
15554
|
+
* - upcomingInvoice
|
|
15555
|
+
* - paymentInstrument
|
|
15446
15556
|
*
|
|
15447
15557
|
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
15448
15558
|
*/
|
|
@@ -17015,7 +17125,7 @@ export interface operations {
|
|
|
17015
17125
|
403: coreComponents["responses"]["Forbidden"];
|
|
17016
17126
|
};
|
|
17017
17127
|
};
|
|
17018
|
-
/** Create
|
|
17128
|
+
/** Create an EDD Timeline comment or custom defined event. */
|
|
17019
17129
|
PostEddTimeline: {
|
|
17020
17130
|
parameters: {
|
|
17021
17131
|
path: {
|
|
@@ -17439,7 +17549,7 @@ export interface usersPaths {
|
|
|
17439
17549
|
};
|
|
17440
17550
|
"/email-delivery-setting-verifications/{token}": {
|
|
17441
17551
|
/** Verify an email delivery setting. */
|
|
17442
|
-
put: operations["
|
|
17552
|
+
put: operations["PutEmailDeliverySettingsVerification"];
|
|
17443
17553
|
parameters: {
|
|
17444
17554
|
path: {
|
|
17445
17555
|
/** The token string. */
|
|
@@ -17468,7 +17578,7 @@ export interface usersPaths {
|
|
|
17468
17578
|
};
|
|
17469
17579
|
"/email-delivery-settings/{id}/resend-email-verification": {
|
|
17470
17580
|
/** Resend verification email for an email delivery setting. */
|
|
17471
|
-
post: operations["
|
|
17581
|
+
post: operations["PostResendEmailDeliverySettingVerification"];
|
|
17472
17582
|
parameters: {
|
|
17473
17583
|
path: {
|
|
17474
17584
|
/** The resource identifier string. */
|
|
@@ -18018,7 +18128,7 @@ export interface usersPaths {
|
|
|
18018
18128
|
"/roles": {
|
|
18019
18129
|
/** Retrieve a list of roles. */
|
|
18020
18130
|
get: operations["GetRoleCollection"];
|
|
18021
|
-
/** Create a
|
|
18131
|
+
/** Create a role to be used when assigning permissions to users. */
|
|
18022
18132
|
post: operations["PostRole"];
|
|
18023
18133
|
};
|
|
18024
18134
|
"/roles/{id}": {
|
|
@@ -18084,6 +18194,7 @@ export interface usersPaths {
|
|
|
18084
18194
|
};
|
|
18085
18195
|
};
|
|
18086
18196
|
"/tracking/webhooks/{id}/resend": {
|
|
18197
|
+
/** Webhooks are processed asynchronously. This operation schedules a resend attempt for a given webhook tracking ID. */
|
|
18087
18198
|
post: operations["PostTrackingWebhookResendRequest"];
|
|
18088
18199
|
parameters: {
|
|
18089
18200
|
path: {
|
|
@@ -18178,6 +18289,25 @@ export interface usersPaths {
|
|
|
18178
18289
|
};
|
|
18179
18290
|
};
|
|
18180
18291
|
};
|
|
18292
|
+
"/organization-exports": {
|
|
18293
|
+
/** Retrieve a list of organization data exports. */
|
|
18294
|
+
get: operations["GetOrganizationExportCollection"];
|
|
18295
|
+
/**
|
|
18296
|
+
* Request an organization data export.
|
|
18297
|
+
* The data export is asynchronously processed.
|
|
18298
|
+
*/
|
|
18299
|
+
post: operations["PostOrganizationExport"];
|
|
18300
|
+
};
|
|
18301
|
+
"/organization-exports/{id}": {
|
|
18302
|
+
/** Retrieve an organization data export request. */
|
|
18303
|
+
get: operations["GetOrganizationExport"];
|
|
18304
|
+
parameters: {
|
|
18305
|
+
path: {
|
|
18306
|
+
/** The resource identifier string. */
|
|
18307
|
+
id: usersComponents["parameters"]["resourceId"];
|
|
18308
|
+
};
|
|
18309
|
+
};
|
|
18310
|
+
};
|
|
18181
18311
|
}
|
|
18182
18312
|
|
|
18183
18313
|
export interface usersComponents {
|
|
@@ -18293,6 +18423,7 @@ export interface usersComponents {
|
|
|
18293
18423
|
| "Apple Pay"
|
|
18294
18424
|
| "AstroPay Card"
|
|
18295
18425
|
| "AstroPay-GO"
|
|
18426
|
+
| "BankSEND"
|
|
18296
18427
|
| "BankReferenced"
|
|
18297
18428
|
| "bank-transfer"
|
|
18298
18429
|
| "bank-transfer-2"
|
|
@@ -18459,7 +18590,7 @@ export interface usersComponents {
|
|
|
18459
18590
|
AlternativePaymentInstrument: {
|
|
18460
18591
|
method: usersComponents["schemas"]["PaymentMethod"];
|
|
18461
18592
|
/** The payment instrument ID. */
|
|
18462
|
-
paymentInstrumentId?:
|
|
18593
|
+
paymentInstrumentId?: usersComponents["schemas"]["ResourceId"];
|
|
18463
18594
|
};
|
|
18464
18595
|
/** Cash payment instrument object. */
|
|
18465
18596
|
CashInstrument: {
|
|
@@ -18473,7 +18604,9 @@ export interface usersComponents {
|
|
|
18473
18604
|
/** Reference data. */
|
|
18474
18605
|
reference?: string;
|
|
18475
18606
|
};
|
|
18476
|
-
|
|
18607
|
+
PaymentInstrumentValueObject: Partial<
|
|
18608
|
+
usersComponents["schemas"]["VaultedInstrument"]
|
|
18609
|
+
> &
|
|
18477
18610
|
Partial<usersComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
18478
18611
|
Partial<usersComponents["schemas"]["CashInstrument"]> &
|
|
18479
18612
|
Partial<usersComponents["schemas"]["CheckInstrument"]>;
|
|
@@ -18623,7 +18756,7 @@ export interface usersComponents {
|
|
|
18623
18756
|
* before it is expired.
|
|
18624
18757
|
*/
|
|
18625
18758
|
paymentToken?: string;
|
|
18626
|
-
defaultPaymentInstrument?: usersComponents["schemas"]["
|
|
18759
|
+
defaultPaymentInstrument?: usersComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
18627
18760
|
/** The customer created time. */
|
|
18628
18761
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18629
18762
|
/** The customer updated time. */
|
|
@@ -18690,7 +18823,7 @@ export interface usersComponents {
|
|
|
18690
18823
|
/** Data table footer. */
|
|
18691
18824
|
footer?: string;
|
|
18692
18825
|
};
|
|
18693
|
-
"three-columns": usersComponents["schemas"]["TimelineTable"] & {
|
|
18826
|
+
"three-columns-timeline-table": usersComponents["schemas"]["TimelineTable"] & {
|
|
18694
18827
|
/** Table data. Each array element represents a table row. */
|
|
18695
18828
|
data?: {
|
|
18696
18829
|
attribute?: string;
|
|
@@ -18698,21 +18831,21 @@ export interface usersComponents {
|
|
|
18698
18831
|
newValue?: string;
|
|
18699
18832
|
}[];
|
|
18700
18833
|
};
|
|
18701
|
-
"two-columns": usersComponents["schemas"]["TimelineTable"] & {
|
|
18834
|
+
"two-columns-timeline-table": usersComponents["schemas"]["TimelineTable"] & {
|
|
18702
18835
|
/** Table data. Each array element represents a table row. */
|
|
18703
18836
|
data?: {
|
|
18704
18837
|
attribute?: string;
|
|
18705
18838
|
value?: string;
|
|
18706
18839
|
}[];
|
|
18707
18840
|
};
|
|
18708
|
-
"one-column": usersComponents["schemas"]["TimelineTable"] & {
|
|
18841
|
+
"one-column-timeline-table": usersComponents["schemas"]["TimelineTable"] & {
|
|
18709
18842
|
/** Table data. Each array element represents a table row. */
|
|
18710
18843
|
data?: {
|
|
18711
18844
|
attribute?: string;
|
|
18712
18845
|
value?: string;
|
|
18713
18846
|
}[];
|
|
18714
18847
|
};
|
|
18715
|
-
list: usersComponents["schemas"]["TimelineTable"] & {
|
|
18848
|
+
"list-timeline-table": usersComponents["schemas"]["TimelineTable"] & {
|
|
18716
18849
|
/** Table data. Each array element represents a line. */
|
|
18717
18850
|
data?: string[];
|
|
18718
18851
|
};
|
|
@@ -18780,6 +18913,7 @@ export interface usersComponents {
|
|
|
18780
18913
|
| "AuthorizeNet"
|
|
18781
18914
|
| "Awepay"
|
|
18782
18915
|
| "Bambora"
|
|
18916
|
+
| "BankSEND"
|
|
18783
18917
|
| "BitPay"
|
|
18784
18918
|
| "BlueSnap"
|
|
18785
18919
|
| "BraintreePayments"
|
|
@@ -18866,6 +19000,7 @@ export interface usersComponents {
|
|
|
18866
19000
|
| "NGenius"
|
|
18867
19001
|
| "NinjaWallet"
|
|
18868
19002
|
| "NMI"
|
|
19003
|
+
| "NOWPayments"
|
|
18869
19004
|
| "NuaPay"
|
|
18870
19005
|
| "OchaPay"
|
|
18871
19006
|
| "Onlineueberweisen"
|
|
@@ -18887,6 +19022,7 @@ export interface usersComponents {
|
|
|
18887
19022
|
| "PaymentsOS"
|
|
18888
19023
|
| "Paymero"
|
|
18889
19024
|
| "PayPal"
|
|
19025
|
+
| "Payper"
|
|
18890
19026
|
| "Payr"
|
|
18891
19027
|
| "Paysafe"
|
|
18892
19028
|
| "Paysafecard"
|
|
@@ -19052,6 +19188,7 @@ export interface usersComponents {
|
|
|
19052
19188
|
| "Bank of Moscow"
|
|
19053
19189
|
| "Bank of Rebilly"
|
|
19054
19190
|
| "Bank One"
|
|
19191
|
+
| "BankSEND"
|
|
19055
19192
|
| "BMO Harris Bank"
|
|
19056
19193
|
| "Borgun"
|
|
19057
19194
|
| "BraintreePayments"
|
|
@@ -19134,6 +19271,7 @@ export interface usersComponents {
|
|
|
19134
19271
|
| "Neteller"
|
|
19135
19272
|
| "NinjaWallet"
|
|
19136
19273
|
| "NMI"
|
|
19274
|
+
| "NOWPayments"
|
|
19137
19275
|
| "NuaPay"
|
|
19138
19276
|
| "Nuvei"
|
|
19139
19277
|
| "OchaPay"
|
|
@@ -19154,6 +19292,7 @@ export interface usersComponents {
|
|
|
19154
19292
|
| "Paymero"
|
|
19155
19293
|
| "Paynetics"
|
|
19156
19294
|
| "PayPal"
|
|
19295
|
+
| "Payper"
|
|
19157
19296
|
| "Payr"
|
|
19158
19297
|
| "PayTabs"
|
|
19159
19298
|
| "PayULatam"
|
|
@@ -19436,7 +19575,7 @@ export interface usersComponents {
|
|
|
19436
19575
|
referenceData?: { [key: string]: string } | null;
|
|
19437
19576
|
/** Payment Card BIN. */
|
|
19438
19577
|
bin?: string;
|
|
19439
|
-
paymentInstrument?: usersComponents["schemas"]["
|
|
19578
|
+
paymentInstrument?: usersComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
19440
19579
|
/** True if transaction has Dynamic Currency Conversion applied. */
|
|
19441
19580
|
hasDcc?: boolean;
|
|
19442
19581
|
/** Dynamic Currency Conversion detailed information. Null if hasDcc is false. */
|
|
@@ -19901,6 +20040,14 @@ export interface usersComponents {
|
|
|
19901
20040
|
apiPasscode: string;
|
|
19902
20041
|
};
|
|
19903
20042
|
};
|
|
20043
|
+
/** BankSEND config. */
|
|
20044
|
+
BankSEND: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20045
|
+
/** BankSEND credentials object. */
|
|
20046
|
+
credentials: {
|
|
20047
|
+
merchantId: string;
|
|
20048
|
+
merchantToken: string;
|
|
20049
|
+
};
|
|
20050
|
+
};
|
|
19904
20051
|
/** BitPay Gateway config. */
|
|
19905
20052
|
BitPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
19906
20053
|
/** BitPay credentials object. */
|
|
@@ -21053,6 +21200,18 @@ export interface usersComponents {
|
|
|
21053
21200
|
passphrase: string;
|
|
21054
21201
|
};
|
|
21055
21202
|
};
|
|
21203
|
+
/** NOWPayments config. */
|
|
21204
|
+
NOWPayments: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21205
|
+
/** NOWPayments credentials object. */
|
|
21206
|
+
credentials: {
|
|
21207
|
+
apiKey: string;
|
|
21208
|
+
ipnSecret: string;
|
|
21209
|
+
};
|
|
21210
|
+
/** NOWPayments settings object. */
|
|
21211
|
+
settings?: {
|
|
21212
|
+
tolerancePercentage: usersComponents["schemas"]["AmountAdjustmentTolerance"];
|
|
21213
|
+
};
|
|
21214
|
+
};
|
|
21056
21215
|
/** NuaPay Gateway config. */
|
|
21057
21216
|
NuaPay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21058
21217
|
/** NuaPay credentials object. */
|
|
@@ -21721,6 +21880,10 @@ export interface usersComponents {
|
|
|
21721
21880
|
/** Password used during MQI/API requests. */
|
|
21722
21881
|
mqiPassword?: string;
|
|
21723
21882
|
};
|
|
21883
|
+
settings?: {
|
|
21884
|
+
/** A comma-separated list of name-value merchant field pairs (key1:value1,key2:value2). */
|
|
21885
|
+
merchantFields?: string;
|
|
21886
|
+
};
|
|
21724
21887
|
};
|
|
21725
21888
|
/** SmartInvoice 3DS Servers. */
|
|
21726
21889
|
SmartInvoice3dsServers: {
|
|
@@ -22561,6 +22724,25 @@ export interface usersComponents {
|
|
|
22561
22724
|
description: string;
|
|
22562
22725
|
/** Tax rate. */
|
|
22563
22726
|
rate?: number | null;
|
|
22727
|
+
/** Amount of sales tax to collect for the state. */
|
|
22728
|
+
stateAmount?: number | null;
|
|
22729
|
+
/** Amount of sales tax to collect for the county. */
|
|
22730
|
+
countyAmount?: number | null;
|
|
22731
|
+
/** Amount of sales tax to collect for the city. */
|
|
22732
|
+
cityAmount?: number | null;
|
|
22733
|
+
/** Amount of sales tax to collect for the special district. */
|
|
22734
|
+
specialDistrictAmount?: number | null;
|
|
22735
|
+
/** Jurisdiction names for the invoice. */
|
|
22736
|
+
jurisdictions?: {
|
|
22737
|
+
/** Two-letter ISO country code for the provided location. */
|
|
22738
|
+
country?: string | null;
|
|
22739
|
+
/** Postal abbreviated state name for the provided location. */
|
|
22740
|
+
state?: string | null;
|
|
22741
|
+
/** County name for the provided location. */
|
|
22742
|
+
county?: string | null;
|
|
22743
|
+
/** City name for the provided location. */
|
|
22744
|
+
city?: string | null;
|
|
22745
|
+
} | null;
|
|
22564
22746
|
};
|
|
22565
22747
|
/** Manually set tax items. */
|
|
22566
22748
|
manual: usersComponents["schemas"]["InvoiceTax"] & {
|
|
@@ -22944,8 +23126,8 @@ export interface usersComponents {
|
|
|
22944
23126
|
| "draft"
|
|
22945
23127
|
| "unpaid"
|
|
22946
23128
|
| "paid"
|
|
23129
|
+
| "partially-paid"
|
|
22947
23130
|
| "past-due"
|
|
22948
|
-
| "delinquent"
|
|
22949
23131
|
| "abandoned"
|
|
22950
23132
|
| "voided"
|
|
22951
23133
|
| "partially-refunded"
|
|
@@ -23095,75 +23277,6 @@ export interface usersComponents {
|
|
|
23095
23277
|
/** Desired time to go live. */
|
|
23096
23278
|
launchTiming?: string;
|
|
23097
23279
|
};
|
|
23098
|
-
KycSettingsIdentity: {
|
|
23099
|
-
/** The weights of all matched properties. */
|
|
23100
|
-
weights?: {
|
|
23101
|
-
/** The weight of containsImage. */
|
|
23102
|
-
containsImage?: number;
|
|
23103
|
-
/** The weight of isIdentityDocument. */
|
|
23104
|
-
isIdentityDocument?: number;
|
|
23105
|
-
/** The weight of isPublishedOnline. */
|
|
23106
|
-
isPublishedOnline?: number;
|
|
23107
|
-
/** The weight of firstName. */
|
|
23108
|
-
firstName?: number;
|
|
23109
|
-
/** The weight of lastName. */
|
|
23110
|
-
lastName?: number;
|
|
23111
|
-
/** The weight of `expirationDate`. */
|
|
23112
|
-
expirationDate?: number;
|
|
23113
|
-
/** The weight of dateOfBirth. */
|
|
23114
|
-
dateOfBirth?: number;
|
|
23115
|
-
/** The weight of matchesDateOfBirth. */
|
|
23116
|
-
matchesDateOfBirth?: number;
|
|
23117
|
-
/** The weight of issueDate. */
|
|
23118
|
-
issueDate?: number;
|
|
23119
|
-
/** The weight of hasMinimalAge. */
|
|
23120
|
-
hasMinimalAge?: number;
|
|
23121
|
-
/** The weight of hasMatchingFaceProof. */
|
|
23122
|
-
hasMatchingFaceProof?: number;
|
|
23123
|
-
/** The weight of nationality. */
|
|
23124
|
-
nationality?: number;
|
|
23125
|
-
};
|
|
23126
|
-
/** The thresholds to determine the document status. */
|
|
23127
|
-
thresholds?: {
|
|
23128
|
-
/** The weight of rejectBelow. */
|
|
23129
|
-
rejectBelow?: number;
|
|
23130
|
-
/** The weight of acceptAbove. */
|
|
23131
|
-
acceptAbove?: number;
|
|
23132
|
-
};
|
|
23133
|
-
};
|
|
23134
|
-
KycSettingsAddress: {
|
|
23135
|
-
/** The weights of all matched properties. */
|
|
23136
|
-
weights?: {
|
|
23137
|
-
/** The weight of firstName. */
|
|
23138
|
-
firstName?: number;
|
|
23139
|
-
/** The weight of lastName. */
|
|
23140
|
-
lastName?: number;
|
|
23141
|
-
/** The weight of line1. */
|
|
23142
|
-
line1?: number;
|
|
23143
|
-
/** The weight of city. */
|
|
23144
|
-
city?: number;
|
|
23145
|
-
/** The weight of region. */
|
|
23146
|
-
region?: number;
|
|
23147
|
-
/** The weight of postalCode. */
|
|
23148
|
-
postalCode?: number;
|
|
23149
|
-
/** The weight of date. */
|
|
23150
|
-
date?: number;
|
|
23151
|
-
/** The weight of phone. */
|
|
23152
|
-
phone?: number;
|
|
23153
|
-
};
|
|
23154
|
-
/** The thresholds to determine the document status. */
|
|
23155
|
-
thresholds?: {
|
|
23156
|
-
/** The weight of rejectBelow. */
|
|
23157
|
-
rejectBelow?: number;
|
|
23158
|
-
/** The weight of acceptAbove. */
|
|
23159
|
-
acceptAbove?: number;
|
|
23160
|
-
};
|
|
23161
|
-
};
|
|
23162
|
-
/** The settings for score calculation. */
|
|
23163
|
-
KycSettings: {
|
|
23164
|
-
identityProof?: usersComponents["schemas"]["KycSettingsIdentity"];
|
|
23165
|
-
addressProof?: usersComponents["schemas"]["KycSettingsAddress"];
|
|
23166
|
-
};
|
|
23167
23280
|
TaxLocation: {
|
|
23168
23281
|
/** The tax location street address. */
|
|
23169
23282
|
address?: string;
|
|
@@ -23184,7 +23297,6 @@ export interface usersComponents {
|
|
|
23184
23297
|
/** The rate for flat tax calculation. */
|
|
23185
23298
|
rate?: number | null;
|
|
23186
23299
|
};
|
|
23187
|
-
kyc?: usersComponents["schemas"]["KycSettings"];
|
|
23188
23300
|
/**
|
|
23189
23301
|
* Additional organization addresses where a merchant may wish to collect taxes using the `taxjar` tax calculator.
|
|
23190
23302
|
* Available only for US-based organizations.
|
|
@@ -23194,12 +23306,10 @@ export interface usersComponents {
|
|
|
23194
23306
|
Organization: {
|
|
23195
23307
|
/** The organization identifier string. */
|
|
23196
23308
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
23197
|
-
/** The organization created time. */
|
|
23198
|
-
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23199
|
-
/** The organization updated time. */
|
|
23200
|
-
updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23201
23309
|
/** The organization name. */
|
|
23202
23310
|
name: string;
|
|
23311
|
+
/** The organization website. */
|
|
23312
|
+
website?: string;
|
|
23203
23313
|
/** The organization street address. */
|
|
23204
23314
|
address?: string;
|
|
23205
23315
|
/** The organization street address. */
|
|
@@ -23222,6 +23332,10 @@ export interface usersComponents {
|
|
|
23222
23332
|
isPrimary?: boolean;
|
|
23223
23333
|
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
23224
23334
|
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
23335
|
+
/** The organization created time. */
|
|
23336
|
+
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23337
|
+
/** The organization updated time. */
|
|
23338
|
+
updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23225
23339
|
/** The links related to resource. */
|
|
23226
23340
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23227
23341
|
};
|
|
@@ -23416,6 +23530,45 @@ export interface usersComponents {
|
|
|
23416
23530
|
/** The link type. */
|
|
23417
23531
|
rel: "invoice";
|
|
23418
23532
|
};
|
|
23533
|
+
KycDocumentTypes:
|
|
23534
|
+
| "identity-proof"
|
|
23535
|
+
| "address-proof"
|
|
23536
|
+
| "funds-proof"
|
|
23537
|
+
| "purchase-proof"
|
|
23538
|
+
| "credit-file-proof";
|
|
23539
|
+
KycDocumentSubtypes:
|
|
23540
|
+
| "passport"
|
|
23541
|
+
| "id-card"
|
|
23542
|
+
| "driver-license"
|
|
23543
|
+
| "birth-certificate"
|
|
23544
|
+
| "utility-bill"
|
|
23545
|
+
| "rental-receipt"
|
|
23546
|
+
| "lease-agreement"
|
|
23547
|
+
| "copy-credit-card"
|
|
23548
|
+
| "credit-card-statement"
|
|
23549
|
+
| "bank-statement"
|
|
23550
|
+
| "inheritance-documentation"
|
|
23551
|
+
| "tax-return"
|
|
23552
|
+
| "salary-slip"
|
|
23553
|
+
| "sale-of-assets"
|
|
23554
|
+
| "public-health-card"
|
|
23555
|
+
| "proof-of-age-card"
|
|
23556
|
+
| "reverse-of-id"
|
|
23557
|
+
| "public-service"
|
|
23558
|
+
| "ewallet-holder-details"
|
|
23559
|
+
| "ewallet-transaction-statement"
|
|
23560
|
+
| "other";
|
|
23561
|
+
/** Documents to request from the customer. */
|
|
23562
|
+
KycRequestDocuments: {
|
|
23563
|
+
/** Type of document to request from the customer. */
|
|
23564
|
+
type: usersComponents["schemas"]["KycDocumentTypes"];
|
|
23565
|
+
/** Allowed document subtype. */
|
|
23566
|
+
subtypes?: usersComponents["schemas"]["KycDocumentSubtypes"][];
|
|
23567
|
+
/** Total number of allowed document upload attempts. Use `0` to allow unlimited upload attempts. */
|
|
23568
|
+
maxAttempts: number;
|
|
23569
|
+
/** Specifies whether the customer must upload a photo of their face (selfie) that matches a provided KYC document. */
|
|
23570
|
+
faceProofRequired?: boolean;
|
|
23571
|
+
}[];
|
|
23419
23572
|
AlternativePaymentMethods:
|
|
23420
23573
|
| "cash"
|
|
23421
23574
|
| "check"
|
|
@@ -23666,6 +23819,8 @@ export interface usersComponents {
|
|
|
23666
23819
|
slug: string;
|
|
23667
23820
|
/** Billing portal website ID. */
|
|
23668
23821
|
websiteId: usersComponents["schemas"]["ResourceId"];
|
|
23822
|
+
/** Custom domain for the billing portal. */
|
|
23823
|
+
customDomain?: string | null;
|
|
23669
23824
|
/** Various features that can be enabled for the billing portal. */
|
|
23670
23825
|
features?: {
|
|
23671
23826
|
/** Enable or disable a customer ability to authenticate with a password. */
|
|
@@ -23807,7 +23962,9 @@ export interface usersComponents {
|
|
|
23807
23962
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
23808
23963
|
/** Checkout form website ID. */
|
|
23809
23964
|
websiteId: string;
|
|
23810
|
-
/**
|
|
23965
|
+
/** Custom domain for the checkout form. */
|
|
23966
|
+
customDomain?: string | null;
|
|
23967
|
+
/** List of plans that are applied to a customer order by default. */
|
|
23811
23968
|
plans: usersComponents["schemas"]["CheckoutFormPlans"];
|
|
23812
23969
|
/**
|
|
23813
23970
|
* The list of independent addons.
|
|
@@ -23877,16 +24034,23 @@ export interface usersComponents {
|
|
|
23877
24034
|
/** Checkout form updated time. */
|
|
23878
24035
|
updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23879
24036
|
};
|
|
24037
|
+
PreviewLink: usersComponents["schemas"]["Link"] & {
|
|
24038
|
+
/** The link type. */
|
|
24039
|
+
rel: "preview";
|
|
24040
|
+
};
|
|
23880
24041
|
CheckoutForm: usersComponents["schemas"]["CommonCheckoutForm"] & {
|
|
23881
24042
|
/** Checkout form name, used for internal display to help you organize your various checkout forms. Will not be displayed to your customers. */
|
|
23882
24043
|
name: string;
|
|
23883
24044
|
/** If `inactive`, the checkout form url will result in a 404. */
|
|
23884
24045
|
status: "active" | "inactive";
|
|
24046
|
+
/** Links associated with the resource. */
|
|
24047
|
+
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
24048
|
+
Partial<usersComponents["schemas"]["PreviewLink"]>)[];
|
|
23885
24049
|
};
|
|
23886
24050
|
Credential: {
|
|
23887
24051
|
hash?: usersComponents["schemas"]["ResourceId"];
|
|
23888
24052
|
/** The credential status. */
|
|
23889
|
-
status?: "active" | "deactivated";
|
|
24053
|
+
status?: "active" | "inactive" | "deactivated";
|
|
23890
24054
|
/** The time when the credential was deactivated. */
|
|
23891
24055
|
deactivationTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23892
24056
|
};
|
|
@@ -24297,14 +24461,14 @@ export interface usersComponents {
|
|
|
24297
24461
|
/** Skip invoices with started service period. */
|
|
24298
24462
|
skipStartedServicePeriod: boolean;
|
|
24299
24463
|
};
|
|
24300
|
-
/** Create an Intuit
|
|
24464
|
+
/** Create an Intuit QuickBooks balance transaction entry. */
|
|
24301
24465
|
"create-intuit-quickbooks-balance-transaction-entry": usersComponents["schemas"]["RuleAction"] & {
|
|
24302
|
-
/** The debit
|
|
24466
|
+
/** The debit QuickBooks account ID. */
|
|
24303
24467
|
debitAccount: string;
|
|
24304
|
-
/** The credit
|
|
24468
|
+
/** The credit QuickBooks account ID. */
|
|
24305
24469
|
creditAccount: string;
|
|
24306
24470
|
/**
|
|
24307
|
-
* The
|
|
24471
|
+
* The QuickBooks balance transaction entry description.
|
|
24308
24472
|
*
|
|
24309
24473
|
* For example, `Balance transaction of type {{ balanceTransaction.type }} for transaction #{{ transaction.id }}`.
|
|
24310
24474
|
*/
|
|
@@ -24330,56 +24494,56 @@ export interface usersComponents {
|
|
|
24330
24494
|
/** The tax line description. Used when `taxesAccount` is set. */
|
|
24331
24495
|
taxLineDescription: string;
|
|
24332
24496
|
};
|
|
24333
|
-
/** Update an Intuit
|
|
24497
|
+
/** Update an Intuit QuickBooks invoice. */
|
|
24334
24498
|
"update-intuit-quickbooks-invoice": usersComponents["schemas"]["RuleAction"] & {
|
|
24335
|
-
/** The unearned revenue
|
|
24499
|
+
/** The unearned revenue QuickBooks account ID. */
|
|
24336
24500
|
unearnedRevenueAccount: string;
|
|
24337
|
-
/** The taxes
|
|
24501
|
+
/** The taxes QuickBooks account ID. If supplied taxes will be represented as separate line items instead of integrated tax field. */
|
|
24338
24502
|
taxesAccount?: string | null;
|
|
24339
|
-
/** The discounts
|
|
24503
|
+
/** The discounts QuickBooks account ID. If not set `unearnedRevenueAccount` will be used for discounts. */
|
|
24340
24504
|
discountsAccount?: string | null;
|
|
24341
|
-
/** The
|
|
24505
|
+
/** The QuickBooks department ID. */
|
|
24342
24506
|
department?: string | null;
|
|
24343
24507
|
template?: usersComponents["schemas"]["QuickbooksTemplate"];
|
|
24344
24508
|
/** OAuth2 credential identifier string. */
|
|
24345
24509
|
credentialHash: string;
|
|
24346
24510
|
};
|
|
24347
|
-
/** Create an Intuit
|
|
24511
|
+
/** Create an Intuit QuickBooks invoice. */
|
|
24348
24512
|
"create-intuit-quickbooks-invoice": usersComponents["schemas"]["update-intuit-quickbooks-invoice"] & {
|
|
24349
24513
|
/**
|
|
24350
|
-
*
|
|
24514
|
+
* Customer display name in QuickBooks. Duplicate names are mapped to a single QuickBooks customer.
|
|
24351
24515
|
*
|
|
24352
24516
|
* Event placeholders could be used as follows:
|
|
24353
|
-
* - Organization name: `{{ invoice.customer.
|
|
24517
|
+
* - Organization name: `{{ invoice.customer.primaryAddress.organization }}`;
|
|
24354
24518
|
* - Full customer name: `{{ invoice.customer.firstName }} {{ invoice.customer.lastName }}`;
|
|
24355
24519
|
* - Customer ID: `{{ invoice.customer.id }}`.
|
|
24356
24520
|
*/
|
|
24357
24521
|
customerDisplayName: string;
|
|
24358
24522
|
};
|
|
24359
|
-
/** Create an Intuit
|
|
24523
|
+
/** Create an Intuit QuickBooks payment. */
|
|
24360
24524
|
"create-intuit-quickbooks-payment": usersComponents["schemas"]["RuleAction"] & {
|
|
24361
|
-
/** The deposit
|
|
24525
|
+
/** The deposit QuickBooks account ID. */
|
|
24362
24526
|
depositAccount: string;
|
|
24363
24527
|
/** OAuth2 credential identifier string. */
|
|
24364
24528
|
credentialHash: string;
|
|
24365
24529
|
};
|
|
24366
|
-
/** Create an Intuit
|
|
24530
|
+
/** Create an Intuit QuickBooks refund receipt. */
|
|
24367
24531
|
"create-intuit-quickbooks-refund-receipt": usersComponents["schemas"]["RuleAction"] & {
|
|
24368
|
-
/** The deposit
|
|
24532
|
+
/** The deposit QuickBooks account ID. */
|
|
24369
24533
|
depositAccount: string;
|
|
24370
|
-
/** The
|
|
24534
|
+
/** The QuickBooks department ID. */
|
|
24371
24535
|
department?: string | null;
|
|
24372
24536
|
/** OAuth2 credential identifier string. */
|
|
24373
24537
|
credentialHash: string;
|
|
24374
24538
|
};
|
|
24375
|
-
/** Create an Intuit
|
|
24539
|
+
/** Create an Intuit QuickBooks revenue recognition entry. */
|
|
24376
24540
|
"create-intuit-quickbooks-revenue-recognition-entry": usersComponents["schemas"]["RuleAction"] & {
|
|
24377
|
-
/** The debit
|
|
24541
|
+
/** The debit QuickBooks account ID. */
|
|
24378
24542
|
debitAccount: string;
|
|
24379
|
-
/** The credit
|
|
24543
|
+
/** The credit QuickBooks account ID. */
|
|
24380
24544
|
creditAccount: string;
|
|
24381
24545
|
/**
|
|
24382
|
-
* The
|
|
24546
|
+
* The QuickBooks revenue recognition entry description.
|
|
24383
24547
|
*
|
|
24384
24548
|
* For example, `Revenue recognition for invoice #{{ invoice.id }} item #{{ item.id }} – {{ item.description }}`.
|
|
24385
24549
|
*/
|
|
@@ -24508,6 +24672,7 @@ export interface usersComponents {
|
|
|
24508
24672
|
};
|
|
24509
24673
|
/** Request KYC page to verify customer identity. */
|
|
24510
24674
|
"request-kyc": usersComponents["schemas"]["RuleAction"] & {
|
|
24675
|
+
documents: usersComponents["schemas"]["KycRequestDocuments"];
|
|
24511
24676
|
/** Who should be excluded from the verification. */
|
|
24512
24677
|
excludePolicy:
|
|
24513
24678
|
| "customers-with-accepted-document"
|
|
@@ -24532,8 +24697,6 @@ export interface usersComponents {
|
|
|
24532
24697
|
alternateGatewayAccountIfOptional?: string;
|
|
24533
24698
|
/** The currency three letter code to display on the bypass link, if optional. */
|
|
24534
24699
|
bypassCurrencyToDisplay: string;
|
|
24535
|
-
/** Maximum number of verification attempts per transaction. */
|
|
24536
|
-
maxAttempts: number;
|
|
24537
24700
|
};
|
|
24538
24701
|
"reset-reminder": usersComponents["schemas"]["RuleAction"] & {
|
|
24539
24702
|
/** The role of Reminder (available only on Order events, other events should use `all`). */
|
|
@@ -24669,7 +24832,7 @@ export interface usersComponents {
|
|
|
24669
24832
|
};
|
|
24670
24833
|
"trigger-webhook": usersComponents["schemas"]["RuleAction"] &
|
|
24671
24834
|
usersComponents["schemas"]["Webhook"];
|
|
24672
|
-
/** Void an Intuit
|
|
24835
|
+
/** Void an Intuit QuickBooks invoice. */
|
|
24673
24836
|
"void-intuit-quickbooks-invoice": usersComponents["schemas"]["RuleAction"] & {
|
|
24674
24837
|
/** OAuth2 credential identifier string. */
|
|
24675
24838
|
credentialHash: string;
|
|
@@ -25007,7 +25170,7 @@ export interface usersComponents {
|
|
|
25007
25170
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
25008
25171
|
Partial<usersComponents["schemas"]["OAuth2ConnectLink"]>)[];
|
|
25009
25172
|
};
|
|
25010
|
-
|
|
25173
|
+
ValueList: {
|
|
25011
25174
|
/** List ID. */
|
|
25012
25175
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
25013
25176
|
/** List version. */
|
|
@@ -25619,6 +25782,10 @@ export interface usersComponents {
|
|
|
25619
25782
|
* [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
|
|
25620
25783
|
*/
|
|
25621
25784
|
theme?: { [key: string]: string };
|
|
25785
|
+
/** Hosted payment form features. */
|
|
25786
|
+
features?: {
|
|
25787
|
+
showCoupons?: string[] | null;
|
|
25788
|
+
};
|
|
25622
25789
|
};
|
|
25623
25790
|
};
|
|
25624
25791
|
Website: {
|
|
@@ -25644,6 +25811,60 @@ export interface usersComponents {
|
|
|
25644
25811
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
25645
25812
|
Partial<usersComponents["schemas"]["OrganizationLink"]>)[];
|
|
25646
25813
|
};
|
|
25814
|
+
LinkSignedLink: usersComponents["schemas"]["Link"] & {
|
|
25815
|
+
/** The link type. */
|
|
25816
|
+
rel: "signedLink";
|
|
25817
|
+
};
|
|
25818
|
+
OrganizationExportResource: {
|
|
25819
|
+
/** Exported resource. */
|
|
25820
|
+
name?:
|
|
25821
|
+
| "customers"
|
|
25822
|
+
| "users"
|
|
25823
|
+
| "payment-instruments"
|
|
25824
|
+
| "invoices"
|
|
25825
|
+
| "orders"
|
|
25826
|
+
| "transactions"
|
|
25827
|
+
| "disputes"
|
|
25828
|
+
| "gateway-accounts"
|
|
25829
|
+
| "blocklists"
|
|
25830
|
+
| "lists"
|
|
25831
|
+
| "webhooks"
|
|
25832
|
+
| "products"
|
|
25833
|
+
| "websites"
|
|
25834
|
+
| "plans"
|
|
25835
|
+
| "credit-memos"
|
|
25836
|
+
| "files"
|
|
25837
|
+
| "email-notifications";
|
|
25838
|
+
/** Number of exported resources. */
|
|
25839
|
+
recordCount?: number;
|
|
25840
|
+
};
|
|
25841
|
+
OrganizationExport: {
|
|
25842
|
+
id?: usersComponents["schemas"]["ResourceId"];
|
|
25843
|
+
/** ID of the user who requested the organization data export. */
|
|
25844
|
+
userId?: string;
|
|
25845
|
+
/** Linked File object id. */
|
|
25846
|
+
fileId?: string | null;
|
|
25847
|
+
/** Status of organization data export request. */
|
|
25848
|
+
status?:
|
|
25849
|
+
| "pending"
|
|
25850
|
+
| "processing"
|
|
25851
|
+
| "completed"
|
|
25852
|
+
| "queued"
|
|
25853
|
+
| "failed"
|
|
25854
|
+
| "expired";
|
|
25855
|
+
/** Organization data export resources array. */
|
|
25856
|
+
items?: usersComponents["schemas"]["OrganizationExportResource"][];
|
|
25857
|
+
/** Time at which the organization data export was requested. */
|
|
25858
|
+
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
25859
|
+
/** Time at which the organization data export is updated. */
|
|
25860
|
+
updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
25861
|
+
/** Retention end date. After this date, files will be removed. */
|
|
25862
|
+
retentionTime?: string | null;
|
|
25863
|
+
/** Links related to the resource. */
|
|
25864
|
+
_links?: (Partial<usersComponents["schemas"]["LinkSelf"]> &
|
|
25865
|
+
Partial<usersComponents["schemas"]["LinkUser"]> &
|
|
25866
|
+
Partial<usersComponents["schemas"]["LinkSignedLink"]>)[];
|
|
25867
|
+
};
|
|
25647
25868
|
ApplicationLink: usersComponents["schemas"]["Link"] & {
|
|
25648
25869
|
/** The link type. */
|
|
25649
25870
|
rel: "application";
|
|
@@ -25768,71 +25989,19 @@ export interface usersComponents {
|
|
|
25768
25989
|
"application/json": usersComponents["schemas"]["Segment"];
|
|
25769
25990
|
};
|
|
25770
25991
|
};
|
|
25771
|
-
/** List resource. */
|
|
25772
|
-
List: {
|
|
25773
|
-
content: {
|
|
25774
|
-
"application/json": usersComponents["schemas"]["List"];
|
|
25775
|
-
};
|
|
25776
|
-
};
|
|
25777
25992
|
/** Create Organization Request. */
|
|
25778
25993
|
PostOrganization: {
|
|
25779
25994
|
content: {
|
|
25780
|
-
"application/json": {
|
|
25781
|
-
|
|
25782
|
-
name: string;
|
|
25783
|
-
/** The organization website address. */
|
|
25784
|
-
website: string;
|
|
25785
|
-
/** The organization street address. */
|
|
25786
|
-
address?: string;
|
|
25787
|
-
/** The organization street address. */
|
|
25788
|
-
address2?: string;
|
|
25789
|
-
/** The organization city. */
|
|
25790
|
-
city?: string;
|
|
25791
|
-
/** The organization region (state). */
|
|
25792
|
-
region?: string;
|
|
25793
|
-
/** The organization country ISO Alpha-2 code. */
|
|
25794
|
-
country: string;
|
|
25795
|
-
/** The organization postal code. */
|
|
25796
|
-
postalCode?: string;
|
|
25797
|
-
phoneNumbers?: usersComponents["schemas"]["ContactPhoneNumbers"];
|
|
25798
|
-
emails?: usersComponents["schemas"]["ContactEmails"];
|
|
25799
|
-
/** The organization's tax label. This will be displayed on the invoice. */
|
|
25800
|
-
taxDescriptor?: string;
|
|
25801
|
-
/** Invoice will use this time zone to display time otherwise UTC will be used. Example "America/New_York". */
|
|
25802
|
-
invoiceTimeZone?: string;
|
|
25803
|
-
/** The currency used for reports. It can only be set upon organization creation. */
|
|
25804
|
-
reportCurrency: string;
|
|
25805
|
-
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
25806
|
-
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
25995
|
+
"application/json": usersComponents["schemas"]["Organization"] & {
|
|
25996
|
+
[key: string]: any;
|
|
25807
25997
|
};
|
|
25808
25998
|
};
|
|
25809
25999
|
};
|
|
25810
26000
|
/** Create Organization Request. */
|
|
25811
26001
|
PatchOrganization: {
|
|
25812
26002
|
content: {
|
|
25813
|
-
"application/json": {
|
|
25814
|
-
|
|
25815
|
-
name?: string;
|
|
25816
|
-
/** The organization street address. */
|
|
25817
|
-
address?: string;
|
|
25818
|
-
/** The organization street address. */
|
|
25819
|
-
address2?: string;
|
|
25820
|
-
/** The organization city. */
|
|
25821
|
-
city?: string;
|
|
25822
|
-
/** The organization region (state). */
|
|
25823
|
-
region?: string;
|
|
25824
|
-
/** The organization country ISO Alpha-2 code. */
|
|
25825
|
-
country?: string;
|
|
25826
|
-
/** The organization postal code. */
|
|
25827
|
-
postalCode?: string;
|
|
25828
|
-
phoneNumbers?: usersComponents["schemas"]["ContactPhoneNumbers"];
|
|
25829
|
-
emails?: usersComponents["schemas"]["ContactEmails"];
|
|
25830
|
-
/** The organization's tax label. This will be displayed on the invoice. */
|
|
25831
|
-
taxDescriptor?: string;
|
|
25832
|
-
/** Invoice will use this time zone to display time otherwise UTC will be used. Example "America/New_York". */
|
|
25833
|
-
invoiceTimeZone?: string;
|
|
25834
|
-
questionnaire?: usersComponents["schemas"]["OrganizationQuestionnaire"];
|
|
25835
|
-
settings?: usersComponents["schemas"]["OrganizationSettings"];
|
|
26003
|
+
"application/json": usersComponents["schemas"]["Organization"] & {
|
|
26004
|
+
website?: { [key: string]: any };
|
|
25836
26005
|
};
|
|
25837
26006
|
};
|
|
25838
26007
|
};
|
|
@@ -25909,7 +26078,7 @@ export interface usersComponents {
|
|
|
25909
26078
|
/** The recognized amount. */
|
|
25910
26079
|
amount?: number;
|
|
25911
26080
|
currency?: usersComponents["schemas"]["CurrencyCode"];
|
|
25912
|
-
eventType?:
|
|
26081
|
+
eventType?: "invoice-revenue-recognized";
|
|
25913
26082
|
_embedded?: {
|
|
25914
26083
|
invoice?: usersComponents["schemas"]["Invoice"];
|
|
25915
26084
|
};
|
|
@@ -25919,7 +26088,7 @@ export interface usersComponents {
|
|
|
25919
26088
|
};
|
|
25920
26089
|
};
|
|
25921
26090
|
/** Gateway account limit was reached body resource. */
|
|
25922
|
-
|
|
26091
|
+
GatewayAccountWebhook: {
|
|
25923
26092
|
content: {
|
|
25924
26093
|
"application/json": {
|
|
25925
26094
|
/** The gateway account ID. */
|
|
@@ -27017,7 +27186,7 @@ export interface operations {
|
|
|
27017
27186
|
};
|
|
27018
27187
|
};
|
|
27019
27188
|
responses: {
|
|
27020
|
-
/** A list of root items available for specified credential was retrieved.
|
|
27189
|
+
/** A list of root items available for specified credential was retrieved. */
|
|
27021
27190
|
200: {
|
|
27022
27191
|
headers: {};
|
|
27023
27192
|
content: {
|
|
@@ -27653,7 +27822,7 @@ export interface operations {
|
|
|
27653
27822
|
};
|
|
27654
27823
|
};
|
|
27655
27824
|
/** Verify an email delivery setting. */
|
|
27656
|
-
|
|
27825
|
+
PutEmailDeliverySettingsVerification: {
|
|
27657
27826
|
parameters: {
|
|
27658
27827
|
path: {
|
|
27659
27828
|
/** The token string. */
|
|
@@ -27785,7 +27954,7 @@ export interface operations {
|
|
|
27785
27954
|
};
|
|
27786
27955
|
};
|
|
27787
27956
|
/** Resend verification email for an email delivery setting. */
|
|
27788
|
-
|
|
27957
|
+
PostResendEmailDeliverySettingVerification: {
|
|
27789
27958
|
parameters: {
|
|
27790
27959
|
path: {
|
|
27791
27960
|
/** The resource identifier string. */
|
|
@@ -28784,6 +28953,12 @@ export interface operations {
|
|
|
28784
28953
|
"application/json": usersComponents["schemas"]["GatewayAccountLimit"];
|
|
28785
28954
|
};
|
|
28786
28955
|
};
|
|
28956
|
+
/** Gateway account limit was created. */
|
|
28957
|
+
201: {
|
|
28958
|
+
content: {
|
|
28959
|
+
"application/json": usersComponents["schemas"]["GatewayAccountLimit"];
|
|
28960
|
+
};
|
|
28961
|
+
};
|
|
28787
28962
|
401: usersComponents["responses"]["Unauthorized"];
|
|
28788
28963
|
403: usersComponents["responses"]["Forbidden"];
|
|
28789
28964
|
404: usersComponents["responses"]["NotFound"];
|
|
@@ -29194,7 +29369,7 @@ export interface operations {
|
|
|
29194
29369
|
200: {
|
|
29195
29370
|
headers: {};
|
|
29196
29371
|
content: {
|
|
29197
|
-
"application/json": usersComponents["schemas"]["
|
|
29372
|
+
"application/json": usersComponents["schemas"]["ValueList"][];
|
|
29198
29373
|
};
|
|
29199
29374
|
};
|
|
29200
29375
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -29207,14 +29382,18 @@ export interface operations {
|
|
|
29207
29382
|
/** List was created. */
|
|
29208
29383
|
201: {
|
|
29209
29384
|
content: {
|
|
29210
|
-
"application/json": usersComponents["schemas"]["
|
|
29385
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29211
29386
|
};
|
|
29212
29387
|
};
|
|
29213
29388
|
401: usersComponents["responses"]["Unauthorized"];
|
|
29214
29389
|
403: usersComponents["responses"]["Forbidden"];
|
|
29215
29390
|
422: usersComponents["responses"]["ValidationError"];
|
|
29216
29391
|
};
|
|
29217
|
-
requestBody:
|
|
29392
|
+
requestBody: {
|
|
29393
|
+
content: {
|
|
29394
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29395
|
+
};
|
|
29396
|
+
};
|
|
29218
29397
|
};
|
|
29219
29398
|
/** Retrieve latest version of List with specified identifier string. */
|
|
29220
29399
|
GetList: {
|
|
@@ -29228,7 +29407,7 @@ export interface operations {
|
|
|
29228
29407
|
/** List was retrieved successfully. */
|
|
29229
29408
|
200: {
|
|
29230
29409
|
content: {
|
|
29231
|
-
"application/json": usersComponents["schemas"]["
|
|
29410
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29232
29411
|
};
|
|
29233
29412
|
};
|
|
29234
29413
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -29248,13 +29427,13 @@ export interface operations {
|
|
|
29248
29427
|
/** List was updated. */
|
|
29249
29428
|
200: {
|
|
29250
29429
|
content: {
|
|
29251
|
-
"application/json": usersComponents["schemas"]["
|
|
29430
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29252
29431
|
};
|
|
29253
29432
|
};
|
|
29254
29433
|
/** List was created. */
|
|
29255
29434
|
201: {
|
|
29256
29435
|
content: {
|
|
29257
|
-
"application/json": usersComponents["schemas"]["
|
|
29436
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29258
29437
|
};
|
|
29259
29438
|
};
|
|
29260
29439
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -29262,7 +29441,12 @@ export interface operations {
|
|
|
29262
29441
|
404: usersComponents["responses"]["NotFound"];
|
|
29263
29442
|
422: usersComponents["responses"]["ValidationError"];
|
|
29264
29443
|
};
|
|
29265
|
-
|
|
29444
|
+
/** List resource. */
|
|
29445
|
+
requestBody: {
|
|
29446
|
+
content: {
|
|
29447
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29448
|
+
};
|
|
29449
|
+
};
|
|
29266
29450
|
};
|
|
29267
29451
|
/** Delete a list with predefined identifier string. */
|
|
29268
29452
|
DeleteList: {
|
|
@@ -29295,7 +29479,7 @@ export interface operations {
|
|
|
29295
29479
|
/** List's exact version was retrieved successfully. */
|
|
29296
29480
|
200: {
|
|
29297
29481
|
content: {
|
|
29298
|
-
"application/json": usersComponents["schemas"]["
|
|
29482
|
+
"application/json": usersComponents["schemas"]["ValueList"];
|
|
29299
29483
|
};
|
|
29300
29484
|
};
|
|
29301
29485
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -29396,13 +29580,7 @@ export interface operations {
|
|
|
29396
29580
|
};
|
|
29397
29581
|
requestBody: {
|
|
29398
29582
|
content: {
|
|
29399
|
-
"application/json":
|
|
29400
|
-
isOwner?: boolean;
|
|
29401
|
-
/** The memberships's permissions. See the format in example. Use wildcard `*` for full access. */
|
|
29402
|
-
permissions?: usersComponents["schemas"]["AclPermissions"];
|
|
29403
|
-
/** The membership's roles identifiers. */
|
|
29404
|
-
roleIds?: string[];
|
|
29405
|
-
};
|
|
29583
|
+
"application/json": usersComponents["schemas"]["Membership"];
|
|
29406
29584
|
};
|
|
29407
29585
|
};
|
|
29408
29586
|
};
|
|
@@ -29875,7 +30053,7 @@ export interface operations {
|
|
|
29875
30053
|
403: usersComponents["responses"]["Forbidden"];
|
|
29876
30054
|
};
|
|
29877
30055
|
};
|
|
29878
|
-
/** Create a
|
|
30056
|
+
/** Create a role to be used when assigning permissions to users. */
|
|
29879
30057
|
PostRole: {
|
|
29880
30058
|
responses: {
|
|
29881
30059
|
/** Role was created. */
|
|
@@ -30117,7 +30295,7 @@ export interface operations {
|
|
|
30117
30295
|
200: {
|
|
30118
30296
|
headers: {};
|
|
30119
30297
|
content: {
|
|
30120
|
-
"application/json": usersComponents["schemas"]["
|
|
30298
|
+
"application/json": usersComponents["schemas"]["ValueList"][];
|
|
30121
30299
|
};
|
|
30122
30300
|
};
|
|
30123
30301
|
401: usersComponents["responses"]["Unauthorized"];
|
|
@@ -30174,6 +30352,7 @@ export interface operations {
|
|
|
30174
30352
|
404: usersComponents["responses"]["NotFound"];
|
|
30175
30353
|
};
|
|
30176
30354
|
};
|
|
30355
|
+
/** Webhooks are processed asynchronously. This operation schedules a resend attempt for a given webhook tracking ID. */
|
|
30177
30356
|
PostTrackingWebhookResendRequest: {
|
|
30178
30357
|
parameters: {
|
|
30179
30358
|
path: {
|
|
@@ -30551,6 +30730,83 @@ export interface operations {
|
|
|
30551
30730
|
409: usersComponents["responses"]["Conflict"];
|
|
30552
30731
|
};
|
|
30553
30732
|
};
|
|
30733
|
+
/** Retrieve a list of organization data exports. */
|
|
30734
|
+
GetOrganizationExportCollection: {
|
|
30735
|
+
parameters: {
|
|
30736
|
+
query: {
|
|
30737
|
+
/** The collection items limit. */
|
|
30738
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
30739
|
+
/** The collection items offset. */
|
|
30740
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
30741
|
+
/**
|
|
30742
|
+
* The collection items filter requires a special format.
|
|
30743
|
+
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
30744
|
+
* See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
|
|
30745
|
+
*/
|
|
30746
|
+
filter?: usersComponents["parameters"]["collectionFilter"];
|
|
30747
|
+
/** The partial search of the text fields. */
|
|
30748
|
+
q?: usersComponents["parameters"]["collectionQuery"];
|
|
30749
|
+
/** The collection items sort field and order (prefix with "-" for descending sort). */
|
|
30750
|
+
sort?: usersComponents["parameters"]["collectionSort"];
|
|
30751
|
+
};
|
|
30752
|
+
};
|
|
30753
|
+
responses: {
|
|
30754
|
+
/** A list of organization data exports is successfully retrieved. */
|
|
30755
|
+
200: {
|
|
30756
|
+
headers: {};
|
|
30757
|
+
content: {
|
|
30758
|
+
"application/json": usersComponents["schemas"]["OrganizationExport"][];
|
|
30759
|
+
};
|
|
30760
|
+
};
|
|
30761
|
+
401: usersComponents["responses"]["Unauthorized"];
|
|
30762
|
+
403: usersComponents["responses"]["Forbidden"];
|
|
30763
|
+
};
|
|
30764
|
+
};
|
|
30765
|
+
/**
|
|
30766
|
+
* Request an organization data export.
|
|
30767
|
+
* The data export is asynchronously processed.
|
|
30768
|
+
*/
|
|
30769
|
+
PostOrganizationExport: {
|
|
30770
|
+
responses: {
|
|
30771
|
+
/** Organization data export request received. */
|
|
30772
|
+
201: {
|
|
30773
|
+
content: {
|
|
30774
|
+
"application/json": usersComponents["schemas"]["OrganizationExport"];
|
|
30775
|
+
};
|
|
30776
|
+
};
|
|
30777
|
+
401: usersComponents["responses"]["Unauthorized"];
|
|
30778
|
+
403: usersComponents["responses"]["Forbidden"];
|
|
30779
|
+
422: usersComponents["responses"]["ValidationError"];
|
|
30780
|
+
};
|
|
30781
|
+
requestBody: {
|
|
30782
|
+
content: {
|
|
30783
|
+
"application/json": {
|
|
30784
|
+
/** Sets the export to include organization files. */
|
|
30785
|
+
includeFiles: boolean;
|
|
30786
|
+
};
|
|
30787
|
+
};
|
|
30788
|
+
};
|
|
30789
|
+
};
|
|
30790
|
+
/** Retrieve an organization data export request. */
|
|
30791
|
+
GetOrganizationExport: {
|
|
30792
|
+
parameters: {
|
|
30793
|
+
path: {
|
|
30794
|
+
/** The resource identifier string. */
|
|
30795
|
+
id: usersComponents["parameters"]["resourceId"];
|
|
30796
|
+
};
|
|
30797
|
+
};
|
|
30798
|
+
responses: {
|
|
30799
|
+
/** Organization data export request. */
|
|
30800
|
+
200: {
|
|
30801
|
+
content: {
|
|
30802
|
+
"application/json": usersComponents["schemas"]["OrganizationExport"];
|
|
30803
|
+
};
|
|
30804
|
+
};
|
|
30805
|
+
401: usersComponents["responses"]["Unauthorized"];
|
|
30806
|
+
403: usersComponents["responses"]["Forbidden"];
|
|
30807
|
+
404: usersComponents["responses"]["NotFound"];
|
|
30808
|
+
};
|
|
30809
|
+
};
|
|
30554
30810
|
}
|
|
30555
30811
|
/**
|
|
30556
30812
|
* This file was auto-generated by openapi-typescript.
|
|
@@ -30931,6 +31187,7 @@ export interface storefrontComponents {
|
|
|
30931
31187
|
| "Apple Pay"
|
|
30932
31188
|
| "AstroPay Card"
|
|
30933
31189
|
| "AstroPay-GO"
|
|
31190
|
+
| "BankSEND"
|
|
30934
31191
|
| "BankReferenced"
|
|
30935
31192
|
| "bank-transfer"
|
|
30936
31193
|
| "bank-transfer-2"
|
|
@@ -31194,6 +31451,7 @@ export interface storefrontComponents {
|
|
|
31194
31451
|
| "AuthorizeNet"
|
|
31195
31452
|
| "Awepay"
|
|
31196
31453
|
| "Bambora"
|
|
31454
|
+
| "BankSEND"
|
|
31197
31455
|
| "BitPay"
|
|
31198
31456
|
| "BlueSnap"
|
|
31199
31457
|
| "BraintreePayments"
|
|
@@ -31280,6 +31538,7 @@ export interface storefrontComponents {
|
|
|
31280
31538
|
| "NGenius"
|
|
31281
31539
|
| "NinjaWallet"
|
|
31282
31540
|
| "NMI"
|
|
31541
|
+
| "NOWPayments"
|
|
31283
31542
|
| "NuaPay"
|
|
31284
31543
|
| "OchaPay"
|
|
31285
31544
|
| "Onlineueberweisen"
|
|
@@ -31301,6 +31560,7 @@ export interface storefrontComponents {
|
|
|
31301
31560
|
| "PaymentsOS"
|
|
31302
31561
|
| "Paymero"
|
|
31303
31562
|
| "PayPal"
|
|
31563
|
+
| "Payper"
|
|
31304
31564
|
| "Payr"
|
|
31305
31565
|
| "Paysafe"
|
|
31306
31566
|
| "Paysafecard"
|
|
@@ -31670,6 +31930,25 @@ export interface storefrontComponents {
|
|
|
31670
31930
|
description: string;
|
|
31671
31931
|
/** Tax rate. */
|
|
31672
31932
|
rate?: number | null;
|
|
31933
|
+
/** Amount of sales tax to collect for the state. */
|
|
31934
|
+
stateAmount?: number | null;
|
|
31935
|
+
/** Amount of sales tax to collect for the county. */
|
|
31936
|
+
countyAmount?: number | null;
|
|
31937
|
+
/** Amount of sales tax to collect for the city. */
|
|
31938
|
+
cityAmount?: number | null;
|
|
31939
|
+
/** Amount of sales tax to collect for the special district. */
|
|
31940
|
+
specialDistrictAmount?: number | null;
|
|
31941
|
+
/** Jurisdiction names for the invoice. */
|
|
31942
|
+
jurisdictions?: {
|
|
31943
|
+
/** Two-letter ISO country code for the provided location. */
|
|
31944
|
+
country?: string | null;
|
|
31945
|
+
/** Postal abbreviated state name for the provided location. */
|
|
31946
|
+
state?: string | null;
|
|
31947
|
+
/** County name for the provided location. */
|
|
31948
|
+
county?: string | null;
|
|
31949
|
+
/** City name for the provided location. */
|
|
31950
|
+
city?: string | null;
|
|
31951
|
+
} | null;
|
|
31673
31952
|
};
|
|
31674
31953
|
/** Manually set tax items. */
|
|
31675
31954
|
manual: storefrontComponents["schemas"]["InvoiceTax"] & {
|
|
@@ -32053,8 +32332,8 @@ export interface storefrontComponents {
|
|
|
32053
32332
|
| "draft"
|
|
32054
32333
|
| "unpaid"
|
|
32055
32334
|
| "paid"
|
|
32335
|
+
| "partially-paid"
|
|
32056
32336
|
| "past-due"
|
|
32057
|
-
| "delinquent"
|
|
32058
32337
|
| "abandoned"
|
|
32059
32338
|
| "voided"
|
|
32060
32339
|
| "partially-refunded"
|
|
@@ -32199,19 +32478,20 @@ export interface storefrontComponents {
|
|
|
32199
32478
|
| "ewallet-holder-details"
|
|
32200
32479
|
| "ewallet-transaction-statement"
|
|
32201
32480
|
| "other";
|
|
32481
|
+
/** Documents to request from the customer. */
|
|
32482
|
+
KycRequestDocuments: {
|
|
32483
|
+
/** Type of document to request from the customer. */
|
|
32484
|
+
type: storefrontComponents["schemas"]["KycDocumentTypes"];
|
|
32485
|
+
/** Allowed document subtype. */
|
|
32486
|
+
subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
|
|
32487
|
+
/** Total number of allowed document upload attempts. Use `0` to allow unlimited upload attempts. */
|
|
32488
|
+
maxAttempts: number;
|
|
32489
|
+
/** Specifies whether the customer must upload a photo of their face (selfie) that matches a provided KYC document. */
|
|
32490
|
+
faceProofRequired?: boolean;
|
|
32491
|
+
}[];
|
|
32202
32492
|
CommonKycRequest: {
|
|
32203
32493
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
32204
|
-
|
|
32205
|
-
documents: {
|
|
32206
|
-
/** Document type to be requested from customer. */
|
|
32207
|
-
type: storefrontComponents["schemas"]["KycDocumentTypes"];
|
|
32208
|
-
/** Document subtype allowed for customer. */
|
|
32209
|
-
subtypes?: storefrontComponents["schemas"]["KycDocumentSubtypes"][];
|
|
32210
|
-
/** The number of document upload attempts. `0` treated as unlimited. */
|
|
32211
|
-
maxAttempts: number;
|
|
32212
|
-
/** If `true` uploading matching face photo (selfie) is required. */
|
|
32213
|
-
faceProofRequired?: boolean;
|
|
32214
|
-
}[];
|
|
32494
|
+
documents: storefrontComponents["schemas"]["KycRequestDocuments"];
|
|
32215
32495
|
/** Status of the request. */
|
|
32216
32496
|
status?:
|
|
32217
32497
|
| "gathering"
|
|
@@ -32248,12 +32528,17 @@ export interface storefrontComponents {
|
|
|
32248
32528
|
| "document-unreadable"
|
|
32249
32529
|
| "document-expired"
|
|
32250
32530
|
| "document-not-matching"
|
|
32531
|
+
| "document-duplicate"
|
|
32532
|
+
| "document-invalid"
|
|
32533
|
+
| "document-not-open"
|
|
32251
32534
|
| "underage-person"
|
|
32252
32535
|
| "third-party-or-mismatch"
|
|
32253
32536
|
| "expiration-date-missing"
|
|
32254
32537
|
| "issue-date-missing"
|
|
32255
32538
|
| "dob-mismatch"
|
|
32256
32539
|
| "name-mismatch"
|
|
32540
|
+
| "critical-info-missing"
|
|
32541
|
+
| "old-address-on-id"
|
|
32257
32542
|
| "other";
|
|
32258
32543
|
KycDocumentRejection: {
|
|
32259
32544
|
type?: storefrontComponents["schemas"]["KycDocumentRejectionReasonTypes"];
|
|
@@ -32593,56 +32878,57 @@ export interface storefrontComponents {
|
|
|
32593
32878
|
/** Allow using this payment instrument as a backup for invoice payment retries. */
|
|
32594
32879
|
useAsBackup: boolean;
|
|
32595
32880
|
};
|
|
32881
|
+
BankAccountCreatePlain: {
|
|
32882
|
+
accountNumberType: "IBAN" | "BBAN";
|
|
32883
|
+
};
|
|
32596
32884
|
/** BBAN type object. */
|
|
32597
|
-
BBANType: {
|
|
32598
|
-
/**
|
|
32599
|
-
method
|
|
32600
|
-
/**
|
|
32601
|
-
customerId
|
|
32885
|
+
BBANType: storefrontComponents["schemas"]["BankAccountCreatePlain"] & {
|
|
32886
|
+
/** Payment method of the payment instrument. */
|
|
32887
|
+
method?: "ach";
|
|
32888
|
+
/** ID of the customer who is initiating the payment. */
|
|
32889
|
+
customerId?: storefrontComponents["schemas"]["ResourceId"];
|
|
32602
32890
|
/**
|
|
32603
|
-
* Bank
|
|
32604
|
-
*
|
|
32891
|
+
* Bank account number type. A valid value is Basic Bank Account Number (BBAN) or International Bank Account Number (IBAN).
|
|
32892
|
+
* BBAN object.
|
|
32605
32893
|
*/
|
|
32606
32894
|
accountNumberType: "IBAN" | "BBAN";
|
|
32607
32895
|
/** Bank's account number. */
|
|
32608
|
-
accountNumber
|
|
32896
|
+
accountNumber?: string;
|
|
32609
32897
|
/** Bank's routing number. */
|
|
32610
|
-
routingNumber
|
|
32898
|
+
routingNumber?: string;
|
|
32611
32899
|
/** Bank's account type. */
|
|
32612
|
-
accountType
|
|
32613
|
-
/** Bank
|
|
32900
|
+
accountType?: "checking" | "savings" | "other";
|
|
32901
|
+
/** Bank name. */
|
|
32614
32902
|
bankName?: string;
|
|
32615
|
-
/** Bank Identifier Code. */
|
|
32903
|
+
/** Bank Identifier Code (BIC). */
|
|
32616
32904
|
bic?: string;
|
|
32617
|
-
/** The billing address. */
|
|
32618
|
-
billingAddress
|
|
32905
|
+
/** The customer's billing address. */
|
|
32906
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
32619
32907
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
32620
32908
|
riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
|
|
32621
32909
|
};
|
|
32622
32910
|
/** IBAN type object. */
|
|
32623
|
-
IBANType: {
|
|
32624
|
-
/**
|
|
32625
|
-
method
|
|
32626
|
-
/**
|
|
32627
|
-
customerId
|
|
32911
|
+
IBANType: storefrontComponents["schemas"]["BankAccountCreatePlain"] & {
|
|
32912
|
+
/** Payment method of the payment instrument. */
|
|
32913
|
+
method?: "ach";
|
|
32914
|
+
/** ID of the customer who is initiating a payment. */
|
|
32915
|
+
customerId?: storefrontComponents["schemas"]["ResourceId"];
|
|
32628
32916
|
/**
|
|
32629
|
-
*
|
|
32630
|
-
*
|
|
32917
|
+
* Customer's bank account number type. A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
|
|
32918
|
+
* IBAN object.
|
|
32631
32919
|
*/
|
|
32632
32920
|
accountNumberType: "IBAN" | "BBAN";
|
|
32633
|
-
/**
|
|
32634
|
-
accountNumber
|
|
32635
|
-
/** Bank
|
|
32921
|
+
/** Customer's bank account number. Detailed information on all ISO 13616-compliant national IBAN formats is available in the [SWIFT IBAN Registry](https://www.swift.com/standards/data-standards/iban). */
|
|
32922
|
+
accountNumber?: string;
|
|
32923
|
+
/** Bank name. */
|
|
32636
32924
|
bankName?: string;
|
|
32637
|
-
/** Bank Identifier Code. */
|
|
32925
|
+
/** Bank Identifier Code (BIC). */
|
|
32638
32926
|
bic?: string;
|
|
32639
|
-
/** The billing address. */
|
|
32640
|
-
billingAddress
|
|
32927
|
+
/** The customer's billing address. */
|
|
32928
|
+
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
32641
32929
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
32642
32930
|
riskMetadata?: storefrontComponents["schemas"]["RiskMetadata"];
|
|
32643
32931
|
};
|
|
32644
|
-
BankAccountCreatePlain: Partial<storefrontComponents["schemas"]["BBANType"]> &
|
|
32645
|
-
Partial<storefrontComponents["schemas"]["IBANType"]>;
|
|
32646
32932
|
ReadyToPayAmount: {
|
|
32647
32933
|
currency: storefrontComponents["schemas"]["CurrencyCode"];
|
|
32648
32934
|
/** The amount. */
|
|
@@ -32742,12 +33028,28 @@ export interface storefrontComponents {
|
|
|
32742
33028
|
feature?: storefrontComponents["schemas"]["PayPalBillingAgreementFeature"] | null;
|
|
32743
33029
|
filters?: storefrontComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
32744
33030
|
};
|
|
33031
|
+
KlarnaFeature: {
|
|
33032
|
+
/** The feature name. */
|
|
33033
|
+
name: "Klarna";
|
|
33034
|
+
/** Klarna client token. */
|
|
33035
|
+
clientToken: string;
|
|
33036
|
+
/** Klarna session token. */
|
|
33037
|
+
sessionId: string;
|
|
33038
|
+
};
|
|
33039
|
+
ReadyToPayKlarnaMethod: {
|
|
33040
|
+
/** The payment method. */
|
|
33041
|
+
method: "Klarna";
|
|
33042
|
+
/** The specific feature of this method. For example, a digital wallet or a processor. If the method does not have any features, this value will be null. */
|
|
33043
|
+
feature?: storefrontComponents["schemas"]["KlarnaFeature"] | null;
|
|
33044
|
+
filters?: storefrontComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
33045
|
+
};
|
|
32745
33046
|
ReadyToPayMethods: (Partial<
|
|
32746
33047
|
storefrontComponents["schemas"]["ReadyToPayPaymentCardMethod"]
|
|
32747
33048
|
> &
|
|
32748
33049
|
Partial<storefrontComponents["schemas"]["ReadyToPayAchMethod"]> &
|
|
32749
33050
|
Partial<storefrontComponents["schemas"]["ReadyToPayGenericMethod"]> &
|
|
32750
|
-
Partial<storefrontComponents["schemas"]["ReadyToPayPayPalMethod"]>
|
|
33051
|
+
Partial<storefrontComponents["schemas"]["ReadyToPayPayPalMethod"]> &
|
|
33052
|
+
Partial<storefrontComponents["schemas"]["ReadyToPayKlarnaMethod"]>)[];
|
|
32751
33053
|
/** Plan without changes. */
|
|
32752
33054
|
OriginalPlan: {
|
|
32753
33055
|
/** The ID of plan to use. */
|
|
@@ -32755,7 +33057,24 @@ export interface storefrontComponents {
|
|
|
32755
33057
|
};
|
|
32756
33058
|
FlexiblePlan: storefrontComponents["schemas"]["CommonPlan"] & {
|
|
32757
33059
|
/** The ID of plan to modify with given settings. */
|
|
32758
|
-
id
|
|
33060
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33061
|
+
} & { [key: string]: any };
|
|
33062
|
+
OrderItem: {
|
|
33063
|
+
/** The plan identifier string. */
|
|
33064
|
+
planId?: storefrontComponents["schemas"]["ResourceId"];
|
|
33065
|
+
/** Number of units of the product on the given plan. */
|
|
33066
|
+
quantity?: number;
|
|
33067
|
+
plan:
|
|
33068
|
+
| storefrontComponents["schemas"]["OriginalPlan"]
|
|
33069
|
+
| storefrontComponents["schemas"]["FlexiblePlan"];
|
|
33070
|
+
/** Increments with each override change to this specific item. */
|
|
33071
|
+
revision?: number;
|
|
33072
|
+
/** Indicates if the plan information was modified for this subscription. */
|
|
33073
|
+
isModified?: boolean;
|
|
33074
|
+
/** Indicates if the plan's current revision is greater than this item's plan revision. */
|
|
33075
|
+
isGrandfathered?: boolean;
|
|
33076
|
+
/** Any embedded objects available that are requested by the `expand` querystring parameter. */
|
|
33077
|
+
_embedded?: Partial<storefrontComponents["schemas"]["ProductEmbed"]>[];
|
|
32759
33078
|
};
|
|
32760
33079
|
CommonOrder: {
|
|
32761
33080
|
/** The order identifier string. */
|
|
@@ -32786,21 +33105,7 @@ export interface storefrontComponents {
|
|
|
32786
33105
|
initialInvoiceId?: storefrontComponents["schemas"]["ResourceId"];
|
|
32787
33106
|
/** Most recently issued invoice identifier string. It might not be `paid` yet. */
|
|
32788
33107
|
recentInvoiceId?: storefrontComponents["schemas"]["ResourceId"];
|
|
32789
|
-
items?:
|
|
32790
|
-
/** The plan identifier string. */
|
|
32791
|
-
planId?: storefrontComponents["schemas"]["ResourceId"];
|
|
32792
|
-
/** Number of units of the product on the given plan. */
|
|
32793
|
-
quantity?: number;
|
|
32794
|
-
plan:
|
|
32795
|
-
| storefrontComponents["schemas"]["OriginalPlan"]
|
|
32796
|
-
| storefrontComponents["schemas"]["FlexiblePlan"];
|
|
32797
|
-
/** Increments with each override change to this specific item. */
|
|
32798
|
-
revision?: number;
|
|
32799
|
-
/** Indicates if the plan information was modified for this subscription. */
|
|
32800
|
-
isModified?: boolean;
|
|
32801
|
-
/** Indicates if the plan's current revision is greater than this item's plan revision. */
|
|
32802
|
-
isGrandfathered?: boolean;
|
|
32803
|
-
}[];
|
|
33108
|
+
items?: storefrontComponents["schemas"]["OrderItem"][];
|
|
32804
33109
|
/** Order delivery address. */
|
|
32805
33110
|
deliveryAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
|
|
32806
33111
|
/** Order billing address. */
|
|
@@ -32872,8 +33177,8 @@ export interface storefrontComponents {
|
|
|
32872
33177
|
trial?: {
|
|
32873
33178
|
/** Enable or disable the trial for this subscription. If enabled for plans without trial prices, the trial will be free. */
|
|
32874
33179
|
enabled?: boolean;
|
|
32875
|
-
/**
|
|
32876
|
-
endTime
|
|
33180
|
+
/** Time and date at which the trial ends. If a trial is enabled on this subscription, a value must be provided. */
|
|
33181
|
+
endTime?: string;
|
|
32877
33182
|
};
|
|
32878
33183
|
/** Whether a subscription ends after a trial period. Recurring settings are ignored if it's `true`. */
|
|
32879
33184
|
isTrialOnly: boolean;
|
|
@@ -32909,6 +33214,8 @@ export interface storefrontComponents {
|
|
|
32909
33214
|
currency?: storefrontComponents["schemas"]["CurrencyCode"];
|
|
32910
33215
|
amount?: number;
|
|
32911
33216
|
};
|
|
33217
|
+
/** ID of the payment instrument to use for autopay. If not provided or inactive, the customer's default payment instrument will be used. */
|
|
33218
|
+
paymentInstrumentId?: storefrontComponents["schemas"]["ResourceId"] | null;
|
|
32912
33219
|
};
|
|
32913
33220
|
SubscriptionCancellationState: {
|
|
32914
33221
|
/** Subscription order canceled time. */
|
|
@@ -32940,7 +33247,7 @@ export interface storefrontComponents {
|
|
|
32940
33247
|
/** Payment Token ID. */
|
|
32941
33248
|
token: string;
|
|
32942
33249
|
};
|
|
32943
|
-
|
|
33250
|
+
PaymentInstructionInstrument: {
|
|
32944
33251
|
/** The Payment Instrument identifier string. */
|
|
32945
33252
|
paymentInstrumentId: storefrontComponents["schemas"]["ResourceId"];
|
|
32946
33253
|
};
|
|
@@ -32962,7 +33269,7 @@ export interface storefrontComponents {
|
|
|
32962
33269
|
};
|
|
32963
33270
|
PaymentInstruction:
|
|
32964
33271
|
| storefrontComponents["schemas"]["PaymentToken"]
|
|
32965
|
-
| storefrontComponents["schemas"]["
|
|
33272
|
+
| storefrontComponents["schemas"]["PaymentInstructionInstrument"]
|
|
32966
33273
|
| storefrontComponents["schemas"]["PaymentMethods"]
|
|
32967
33274
|
| storefrontComponents["schemas"]["PaymentCardCreatePlain"]
|
|
32968
33275
|
| storefrontComponents["schemas"]["BankAccountCreatePlain"];
|
|
@@ -32973,6 +33280,8 @@ export interface storefrontComponents {
|
|
|
32973
33280
|
slug: string;
|
|
32974
33281
|
/** Billing portal website ID. */
|
|
32975
33282
|
websiteId: storefrontComponents["schemas"]["ResourceId"];
|
|
33283
|
+
/** Custom domain for the billing portal. */
|
|
33284
|
+
customDomain?: string | null;
|
|
32976
33285
|
/** Various features that can be enabled for the billing portal. */
|
|
32977
33286
|
features?: {
|
|
32978
33287
|
/** Enable or disable a customer ability to authenticate with a password. */
|
|
@@ -33045,7 +33354,9 @@ export interface storefrontComponents {
|
|
|
33045
33354
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33046
33355
|
/** Checkout form website ID. */
|
|
33047
33356
|
websiteId: string;
|
|
33048
|
-
/**
|
|
33357
|
+
/** Custom domain for the checkout form. */
|
|
33358
|
+
customDomain?: string | null;
|
|
33359
|
+
/** List of plans that are applied to a customer order by default. */
|
|
33049
33360
|
plans: storefrontComponents["schemas"]["CheckoutFormPlans"];
|
|
33050
33361
|
/**
|
|
33051
33362
|
* The list of independent addons.
|
|
@@ -33191,6 +33502,10 @@ export interface storefrontComponents {
|
|
|
33191
33502
|
* [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
|
|
33192
33503
|
*/
|
|
33193
33504
|
theme?: { [key: string]: string };
|
|
33505
|
+
/** Hosted payment form features. */
|
|
33506
|
+
features?: {
|
|
33507
|
+
showCoupons?: string[] | null;
|
|
33508
|
+
};
|
|
33194
33509
|
};
|
|
33195
33510
|
};
|
|
33196
33511
|
Website: {
|
|
@@ -33269,37 +33584,37 @@ export interface storefrontComponents {
|
|
|
33269
33584
|
/** The links related to resource. */
|
|
33270
33585
|
_links?: Partial<storefrontComponents["schemas"]["SelfLink"]>[];
|
|
33271
33586
|
};
|
|
33272
|
-
|
|
33587
|
+
StorefrontProofOfIdentityKycDocument: storefrontComponents["schemas"]["CommonKycDocument"] & {
|
|
33273
33588
|
documentMatches?: {
|
|
33274
33589
|
/** The calculated score that represents the % of confidence that this ID represents the given customer. */
|
|
33275
33590
|
score?: number;
|
|
33276
33591
|
data?: storefrontComponents["schemas"]["IdentityMatches"];
|
|
33277
33592
|
};
|
|
33278
33593
|
};
|
|
33279
|
-
|
|
33594
|
+
StorefrontProofOfAddressKycDocument: storefrontComponents["schemas"]["CommonKycDocument"] & {
|
|
33280
33595
|
documentMatches?: {
|
|
33281
33596
|
/** The calculated score that represents the % of confidence that this proof of address represents the given customer. */
|
|
33282
33597
|
score?: number;
|
|
33283
33598
|
data?: storefrontComponents["schemas"]["AddressMatches"];
|
|
33284
33599
|
};
|
|
33285
33600
|
};
|
|
33286
|
-
|
|
33287
|
-
|
|
33601
|
+
StorefrontProofOfFundsKycDocument: storefrontComponents["schemas"]["CommonKycDocument"];
|
|
33602
|
+
StorefrontProofOfPurchaseKycDocument: storefrontComponents["schemas"]["CommonKycDocument"] & {
|
|
33288
33603
|
documentMatches?: {
|
|
33289
33604
|
data?: storefrontComponents["schemas"]["PurchaseMatches"];
|
|
33290
33605
|
};
|
|
33291
33606
|
};
|
|
33292
|
-
|
|
33607
|
+
StorefrontProofOfCreditFileKycDocument: storefrontComponents["schemas"]["CommonKycDocument"] & {
|
|
33293
33608
|
documentMatches?: {
|
|
33294
33609
|
data?: storefrontComponents["schemas"]["CreditFileMatches"];
|
|
33295
33610
|
};
|
|
33296
33611
|
};
|
|
33297
33612
|
StorefrontKycDocument:
|
|
33298
|
-
| storefrontComponents["schemas"]["
|
|
33299
|
-
| storefrontComponents["schemas"]["
|
|
33300
|
-
| storefrontComponents["schemas"]["
|
|
33301
|
-
| storefrontComponents["schemas"]["
|
|
33302
|
-
| storefrontComponents["schemas"]["
|
|
33613
|
+
| storefrontComponents["schemas"]["StorefrontProofOfIdentityKycDocument"]
|
|
33614
|
+
| storefrontComponents["schemas"]["StorefrontProofOfAddressKycDocument"]
|
|
33615
|
+
| storefrontComponents["schemas"]["StorefrontProofOfFundsKycDocument"]
|
|
33616
|
+
| storefrontComponents["schemas"]["StorefrontProofOfPurchaseKycDocument"]
|
|
33617
|
+
| storefrontComponents["schemas"]["StorefrontProofOfCreditFileKycDocument"];
|
|
33303
33618
|
StorefrontKycRequest: storefrontComponents["schemas"]["CommonKycRequest"] & {
|
|
33304
33619
|
/** The links related to resource. */
|
|
33305
33620
|
_links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
|
|
@@ -33558,7 +33873,7 @@ export interface storefrontComponents {
|
|
|
33558
33873
|
};
|
|
33559
33874
|
};
|
|
33560
33875
|
/** Payment instrument. */
|
|
33561
|
-
|
|
33876
|
+
StorefrontPostPaymentInstrument: {
|
|
33562
33877
|
content: {
|
|
33563
33878
|
"application/json": {
|
|
33564
33879
|
/** Payment instrument token ID. */
|
|
@@ -33568,7 +33883,7 @@ export interface storefrontComponents {
|
|
|
33568
33883
|
};
|
|
33569
33884
|
};
|
|
33570
33885
|
/** Payment instrument. */
|
|
33571
|
-
|
|
33886
|
+
StorefrontPatchPaymentInstrument: {
|
|
33572
33887
|
content: {
|
|
33573
33888
|
"application/json": {
|
|
33574
33889
|
/** Payment instrument token ID. */
|
|
@@ -34167,7 +34482,7 @@ export interface operations {
|
|
|
34167
34482
|
403: storefrontComponents["responses"]["Forbidden"];
|
|
34168
34483
|
422: storefrontComponents["responses"]["ValidationError"];
|
|
34169
34484
|
};
|
|
34170
|
-
requestBody: storefrontComponents["requestBodies"]["
|
|
34485
|
+
requestBody: storefrontComponents["requestBodies"]["StorefrontPostPaymentInstrument"];
|
|
34171
34486
|
};
|
|
34172
34487
|
/** Retrieve a payment instrument by ID. */
|
|
34173
34488
|
StorefrontGetPaymentInstrument: {
|
|
@@ -34220,7 +34535,7 @@ export interface operations {
|
|
|
34220
34535
|
404: storefrontComponents["responses"]["NotFound"];
|
|
34221
34536
|
422: storefrontComponents["responses"]["ValidationError"];
|
|
34222
34537
|
};
|
|
34223
|
-
requestBody: storefrontComponents["requestBodies"]["
|
|
34538
|
+
requestBody: storefrontComponents["requestBodies"]["StorefrontPatchPaymentInstrument"];
|
|
34224
34539
|
};
|
|
34225
34540
|
/** Deactivate a payment instrument. */
|
|
34226
34541
|
StorefrontPostPaymentInstrumentDeactivation: {
|
|
@@ -34783,12 +35098,17 @@ export interface reportsComponents {
|
|
|
34783
35098
|
| "document-unreadable"
|
|
34784
35099
|
| "document-expired"
|
|
34785
35100
|
| "document-not-matching"
|
|
35101
|
+
| "document-duplicate"
|
|
35102
|
+
| "document-invalid"
|
|
35103
|
+
| "document-not-open"
|
|
34786
35104
|
| "underage-person"
|
|
34787
35105
|
| "third-party-or-mismatch"
|
|
34788
35106
|
| "expiration-date-missing"
|
|
34789
35107
|
| "issue-date-missing"
|
|
34790
35108
|
| "dob-mismatch"
|
|
34791
35109
|
| "name-mismatch"
|
|
35110
|
+
| "critical-info-missing"
|
|
35111
|
+
| "old-address-on-id"
|
|
34792
35112
|
| "other";
|
|
34793
35113
|
/** Rebilly event type. */
|
|
34794
35114
|
EventType:
|
|
@@ -35046,7 +35366,25 @@ export interface reportsComponents {
|
|
|
35046
35366
|
| "newSubscriptionsCount"
|
|
35047
35367
|
| "upgradesCount"
|
|
35048
35368
|
| "downgradesCount"
|
|
35049
|
-
| "monthlyRecurringRevenue"
|
|
35369
|
+
| "monthlyRecurringRevenue"
|
|
35370
|
+
| "averageRevenuePerCustomer"
|
|
35371
|
+
| "customerLifetimeValue"
|
|
35372
|
+
| "addressProofAcceptanceRate"
|
|
35373
|
+
| "identityProofAcceptanceRate"
|
|
35374
|
+
| "fundsProofAcceptanceRate"
|
|
35375
|
+
| "purchaseProofAcceptanceRate"
|
|
35376
|
+
| "creditFileProofAcceptanceRate"
|
|
35377
|
+
| "kycRejectionRate"
|
|
35378
|
+
| "kycAccuracyRate"
|
|
35379
|
+
| "addressProofAccuracyRate"
|
|
35380
|
+
| "identityProofAccuracyRate"
|
|
35381
|
+
| "creditFileProofAccuracyRate"
|
|
35382
|
+
| "kycRequestCount"
|
|
35383
|
+
| "kycRequestAbandonmentRate"
|
|
35384
|
+
| "kycRequestAttemptedRate"
|
|
35385
|
+
| "kycRequestFailureRate"
|
|
35386
|
+
| "kycRequestFulfillmentRate"
|
|
35387
|
+
| "kycRequestExpirationRate";
|
|
35050
35388
|
/** Metric name to display. */
|
|
35051
35389
|
humanName?: string;
|
|
35052
35390
|
/** True when the higher value means a better performance thus positive for a merchant, false otherwise. */
|
|
@@ -35055,20 +35393,20 @@ export interface reportsComponents {
|
|
|
35055
35393
|
/** Segment name. */
|
|
35056
35394
|
name?: string;
|
|
35057
35395
|
/** Segment value for the given date range. */
|
|
35058
|
-
value?: number;
|
|
35396
|
+
value?: number | null;
|
|
35059
35397
|
/** Segment value for the previous date range (relative to the given date range). */
|
|
35060
|
-
previousValue?: number;
|
|
35398
|
+
previousValue?: number | null;
|
|
35061
35399
|
/** Human readable segment value (formatted with a currency sign). */
|
|
35062
|
-
humanValue?: string;
|
|
35400
|
+
humanValue?: string | null;
|
|
35063
35401
|
/** Ratio of current value per previous value null is infinity. */
|
|
35064
|
-
changeRatio?: number;
|
|
35402
|
+
changeRatio?: number | null;
|
|
35065
35403
|
/** Human readable change ratio (formatted percentage with a "%" sign), null is infinity. */
|
|
35066
|
-
humanChangeRatio?: string;
|
|
35404
|
+
humanChangeRatio?: string | null;
|
|
35067
35405
|
timeseries?: {
|
|
35068
35406
|
/** Entry date-time. */
|
|
35069
35407
|
date?: string;
|
|
35070
35408
|
/** Entry value. */
|
|
35071
|
-
value?: number;
|
|
35409
|
+
value?: number | null;
|
|
35072
35410
|
}[];
|
|
35073
35411
|
}[];
|
|
35074
35412
|
}[];
|
|
@@ -37146,7 +37484,7 @@ declare module "resources/customers-resource" {
|
|
|
37146
37484
|
id: any;
|
|
37147
37485
|
data: any;
|
|
37148
37486
|
}): any;
|
|
37149
|
-
|
|
37487
|
+
getAllEddSearchResults({ id }: {
|
|
37150
37488
|
id: any;
|
|
37151
37489
|
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
37152
37490
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
@@ -37201,7 +37539,7 @@ declare module "resources/email-delivery-settings-resource" {
|
|
|
37201
37539
|
}): {
|
|
37202
37540
|
verify({ token }: {
|
|
37203
37541
|
token: any;
|
|
37204
|
-
}): rebilly.
|
|
37542
|
+
}): rebilly.PutEmailDeliverySettingsVerificationResponsePromise;
|
|
37205
37543
|
getAll({ limit, offset, filter, sort, q, }?: rebilly.GetEmailDeliverySettingCollectionRequest): rebilly.GetEmailDeliverySettingCollectionResponsePromise;
|
|
37206
37544
|
create({ data }: {
|
|
37207
37545
|
data: any;
|
|
@@ -37756,6 +38094,19 @@ declare module "resources/memberships-resource" {
|
|
|
37756
38094
|
}): any;
|
|
37757
38095
|
};
|
|
37758
38096
|
}
|
|
38097
|
+
declare module "resources/organization-exports-resource" {
|
|
38098
|
+
export default function OrganizationExportsResource({ apiHandler }: {
|
|
38099
|
+
apiHandler: any;
|
|
38100
|
+
}): {
|
|
38101
|
+
getAll({ limit, offset, filter, q, sort, }?: rebilly.GetOrganizationExportCollectionRequest): rebilly.GetOrganizationExportCollectionResponsePromise;
|
|
38102
|
+
create({ data }: {
|
|
38103
|
+
data: any;
|
|
38104
|
+
}): any;
|
|
38105
|
+
get({ id }: {
|
|
38106
|
+
id: any;
|
|
38107
|
+
}): rebilly.GetOrganizationExportResponsePromise;
|
|
38108
|
+
};
|
|
38109
|
+
}
|
|
37759
38110
|
declare module "resources/organizations-resource" {
|
|
37760
38111
|
export default function OrganizationsResource({ apiHandler }: {
|
|
37761
38112
|
apiHandler: any;
|
|
@@ -38832,7 +39183,7 @@ declare module "resources/api-instance" {
|
|
|
38832
39183
|
id: any;
|
|
38833
39184
|
data: any;
|
|
38834
39185
|
}): any;
|
|
38835
|
-
|
|
39186
|
+
getAllEddSearchResults({ id }: {
|
|
38836
39187
|
id: any;
|
|
38837
39188
|
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
38838
39189
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
@@ -38882,7 +39233,7 @@ declare module "resources/api-instance" {
|
|
|
38882
39233
|
emailDeliverySettings: {
|
|
38883
39234
|
verify({ token }: {
|
|
38884
39235
|
token: any;
|
|
38885
|
-
}): rebilly.
|
|
39236
|
+
}): rebilly.PutEmailDeliverySettingsVerificationResponsePromise;
|
|
38886
39237
|
getAll({ limit, offset, filter, sort, q, }?: {
|
|
38887
39238
|
limit?: number;
|
|
38888
39239
|
offset?: number;
|
|
@@ -39451,6 +39802,21 @@ declare module "resources/api-instance" {
|
|
|
39451
39802
|
userId: any;
|
|
39452
39803
|
}): any;
|
|
39453
39804
|
};
|
|
39805
|
+
organizationExports: {
|
|
39806
|
+
getAll({ limit, offset, filter, q, sort, }?: {
|
|
39807
|
+
limit?: number;
|
|
39808
|
+
offset?: number;
|
|
39809
|
+
filter?: string;
|
|
39810
|
+
q?: string;
|
|
39811
|
+
sort?: string[];
|
|
39812
|
+
}): rebilly.GetOrganizationExportCollectionResponsePromise;
|
|
39813
|
+
create({ data }: {
|
|
39814
|
+
data: any;
|
|
39815
|
+
}): any;
|
|
39816
|
+
get({ id }: {
|
|
39817
|
+
id: any;
|
|
39818
|
+
}): rebilly.GetOrganizationExportResponsePromise;
|
|
39819
|
+
};
|
|
39454
39820
|
organizations: {
|
|
39455
39821
|
getAll({ limit, offset, filter, q }?: {
|
|
39456
39822
|
limit?: number;
|