rebilly-js-sdk 47.13.1 → 47.14.1
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 +1092 -513
- package/dist/rebilly-js-sdk.es.js +411 -1450
- package/dist/rebilly-js-sdk.umd.js +8 -9
- package/package.json +1 -1
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -245,7 +245,7 @@ declare module rebilly {
|
|
|
245
245
|
|
|
246
246
|
type GetFileDownloadRequest = { id : String }
|
|
247
247
|
|
|
248
|
-
type GetFileDownloadResponse = operations['GetFileDownload']['responses']['200']
|
|
248
|
+
type GetFileDownloadResponse = operations['GetFileDownload']['responses']['200']
|
|
249
249
|
type GetFileDownloadResponsePromise = Promise<{fields: GetFileDownloadResponse}>
|
|
250
250
|
|
|
251
251
|
type GetInvoiceCollectionRequest = operations['GetInvoiceCollection']['parameters']["query"] & (operations['GetInvoiceCollection']['parameters'] extends {path: {}} ? operations['GetInvoiceCollection']['parameters']["path"] : {})
|
|
@@ -375,8 +375,8 @@ declare module rebilly {
|
|
|
375
375
|
type GetInvoiceCreditMemoAllocationCollectionResponse = operations['GetInvoiceCreditMemoAllocationCollection']['responses']['200']['content']['application/json'][0]
|
|
376
376
|
type GetInvoiceCreditMemoAllocationCollectionResponsePromise = Promise<{ items: {fields: GetInvoiceCreditMemoAllocationCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
377
377
|
|
|
378
|
-
type GetInvoiceCreditMemoAllocationRequest =
|
|
379
|
-
|
|
378
|
+
type GetInvoiceCreditMemoAllocationRequest = { id : String,creditMemoId : String }
|
|
379
|
+
|
|
380
380
|
type GetInvoiceCreditMemoAllocationResponse = operations['GetInvoiceCreditMemoAllocation']['responses']['200']['content']['application/json']
|
|
381
381
|
type GetInvoiceCreditMemoAllocationResponsePromise = Promise<{fields: GetInvoiceCreditMemoAllocationResponse}>
|
|
382
382
|
type PutInvoiceCreditMemoAllocationRequest = operations['PutInvoiceCreditMemoAllocation']['requestBody']['content']['application/json']
|
|
@@ -823,8 +823,8 @@ declare module rebilly {
|
|
|
823
823
|
type PostEddTimelineResponse = operations['PostEddTimeline']['responses']['201']['content']['application/json']
|
|
824
824
|
type PostEddTimelineResponsePromise = Promise<{fields: PostEddTimelineResponse}>
|
|
825
825
|
|
|
826
|
-
type GetEddSearchResultsRequest = { id : String }
|
|
827
|
-
|
|
826
|
+
type GetEddSearchResultsRequest = operations['GetEddSearchResults']['parameters'] & { id : String }
|
|
827
|
+
|
|
828
828
|
type GetEddSearchResultsResponse = operations['GetEddSearchResults']['responses']['200']['content']['application/json']
|
|
829
829
|
type GetEddSearchResultsResponsePromise = Promise<{fields: GetEddSearchResultsResponse}>
|
|
830
830
|
|
|
@@ -852,8 +852,8 @@ declare module rebilly {
|
|
|
852
852
|
type GetApplicationResponse = operations['GetApplication']['responses']['200']['content']['application/json']
|
|
853
853
|
type GetApplicationResponsePromise = Promise<{fields: GetApplicationResponse}>
|
|
854
854
|
|
|
855
|
-
type GetApplicationInstanceCollectionRequest = { id : String }
|
|
856
|
-
|
|
855
|
+
type GetApplicationInstanceCollectionRequest = operations['GetApplicationInstanceCollection']['parameters']["query"] & (operations['GetApplicationInstanceCollection']['parameters'] extends {path: {}} ? operations['GetApplicationInstanceCollection']['parameters']["path"] : {}) & { id : String }
|
|
856
|
+
|
|
857
857
|
type GetApplicationInstanceCollectionResponse = operations['GetApplicationInstanceCollection']['responses']['200']['content']['application/json'][0]
|
|
858
858
|
type GetApplicationInstanceCollectionResponsePromise = Promise<{ items: {fields: GetApplicationInstanceCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
859
859
|
|
|
@@ -1162,6 +1162,7 @@ declare module rebilly {
|
|
|
1162
1162
|
type DeleteEmailMessageResponse = operations['DeleteEmailMessage']['responses']['204']
|
|
1163
1163
|
type DeleteEmailMessageResponsePromise = Promise<{fields: DeleteEmailMessageResponse}>
|
|
1164
1164
|
|
|
1165
|
+
type GetEmailNotificationCollectionRequest = operations['GetEmailNotificationCollection']['parameters']["query"] & (operations['GetEmailNotificationCollection']['parameters'] extends {path: {}} ? operations['GetEmailNotificationCollection']['parameters']["path"] : {})
|
|
1165
1166
|
|
|
1166
1167
|
type GetEmailNotificationCollectionResponse = operations['GetEmailNotificationCollection']['responses']['200']['content']['application/json'][0]
|
|
1167
1168
|
type GetEmailNotificationCollectionResponsePromise = Promise<{ items: {fields: GetEmailNotificationCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
@@ -1354,6 +1355,7 @@ declare module rebilly {
|
|
|
1354
1355
|
type DeleteGridSegmentResponse = operations['DeleteGridSegment']['responses']['204']
|
|
1355
1356
|
type DeleteGridSegmentResponsePromise = Promise<{fields: DeleteGridSegmentResponse}>
|
|
1356
1357
|
|
|
1358
|
+
type GetIntegrationCollectionRequest = operations['GetIntegrationCollection']['parameters']["query"] & (operations['GetIntegrationCollection']['parameters'] extends {path: {}} ? operations['GetIntegrationCollection']['parameters']["path"] : {})
|
|
1357
1359
|
|
|
1358
1360
|
type GetIntegrationCollectionResponse = operations['GetIntegrationCollection']['responses']['200']['content']['application/json'][0]
|
|
1359
1361
|
type GetIntegrationCollectionResponsePromise = Promise<{ items: {fields: GetIntegrationCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
@@ -1427,6 +1429,7 @@ declare module rebilly {
|
|
|
1427
1429
|
type GetPaymentCardBankNameCollectionResponse = operations['GetPaymentCardBankNameCollection']['responses']['200']['content']['application/json'][0]
|
|
1428
1430
|
type GetPaymentCardBankNameCollectionResponsePromise = Promise<{ items: {fields: GetPaymentCardBankNameCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1429
1431
|
|
|
1432
|
+
type GetPaymentMethodCollectionRequest = operations['GetPaymentMethodCollection']['parameters']["query"] & (operations['GetPaymentMethodCollection']['parameters'] extends {path: {}} ? operations['GetPaymentMethodCollection']['parameters']["path"] : {})
|
|
1430
1433
|
|
|
1431
1434
|
type GetPaymentMethodCollectionResponse = operations['GetPaymentMethodCollection']['responses']['200']['content']['application/json'][0]
|
|
1432
1435
|
type GetPaymentMethodCollectionResponsePromise = Promise<{ items: {fields: GetPaymentMethodCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
@@ -1689,8 +1692,8 @@ declare module rebilly {
|
|
|
1689
1692
|
type StorefrontGetInvoiceCollectionResponse = operations['StorefrontGetInvoiceCollection']['responses']['200']['content']['application/json'][0]
|
|
1690
1693
|
type StorefrontGetInvoiceCollectionResponsePromise = Promise<{ items: {fields: StorefrontGetInvoiceCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1691
1694
|
|
|
1692
|
-
type StorefrontGetInvoiceRequest = { id : String }
|
|
1693
|
-
|
|
1695
|
+
type StorefrontGetInvoiceRequest = operations['StorefrontGetInvoice']['parameters'] & { id : String }
|
|
1696
|
+
|
|
1694
1697
|
type StorefrontGetInvoiceResponse = operations['StorefrontGetInvoice']['responses']['200']['content']['application/json']
|
|
1695
1698
|
type StorefrontGetInvoiceResponsePromise = Promise<{fields: StorefrontGetInvoiceResponse}>
|
|
1696
1699
|
|
|
@@ -1993,8 +1996,11 @@ declare module rebilly {
|
|
|
1993
1996
|
export interface corePaths {
|
|
1994
1997
|
"/aml": {
|
|
1995
1998
|
/**
|
|
1996
|
-
*
|
|
1997
|
-
*
|
|
1999
|
+
* Searches a individual's details against multiple
|
|
2000
|
+
* Politically Exposed Person (PEP), sanction, or
|
|
2001
|
+
* adverse media lists to determine if the customer is blocklisted.
|
|
2002
|
+
* Performs a fuzzy search that uses Soundex. Note that
|
|
2003
|
+
* some returned fields may not contain values.
|
|
1998
2004
|
*/
|
|
1999
2005
|
get: operations["GetAmlEntry"];
|
|
2000
2006
|
};
|
|
@@ -2231,8 +2237,11 @@ export interface corePaths {
|
|
|
2231
2237
|
};
|
|
2232
2238
|
"/customers/{id}/aml": {
|
|
2233
2239
|
/**
|
|
2234
|
-
*
|
|
2235
|
-
*
|
|
2240
|
+
* Searches a customer's information, by Rebilly customer ID, against
|
|
2241
|
+
* multiple Politically Exposed Person (PEP), sanction, or adverse
|
|
2242
|
+
* media lists to determine if the customer is blocklisted. Performs
|
|
2243
|
+
* a fuzzy search that uses Soundex. Note that some returned fields
|
|
2244
|
+
* may not contain values.
|
|
2236
2245
|
*/
|
|
2237
2246
|
get: operations["GetCustomerAmlEntryCollection"];
|
|
2238
2247
|
parameters: {
|
|
@@ -2573,7 +2582,7 @@ export interface corePaths {
|
|
|
2573
2582
|
};
|
|
2574
2583
|
};
|
|
2575
2584
|
"/invoices/{id}/credit-memo-allocations/{creditMemoId}": {
|
|
2576
|
-
/**
|
|
2585
|
+
/** Retrieves the credit amount allocated to the given invoice from a specific credit memo. */
|
|
2577
2586
|
get: operations["GetInvoiceCreditMemoAllocation"];
|
|
2578
2587
|
/** Apply a credit memo to an invoice. The invoice must be unpaid. The credit memo must have a non-zero unused amount (not fully applied to other invoices). */
|
|
2579
2588
|
put: operations["PutInvoiceCreditMemoAllocation"];
|
|
@@ -3314,50 +3323,59 @@ export interface corePaths {
|
|
|
3314
3323
|
|
|
3315
3324
|
export interface coreComponents {
|
|
3316
3325
|
schemas: {
|
|
3317
|
-
/**
|
|
3326
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
3318
3327
|
Country: string;
|
|
3319
3328
|
SelfLink: {
|
|
3320
|
-
/**
|
|
3329
|
+
/** Type of link. */
|
|
3321
3330
|
rel: "self";
|
|
3322
|
-
/**
|
|
3331
|
+
/** Link URL. */
|
|
3323
3332
|
href: string;
|
|
3324
3333
|
};
|
|
3325
3334
|
AML: {
|
|
3326
|
-
/** First
|
|
3335
|
+
/** First name of the individual, or name of entity. */
|
|
3327
3336
|
firstName?: string;
|
|
3328
|
-
/**
|
|
3337
|
+
/**
|
|
3338
|
+
* Last name of the individual. Returns a
|
|
3339
|
+
* `null` value for single-named entities.
|
|
3340
|
+
*/
|
|
3329
3341
|
lastName?: string | null;
|
|
3330
|
-
/**
|
|
3342
|
+
/** Describes which list the result is from. */
|
|
3331
3343
|
source?: string;
|
|
3332
|
-
/**
|
|
3344
|
+
/** Describes the type of list the result is from. */
|
|
3333
3345
|
sourceType?: "pep" | "sanctions" | "adverse-media";
|
|
3334
|
-
/**
|
|
3346
|
+
/**
|
|
3347
|
+
* If `type`=`individual`, this field describes the gender of the
|
|
3348
|
+
* individual.
|
|
3349
|
+
*/
|
|
3335
3350
|
gender?: string | null;
|
|
3336
|
-
/** The
|
|
3351
|
+
/** The individual's job title. */
|
|
3337
3352
|
title?: string[] | null;
|
|
3338
|
-
/**
|
|
3353
|
+
/** Describes whether the source is an individual or an entity. */
|
|
3339
3354
|
type?: "individual" | "entity";
|
|
3340
|
-
/** List of references to legal documents if they exist. */
|
|
3355
|
+
/** List of references to legal documents, if they exist. */
|
|
3341
3356
|
legalBasis?: string[];
|
|
3342
|
-
/**
|
|
3357
|
+
/**
|
|
3358
|
+
* Describes the government, administration, or political
|
|
3359
|
+
* entity.
|
|
3360
|
+
*/
|
|
3343
3361
|
regime?: string | null;
|
|
3344
|
-
/**
|
|
3362
|
+
/** Degree of confidence in the source list information. */
|
|
3345
3363
|
confidence?: "weak" | "medium" | "strong" | "very-strong";
|
|
3346
|
-
/**
|
|
3364
|
+
/** Nationality of the individual or entity. */
|
|
3347
3365
|
nationality?: string;
|
|
3348
|
-
/** Addresses
|
|
3366
|
+
/** Addresses associated with the individual or entity. */
|
|
3349
3367
|
address?: {
|
|
3350
|
-
/** Street
|
|
3368
|
+
/** Street address line 1. */
|
|
3351
3369
|
address?: string | null;
|
|
3352
|
-
/** Street
|
|
3370
|
+
/** Street address line 2. */
|
|
3353
3371
|
address2?: string | null;
|
|
3354
3372
|
/** City. */
|
|
3355
3373
|
city?: string | null;
|
|
3356
|
-
/** State
|
|
3374
|
+
/** State, province, or region. */
|
|
3357
3375
|
region?: string | null;
|
|
3358
3376
|
/** Country. */
|
|
3359
3377
|
country?: string | null;
|
|
3360
|
-
/**
|
|
3378
|
+
/** Individual's place of birth. */
|
|
3361
3379
|
birthplace: boolean;
|
|
3362
3380
|
}[];
|
|
3363
3381
|
/** One or more possible dates of birth. */
|
|
@@ -3368,26 +3386,29 @@ export interface coreComponents {
|
|
|
3368
3386
|
firstName?: string;
|
|
3369
3387
|
/** Last name of alias. */
|
|
3370
3388
|
lastName?: string;
|
|
3371
|
-
/**
|
|
3389
|
+
/** Degree of confidence in the alias. */
|
|
3372
3390
|
authenticity?: "strong" | "weak" | "unknown";
|
|
3373
3391
|
}[];
|
|
3374
|
-
/**
|
|
3392
|
+
/** Individual's passport information. */
|
|
3375
3393
|
passport?: {
|
|
3376
3394
|
/** Passport number. */
|
|
3377
3395
|
number?: string;
|
|
3378
3396
|
/** Passport registration date. */
|
|
3379
3397
|
registrationDate?: string;
|
|
3380
3398
|
}[];
|
|
3381
|
-
/**
|
|
3399
|
+
/** Additional information. This content varies per list. */
|
|
3382
3400
|
comments?: string | null;
|
|
3383
|
-
/**
|
|
3401
|
+
/** Related resource links. */
|
|
3384
3402
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3385
3403
|
};
|
|
3386
|
-
/**
|
|
3404
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
3387
3405
|
ResourceId: string;
|
|
3388
|
-
/** Read-only timestamp
|
|
3406
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
3389
3407
|
ServerTimestamp: string;
|
|
3390
|
-
/**
|
|
3408
|
+
/**
|
|
3409
|
+
* Read-only timestamp. This value updates when the resource
|
|
3410
|
+
* is updated.
|
|
3411
|
+
*/
|
|
3391
3412
|
UpdatedTime: string;
|
|
3392
3413
|
Link: {
|
|
3393
3414
|
/** The link URL. */
|
|
@@ -3430,7 +3451,14 @@ export interface coreComponents {
|
|
|
3430
3451
|
/** The File description. */
|
|
3431
3452
|
description?: string;
|
|
3432
3453
|
/** The File source type. */
|
|
3433
|
-
sourceType?:
|
|
3454
|
+
sourceType?:
|
|
3455
|
+
| (
|
|
3456
|
+
| "upload"
|
|
3457
|
+
| "camera"
|
|
3458
|
+
| "organization-export"
|
|
3459
|
+
| "organization-closure-export"
|
|
3460
|
+
)
|
|
3461
|
+
| null;
|
|
3434
3462
|
/** The tags list. */
|
|
3435
3463
|
tags?: string[];
|
|
3436
3464
|
/** The mime type. */
|
|
@@ -3549,7 +3577,7 @@ export interface coreComponents {
|
|
|
3549
3577
|
/** Should OTP be required to exchange token. */
|
|
3550
3578
|
otpRequired?: boolean;
|
|
3551
3579
|
};
|
|
3552
|
-
/**
|
|
3580
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
3553
3581
|
CustomerId: string;
|
|
3554
3582
|
CommonAuthenticationToken: {
|
|
3555
3583
|
/** Authentication token identifier string. */
|
|
@@ -3578,7 +3606,7 @@ export interface coreComponents {
|
|
|
3578
3606
|
* token, requires a secret API key to log in. To obtain an API key, see
|
|
3579
3607
|
* [Manage API keys](https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys).
|
|
3580
3608
|
*/
|
|
3581
|
-
mode:
|
|
3609
|
+
mode: string;
|
|
3582
3610
|
};
|
|
3583
3611
|
password: coreComponents["schemas"]["AuthenticationToken"] &
|
|
3584
3612
|
coreComponents["schemas"]["AuthenticationTokenMetadata"] &
|
|
@@ -3614,7 +3642,7 @@ export interface coreComponents {
|
|
|
3614
3642
|
permissions: coreComponents["schemas"]["AclPermissions"];
|
|
3615
3643
|
}[];
|
|
3616
3644
|
CustomerLink: coreComponents["schemas"]["Link"] & {
|
|
3617
|
-
/**
|
|
3645
|
+
/** Type of link. */
|
|
3618
3646
|
rel: "customer" | "targetCustomer";
|
|
3619
3647
|
};
|
|
3620
3648
|
CustomerJWT: {
|
|
@@ -3697,7 +3725,7 @@ export interface coreComponents {
|
|
|
3697
3725
|
| "restrict-to-products"
|
|
3698
3726
|
| "paid-by-time";
|
|
3699
3727
|
};
|
|
3700
|
-
/** ISO 4217
|
|
3728
|
+
/** ISO 4217 currency code. */
|
|
3701
3729
|
CurrencyCode: string;
|
|
3702
3730
|
/** minimum-order-amount restrictions. */
|
|
3703
3731
|
"minimum-order-amount": coreComponents["schemas"]["CouponRestriction"] &
|
|
@@ -3899,7 +3927,7 @@ export interface coreComponents {
|
|
|
3899
3927
|
/** The links related to resource. */
|
|
3900
3928
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3901
3929
|
};
|
|
3902
|
-
/**
|
|
3930
|
+
/** Payment method. */
|
|
3903
3931
|
PaymentMethod:
|
|
3904
3932
|
| "payment-card"
|
|
3905
3933
|
| "ach"
|
|
@@ -3938,6 +3966,7 @@ export interface coreComponents {
|
|
|
3938
3966
|
| "CashToCode"
|
|
3939
3967
|
| "CCAvenue"
|
|
3940
3968
|
| "China UnionPay"
|
|
3969
|
+
| "Cleo"
|
|
3941
3970
|
| "CODVoucher"
|
|
3942
3971
|
| "Conekta-oxxo"
|
|
3943
3972
|
| "Conekta-spei"
|
|
@@ -4070,8 +4099,8 @@ export interface coreComponents {
|
|
|
4070
4099
|
/** Vaulted payment instrument. */
|
|
4071
4100
|
VaultedInstrument: {
|
|
4072
4101
|
/**
|
|
4073
|
-
*
|
|
4074
|
-
*
|
|
4102
|
+
* Payment method supported vault. For more information, see
|
|
4103
|
+
* [Payment Instrument](https://api-reference.rebilly.com/tag/Payment-Instruments).
|
|
4075
4104
|
*/
|
|
4076
4105
|
method: "payment-card" | "ach" | "paypal";
|
|
4077
4106
|
/** The payment instrument identifier. */
|
|
@@ -4080,13 +4109,13 @@ export interface coreComponents {
|
|
|
4080
4109
|
/** Alternative payment method instrument. */
|
|
4081
4110
|
AlternativePaymentInstrument: {
|
|
4082
4111
|
method: coreComponents["schemas"]["PaymentMethod"];
|
|
4083
|
-
/**
|
|
4112
|
+
/** Payment instrument ID. */
|
|
4084
4113
|
paymentInstrumentId?: coreComponents["schemas"]["ResourceId"];
|
|
4085
4114
|
};
|
|
4086
4115
|
/** Cash payment instrument object. */
|
|
4087
4116
|
CashInstrument: {
|
|
4088
4117
|
method: "cash";
|
|
4089
|
-
/**
|
|
4118
|
+
/** Individual or entity that received the payment. */
|
|
4090
4119
|
receivedBy?: string;
|
|
4091
4120
|
};
|
|
4092
4121
|
/** Check payment instrument object. */
|
|
@@ -4101,58 +4130,78 @@ export interface coreComponents {
|
|
|
4101
4130
|
Partial<coreComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
4102
4131
|
Partial<coreComponents["schemas"]["CashInstrument"]> &
|
|
4103
4132
|
Partial<coreComponents["schemas"]["CheckInstrument"]>;
|
|
4104
|
-
/**
|
|
4133
|
+
/**
|
|
4134
|
+
* Use custom fields to extend a resource scheme to include custom data
|
|
4135
|
+
* that is not provided as a common field. For more information, see
|
|
4136
|
+
* [Custom fields](https://api-reference.rebilly.com/tag/Custom-fields).
|
|
4137
|
+
*/
|
|
4105
4138
|
ResourceCustomFields: { [key: string]: any };
|
|
4106
|
-
/**
|
|
4139
|
+
/** List of phone numbers associated with the contact. */
|
|
4107
4140
|
ContactPhoneNumbers: {
|
|
4108
|
-
/**
|
|
4141
|
+
/** Phone number label or name. */
|
|
4109
4142
|
label: string;
|
|
4110
|
-
/**
|
|
4143
|
+
/** Phone number value. */
|
|
4111
4144
|
value: string;
|
|
4112
|
-
/**
|
|
4145
|
+
/**
|
|
4146
|
+
* Specifies whether the phone number is the contact's
|
|
4147
|
+
* primary phone number.
|
|
4148
|
+
*/
|
|
4113
4149
|
primary?: boolean;
|
|
4114
4150
|
}[];
|
|
4115
|
-
/**
|
|
4151
|
+
/** List of email addresses associated with the contact. */
|
|
4116
4152
|
ContactEmails: {
|
|
4117
|
-
/**
|
|
4153
|
+
/** Email label or name. */
|
|
4118
4154
|
label: string;
|
|
4119
|
-
/**
|
|
4155
|
+
/** Email address value. */
|
|
4120
4156
|
value: string;
|
|
4121
|
-
/**
|
|
4157
|
+
/**
|
|
4158
|
+
* Specifies whether the email address is the contact's
|
|
4159
|
+
* primary email address.
|
|
4160
|
+
*/
|
|
4122
4161
|
primary?: boolean;
|
|
4123
4162
|
}[];
|
|
4124
4163
|
ContactObject: {
|
|
4125
|
-
/**
|
|
4164
|
+
/** Contact's first name. */
|
|
4126
4165
|
firstName?: string | null;
|
|
4127
|
-
/**
|
|
4166
|
+
/** Contact's last name. */
|
|
4128
4167
|
lastName?: string | null;
|
|
4129
|
-
/** The contact organization. */
|
|
4168
|
+
/** The contact's organization. */
|
|
4130
4169
|
organization?: string | null;
|
|
4131
|
-
/**
|
|
4170
|
+
/** First line of the contact's street address. */
|
|
4132
4171
|
address?: string | null;
|
|
4133
|
-
/**
|
|
4172
|
+
/** Second line of the contact's street address. */
|
|
4134
4173
|
address2?: string | null;
|
|
4135
|
-
/**
|
|
4174
|
+
/** Contact's city of residence. */
|
|
4136
4175
|
city?: string | null;
|
|
4137
|
-
/**
|
|
4176
|
+
/** Contact's region of residence. */
|
|
4138
4177
|
region?: string | null;
|
|
4139
|
-
/**
|
|
4178
|
+
/**
|
|
4179
|
+
* Contact's country of residence in ISO 3166 alpha-2 country
|
|
4180
|
+
* code. For examples, see
|
|
4181
|
+
* [ISO.org](https://www.iso.org/obp/ui/#search/code/).
|
|
4182
|
+
*/
|
|
4140
4183
|
country?: string | null;
|
|
4141
|
-
/**
|
|
4184
|
+
/** Contact's postal code. */
|
|
4142
4185
|
postalCode?: string | null;
|
|
4143
4186
|
phoneNumbers?: coreComponents["schemas"]["ContactPhoneNumbers"];
|
|
4144
4187
|
emails?: coreComponents["schemas"]["ContactEmails"];
|
|
4145
|
-
/**
|
|
4188
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
4146
4189
|
dob?: string | null;
|
|
4147
4190
|
/** The contact's job title. */
|
|
4148
4191
|
jobTitle?: string | null;
|
|
4149
|
-
/**
|
|
4192
|
+
/**
|
|
4193
|
+
* Use this value to compare contacts for identical
|
|
4194
|
+
* attribute values.
|
|
4195
|
+
*/
|
|
4150
4196
|
hash?: string;
|
|
4151
4197
|
};
|
|
4152
4198
|
CustomerAverageValue: {
|
|
4153
4199
|
/** Merchant's reporting currency. */
|
|
4154
4200
|
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
4155
|
-
/**
|
|
4201
|
+
/**
|
|
4202
|
+
* Average approved payment amount in merchant's
|
|
4203
|
+
* reporting currency.
|
|
4204
|
+
*/
|
|
4156
4205
|
amount?: number;
|
|
4157
4206
|
/** Average approved payment amount in USD. */
|
|
4158
4207
|
amountUsd?: number;
|
|
@@ -4160,123 +4209,181 @@ export interface coreComponents {
|
|
|
4160
4209
|
CustomerLifetimeRevenue: {
|
|
4161
4210
|
/** Merchant's reporting currency. */
|
|
4162
4211
|
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
4163
|
-
/** Revenue amount in
|
|
4212
|
+
/** Revenue amount in the merchant's reporting currency. */
|
|
4164
4213
|
amount?: number;
|
|
4165
4214
|
/** Revenue amount in USD. */
|
|
4166
4215
|
amountUsd?: number;
|
|
4167
4216
|
};
|
|
4168
|
-
/**
|
|
4217
|
+
/**
|
|
4218
|
+
* Use tags to organize and categorize customers or KYC documents based
|
|
4219
|
+
* on keywords. For more information, see
|
|
4220
|
+
* [Tags](https://www.rebilly.com/docs/dev-docs/api/tag/Tags/).
|
|
4221
|
+
*/
|
|
4169
4222
|
Tag: {
|
|
4170
|
-
/**
|
|
4223
|
+
/** Unique tag identifier string. */
|
|
4171
4224
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4172
|
-
/**
|
|
4225
|
+
/** Unique tag name. Tag names are not case-sensitive. */
|
|
4173
4226
|
name: string;
|
|
4174
|
-
/**
|
|
4227
|
+
/**
|
|
4228
|
+
* Type of tag. Tags of a specific type can only be
|
|
4229
|
+
* assigned to corresponding entity types. For example, you can only use customer tags on customers.
|
|
4230
|
+
*/
|
|
4175
4231
|
type: "customer" | "kyc-document";
|
|
4176
|
-
/**
|
|
4232
|
+
/** Date and time at which the tag was created. */
|
|
4177
4233
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4178
4234
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
4179
|
-
/**
|
|
4235
|
+
/** Resource related links. */
|
|
4180
4236
|
_links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
|
|
4181
4237
|
};
|
|
4182
4238
|
DefaultPaymentInstrumentLink: coreComponents["schemas"]["Link"] & {
|
|
4183
|
-
/**
|
|
4239
|
+
/** Type of link. */
|
|
4184
4240
|
rel: "defaultPaymentInstrument";
|
|
4185
4241
|
};
|
|
4186
4242
|
LeadSourceLink: coreComponents["schemas"]["Link"] & {
|
|
4187
|
-
/**
|
|
4243
|
+
/** Type of link. */
|
|
4188
4244
|
rel: "leadSource";
|
|
4189
4245
|
};
|
|
4190
4246
|
WebsiteLink: coreComponents["schemas"]["Link"] & {
|
|
4191
|
-
/**
|
|
4247
|
+
/** Type of link. */
|
|
4192
4248
|
rel: "website";
|
|
4193
4249
|
};
|
|
4194
4250
|
LeadSourceData: {
|
|
4195
|
-
/**
|
|
4251
|
+
/**
|
|
4252
|
+
* Category of the lead source traffic. For example, the
|
|
4253
|
+
* medium could be organic search, Google ads, Display ads, and so on.
|
|
4254
|
+
*/
|
|
4196
4255
|
medium?: string;
|
|
4197
|
-
/**
|
|
4256
|
+
/**
|
|
4257
|
+
* Domain, platform, or channel from which the lead
|
|
4258
|
+
* source originates.
|
|
4259
|
+
*/
|
|
4198
4260
|
source?: string;
|
|
4199
|
-
/**
|
|
4261
|
+
/** Campaign name of the lead source. */
|
|
4200
4262
|
campaign?: string;
|
|
4201
|
-
/**
|
|
4263
|
+
/** Term associated with a lead source. */
|
|
4202
4264
|
term?: string;
|
|
4203
|
-
/**
|
|
4265
|
+
/**
|
|
4266
|
+
* Content contained in the lead source content.
|
|
4267
|
+
* For example, content could be graphics, video, and so on.
|
|
4268
|
+
*/
|
|
4204
4269
|
content?: string;
|
|
4205
|
-
/**
|
|
4270
|
+
/**
|
|
4271
|
+
* Individual or entity that is affilated with the lead
|
|
4272
|
+
* source.
|
|
4273
|
+
*/
|
|
4206
4274
|
affiliate?: string;
|
|
4207
|
-
/**
|
|
4275
|
+
/**
|
|
4276
|
+
* Individual or entity that is associated with a lead source
|
|
4277
|
+
* affiliate. In other products, this field may also be referred to
|
|
4278
|
+
* as sub ID or click ID in some.
|
|
4279
|
+
*/
|
|
4208
4280
|
subAffiliate?: string;
|
|
4209
|
-
/**
|
|
4281
|
+
/** Name of the sales agent associated with the lead source. */
|
|
4210
4282
|
salesAgent?: string;
|
|
4211
|
-
/**
|
|
4283
|
+
/**
|
|
4284
|
+
* Lead source click ID. This value is passed in the ad
|
|
4285
|
+
* click URL for tracking and campaign attribution.
|
|
4286
|
+
*/
|
|
4212
4287
|
clickId?: string;
|
|
4213
|
-
/**
|
|
4288
|
+
/** URL from which the lead source originates. */
|
|
4214
4289
|
path?: string;
|
|
4215
|
-
/**
|
|
4290
|
+
/**
|
|
4291
|
+
* Lead source
|
|
4292
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
4293
|
+
*/
|
|
4216
4294
|
referrer?: string;
|
|
4217
|
-
/**
|
|
4295
|
+
/** Date and time at which the lead source was created. */
|
|
4218
4296
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4219
|
-
/**
|
|
4297
|
+
/** Related resource links. */
|
|
4220
4298
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
4221
4299
|
Partial<coreComponents["schemas"]["CustomerLink"]>)[];
|
|
4222
4300
|
};
|
|
4223
4301
|
LeadSource: coreComponents["schemas"]["LeadSourceData"] & {
|
|
4224
4302
|
original?: coreComponents["schemas"]["LeadSourceData"];
|
|
4225
4303
|
};
|
|
4226
|
-
/**
|
|
4304
|
+
/**
|
|
4305
|
+
* Lead source object. A lead source is the marketing campaign that
|
|
4306
|
+
* generates customer interaction, a sale, or a trial. For more
|
|
4307
|
+
* information, see
|
|
4308
|
+
* [Lead source attribution](https://www.rebilly.com/docs/dev-docs/concepts/#lead-source-attribution).
|
|
4309
|
+
*/
|
|
4227
4310
|
LeadSourceEmbed: {
|
|
4228
4311
|
leadSource?: coreComponents["schemas"]["LeadSource"];
|
|
4229
4312
|
};
|
|
4230
4313
|
Customer: {
|
|
4231
|
-
/**
|
|
4314
|
+
/** Unique customer identifier string. */
|
|
4232
4315
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4233
|
-
/**
|
|
4316
|
+
/** Customer's email address. */
|
|
4234
4317
|
email?: string;
|
|
4235
|
-
/**
|
|
4318
|
+
/** Customer's first name. */
|
|
4236
4319
|
firstName?: string;
|
|
4237
|
-
/**
|
|
4320
|
+
/** Customer's last name. */
|
|
4238
4321
|
lastName?: string;
|
|
4239
|
-
/**
|
|
4322
|
+
/**
|
|
4323
|
+
* ID of the website where the customer made a transaction. A
|
|
4324
|
+
* website is where your organization obtains a customer.
|
|
4325
|
+
* For more information, see
|
|
4326
|
+
* [My organizations and websites](https://www.rebilly.com/docs/settings/organizations-and-websites/).
|
|
4327
|
+
*/
|
|
4240
4328
|
websiteId?: coreComponents["schemas"]["ResourceId"];
|
|
4241
4329
|
/**
|
|
4242
|
-
*
|
|
4243
|
-
* payment instrument and
|
|
4244
|
-
* value
|
|
4245
|
-
*
|
|
4246
|
-
*
|
|
4330
|
+
* Write-only payment token. If supplied, the token is converted
|
|
4331
|
+
* into a payment instrument and set as the
|
|
4332
|
+
* `defaultPaymentInstrument` value. If both are supplied, the
|
|
4333
|
+
* value of this property overrides the `defaultPaymentInstrument`
|
|
4334
|
+
* value. The token expires after first use.
|
|
4247
4335
|
*/
|
|
4248
4336
|
paymentToken?: string;
|
|
4249
4337
|
defaultPaymentInstrument?: coreComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
4250
|
-
/**
|
|
4338
|
+
/** Date and time at which the was customer created. */
|
|
4251
4339
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4252
4340
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
4253
4341
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
4254
4342
|
primaryAddress?: coreComponents["schemas"]["ContactObject"];
|
|
4255
4343
|
averageValue?: coreComponents["schemas"]["CustomerAverageValue"];
|
|
4256
|
-
/**
|
|
4344
|
+
/** Total number of approved payments made by the customer. */
|
|
4257
4345
|
paymentCount?: number;
|
|
4258
|
-
/**
|
|
4346
|
+
/** Time and date of the customer's last approved payment. */
|
|
4259
4347
|
lastPaymentTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4260
4348
|
lifetimeRevenue?: coreComponents["schemas"]["CustomerLifetimeRevenue"];
|
|
4261
|
-
/**
|
|
4349
|
+
/**
|
|
4350
|
+
* Total number of invoices issued to the customer. This value is
|
|
4351
|
+
* auto-incrementing. If this value is `0`, the record relates to
|
|
4352
|
+
* a lead. A lead is a customer who has not made a payment yet. If
|
|
4353
|
+
* this value is greater than or equal to `1` the record relates to
|
|
4354
|
+
* a customer.
|
|
4355
|
+
*/
|
|
4262
4356
|
invoiceCount?: number;
|
|
4263
4357
|
/** A list of customer's tags. */
|
|
4264
4358
|
tags?: coreComponents["schemas"]["Tag"][];
|
|
4265
4359
|
/**
|
|
4266
|
-
*
|
|
4267
|
-
*
|
|
4360
|
+
* Number of times the customer's data has been modified.
|
|
4361
|
+
*
|
|
4362
|
+
* Use this value when analyzing webhook data to determine if a
|
|
4363
|
+
* change must take precedence over the current representation.
|
|
4268
4364
|
*/
|
|
4269
4365
|
revision?: number;
|
|
4270
|
-
/**
|
|
4366
|
+
/**
|
|
4367
|
+
* Specifies whether Enhanced Due Diligence (EDD) is enabled for
|
|
4368
|
+
* this customer. For more information, see
|
|
4369
|
+
* [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).
|
|
4370
|
+
*/
|
|
4271
4371
|
isEddRequired: boolean;
|
|
4272
|
-
/**
|
|
4372
|
+
/**
|
|
4373
|
+
* Specifies whether the customer has accepted and reviewed
|
|
4374
|
+
* identity and address documents, or an accepted credit file
|
|
4375
|
+
* document.
|
|
4376
|
+
*/
|
|
4273
4377
|
hasFulfilledKyc?: boolean;
|
|
4274
|
-
/**
|
|
4378
|
+
/** Related resource links. */
|
|
4275
4379
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
4276
4380
|
Partial<coreComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
4277
4381
|
Partial<coreComponents["schemas"]["LeadSourceLink"]> &
|
|
4278
4382
|
Partial<coreComponents["schemas"]["WebsiteLink"]>)[];
|
|
4279
|
-
/**
|
|
4383
|
+
/**
|
|
4384
|
+
* Array of embedded objects that are requested using the `expand`
|
|
4385
|
+
* query string parameter.
|
|
4386
|
+
*/
|
|
4280
4387
|
_embedded?: Partial<coreComponents["schemas"]["LeadSourceEmbed"]>[];
|
|
4281
4388
|
};
|
|
4282
4389
|
CustomerTimelineCustomEvent: {
|
|
@@ -4516,6 +4623,7 @@ export interface coreComponents {
|
|
|
4516
4623
|
| "Circle"
|
|
4517
4624
|
| "Citadel"
|
|
4518
4625
|
| "Clearhaus"
|
|
4626
|
+
| "Cleo"
|
|
4519
4627
|
| "CODVoucher"
|
|
4520
4628
|
| "Coinbase"
|
|
4521
4629
|
| "CoinGate"
|
|
@@ -4538,6 +4646,7 @@ export interface coreComponents {
|
|
|
4538
4646
|
| "Euteller"
|
|
4539
4647
|
| "eMerchantPay"
|
|
4540
4648
|
| "EMS"
|
|
4649
|
+
| "ePay"
|
|
4541
4650
|
| "EPG"
|
|
4542
4651
|
| "EPro"
|
|
4543
4652
|
| "eZeeWallet"
|
|
@@ -4579,6 +4688,7 @@ export interface coreComponents {
|
|
|
4579
4688
|
| "Moneris"
|
|
4580
4689
|
| "MtaPay"
|
|
4581
4690
|
| "MuchBetter"
|
|
4691
|
+
| "MuchBetterGateway"
|
|
4582
4692
|
| "MyFatoorah"
|
|
4583
4693
|
| "Neosurf"
|
|
4584
4694
|
| "Netbanking"
|
|
@@ -4788,6 +4898,7 @@ export interface coreComponents {
|
|
|
4788
4898
|
| "Circle"
|
|
4789
4899
|
| "Citadel"
|
|
4790
4900
|
| "Clearhaus"
|
|
4901
|
+
| "Cleo"
|
|
4791
4902
|
| "CODVoucher"
|
|
4792
4903
|
| "Coinbase"
|
|
4793
4904
|
| "CoinGate"
|
|
@@ -4805,6 +4916,7 @@ export interface coreComponents {
|
|
|
4805
4916
|
| "EcorePay"
|
|
4806
4917
|
| "Elavon"
|
|
4807
4918
|
| "EMS"
|
|
4919
|
+
| "ePay"
|
|
4808
4920
|
| "EPG"
|
|
4809
4921
|
| "Euteller"
|
|
4810
4922
|
| "eZeeWallet"
|
|
@@ -4847,6 +4959,7 @@ export interface coreComponents {
|
|
|
4847
4959
|
| "MiFinity"
|
|
4848
4960
|
| "Moneris"
|
|
4849
4961
|
| "MuchBetter"
|
|
4962
|
+
| "MuchBetterGateway"
|
|
4850
4963
|
| "MyFatoorah"
|
|
4851
4964
|
| "NATWEST"
|
|
4852
4965
|
| "Neosurf"
|
|
@@ -5894,6 +6007,14 @@ export interface coreComponents {
|
|
|
5894
6007
|
};
|
|
5895
6008
|
threeDSecureServer?: coreComponents["schemas"]["Clearhaus3dsServers"];
|
|
5896
6009
|
};
|
|
6010
|
+
/** Cleo config. */
|
|
6011
|
+
Cleo: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6012
|
+
/** Cleo credentials object. */
|
|
6013
|
+
credentials: {
|
|
6014
|
+
/** Cleo access token. */
|
|
6015
|
+
accessToken: string;
|
|
6016
|
+
};
|
|
6017
|
+
};
|
|
5897
6018
|
/** Conekta config. */
|
|
5898
6019
|
Conekta: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5899
6020
|
/** Conekta credentials object. */
|
|
@@ -6112,6 +6233,10 @@ export interface coreComponents {
|
|
|
6112
6233
|
web_pay_login: string;
|
|
6113
6234
|
/** Directa24 web pay status password. */
|
|
6114
6235
|
web_pay_tran_key: string;
|
|
6236
|
+
/** Directa24 cashout login. */
|
|
6237
|
+
cashout_login?: string;
|
|
6238
|
+
/** Directa24 cashout password. */
|
|
6239
|
+
cashout_password?: string;
|
|
6115
6240
|
};
|
|
6116
6241
|
/** Directa24 settings object. */
|
|
6117
6242
|
settings?: {
|
|
@@ -6211,6 +6336,14 @@ export interface coreComponents {
|
|
|
6211
6336
|
};
|
|
6212
6337
|
threeDSecureServer?: coreComponents["schemas"]["EMS3dsServers"];
|
|
6213
6338
|
};
|
|
6339
|
+
/** ePay config. */
|
|
6340
|
+
ePay: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6341
|
+
/** ePay credentials object. */
|
|
6342
|
+
credentials: {
|
|
6343
|
+
merchantId: string;
|
|
6344
|
+
secretKey: string;
|
|
6345
|
+
};
|
|
6346
|
+
};
|
|
6214
6347
|
/** Euteller config. */
|
|
6215
6348
|
Euteller: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6216
6349
|
/** Euteller credentials object. */
|
|
@@ -6687,6 +6820,16 @@ export interface coreComponents {
|
|
|
6687
6820
|
hasPhoneNumberRequest: boolean;
|
|
6688
6821
|
};
|
|
6689
6822
|
};
|
|
6823
|
+
/** MuchBetterGateway config. */
|
|
6824
|
+
MuchBetterGateway: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6825
|
+
/** MuchBetterGateway credentials object. */
|
|
6826
|
+
credentials: {
|
|
6827
|
+
/** MuchBetterGateway api key. */
|
|
6828
|
+
apiKey: string;
|
|
6829
|
+
/** MuchBetterGateway secret key. */
|
|
6830
|
+
secretKey: string;
|
|
6831
|
+
};
|
|
6832
|
+
};
|
|
6690
6833
|
/** MyFatoorah config. */
|
|
6691
6834
|
MyFatoorah: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6692
6835
|
/** MyFatoorah credentials object. */
|
|
@@ -7334,6 +7477,11 @@ export interface coreComponents {
|
|
|
7334
7477
|
/** Redsys Gateway secret code. */
|
|
7335
7478
|
secretCode: string;
|
|
7336
7479
|
};
|
|
7480
|
+
/** Redsys settings object. */
|
|
7481
|
+
settings?: {
|
|
7482
|
+
/** Redsys terminal. */
|
|
7483
|
+
terminal?: string;
|
|
7484
|
+
};
|
|
7337
7485
|
};
|
|
7338
7486
|
/** Rotessa config. */
|
|
7339
7487
|
Rotessa: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -8413,17 +8561,13 @@ export interface coreComponents {
|
|
|
8413
8561
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
8414
8562
|
};
|
|
8415
8563
|
Product: coreComponents["schemas"]["CommonProduct"] & {
|
|
8416
|
-
/**
|
|
8417
|
-
|
|
8418
|
-
|
|
8419
|
-
|
|
8420
|
-
|
|
8421
|
-
|
|
8422
|
-
|
|
8423
|
-
| "51010"
|
|
8424
|
-
| "31000"
|
|
8425
|
-
| "30070";
|
|
8426
|
-
/** The product accounting code. */
|
|
8564
|
+
/**
|
|
8565
|
+
* Tax category of the product.
|
|
8566
|
+
* For a complete list of supported tax categories, see [TaxJar sales tax API reference](https://developers.taxjar.com/api/reference/#get-list-tax-categories).
|
|
8567
|
+
* If none of the tax categories from the list are applicable for your product, use the general tax category `00000`.
|
|
8568
|
+
*/
|
|
8569
|
+
taxCategoryId?: string;
|
|
8570
|
+
/** Accounting code of the product. */
|
|
8427
8571
|
accountingCode?: string;
|
|
8428
8572
|
/** The links related to resource. */
|
|
8429
8573
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
@@ -8546,23 +8690,15 @@ export interface coreComponents {
|
|
|
8546
8690
|
maxQuantity?: number;
|
|
8547
8691
|
}[];
|
|
8548
8692
|
};
|
|
8549
|
-
PlanPeriod: {
|
|
8550
|
-
/** The unit of time. */
|
|
8551
|
-
unit: "day" | "week" | "month" | "year";
|
|
8552
|
-
/** The length of time. */
|
|
8553
|
-
length: number;
|
|
8554
|
-
};
|
|
8555
|
-
/**
|
|
8556
|
-
* The billing timing in relation to the service period.
|
|
8557
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
8558
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
8559
|
-
*/
|
|
8560
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
8561
8693
|
CommonPlan: {
|
|
8562
8694
|
/** The plan ID. */
|
|
8563
8695
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
8564
8696
|
/** The plan name, displayed on invoices and receipts. */
|
|
8565
8697
|
name: string;
|
|
8698
|
+
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
8699
|
+
description?: string;
|
|
8700
|
+
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
8701
|
+
richDescription?: string;
|
|
8566
8702
|
/** The related product ID. */
|
|
8567
8703
|
productId: coreComponents["schemas"]["ResourceId"];
|
|
8568
8704
|
/** Name-value pairs to specify the product options. */
|
|
@@ -8571,31 +8707,14 @@ export interface coreComponents {
|
|
|
8571
8707
|
/** Currency sign. */
|
|
8572
8708
|
currencySign?: string;
|
|
8573
8709
|
pricing: coreComponents["schemas"]["PlanPriceFormula"];
|
|
8574
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
8575
|
-
recurringInterval?: coreComponents["schemas"]["PlanPeriod"] & {
|
|
8576
|
-
/**
|
|
8577
|
-
* The number of invoices this subscription order will generate
|
|
8578
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
8579
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
8580
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
8581
|
-
*/
|
|
8582
|
-
limit?: number;
|
|
8583
|
-
billingTiming?: coreComponents["schemas"]["PlanBillingTiming"];
|
|
8584
|
-
};
|
|
8585
|
-
/** The trial. Set `null` if no trial. */
|
|
8586
|
-
trial?: {
|
|
8587
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
8588
|
-
price: number;
|
|
8589
|
-
period: coreComponents["schemas"]["PlanPeriod"];
|
|
8590
|
-
};
|
|
8591
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
8592
|
-
isTrialOnly?: boolean;
|
|
8593
8710
|
/** The setup. Set `null` if no setup. */
|
|
8594
8711
|
setup?: {
|
|
8595
8712
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
8596
8713
|
price: number;
|
|
8597
8714
|
};
|
|
8598
8715
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
8716
|
+
/** Specifies whether a plan is active. */
|
|
8717
|
+
isActive?: boolean;
|
|
8599
8718
|
/**
|
|
8600
8719
|
* Increments when the plan is modified.
|
|
8601
8720
|
* Compare to materialized subscription items revision.
|
|
@@ -8604,7 +8723,24 @@ export interface coreComponents {
|
|
|
8604
8723
|
/** Plan created time. */
|
|
8605
8724
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8606
8725
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
8726
|
+
/** Whether a plan has a trial without recurring instructions. */
|
|
8727
|
+
isTrialOnly?: boolean;
|
|
8728
|
+
/** The links related to resource. */
|
|
8729
|
+
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
8730
|
+
};
|
|
8731
|
+
OneTimeSalePlan: coreComponents["schemas"]["CommonPlan"];
|
|
8732
|
+
PlanPeriod: {
|
|
8733
|
+
/** The unit of time. */
|
|
8734
|
+
unit: "day" | "week" | "month" | "year";
|
|
8735
|
+
/** The length of time. */
|
|
8736
|
+
length: number;
|
|
8607
8737
|
};
|
|
8738
|
+
/**
|
|
8739
|
+
* The billing timing in relation to the service period.
|
|
8740
|
+
* For `prepaid` plans the customer pays when the service period starts,
|
|
8741
|
+
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
8742
|
+
*/
|
|
8743
|
+
PlanBillingTiming: "prepaid" | "postpaid";
|
|
8608
8744
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
8609
8745
|
TimePluralUnit:
|
|
8610
8746
|
| "seconds"
|
|
@@ -8652,12 +8788,53 @@ export interface coreComponents {
|
|
|
8652
8788
|
issueTimeShift?: coreComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
8653
8789
|
dueTimeShift?: coreComponents["schemas"]["DueTimeShiftInstruction"];
|
|
8654
8790
|
};
|
|
8655
|
-
|
|
8656
|
-
/**
|
|
8791
|
+
SubscriptionOrderPlan: coreComponents["schemas"]["CommonPlan"] & {
|
|
8792
|
+
/** The service interval. For a one-time item, use `null`. */
|
|
8793
|
+
recurringInterval: coreComponents["schemas"]["PlanPeriod"] & {
|
|
8794
|
+
/**
|
|
8795
|
+
* The number of invoices this subscription order will generate
|
|
8796
|
+
* (if 1, it will not generate any beyond the initial order creation).
|
|
8797
|
+
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
8798
|
+
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
8799
|
+
*/
|
|
8800
|
+
limit?: number;
|
|
8801
|
+
billingTiming?: coreComponents["schemas"]["PlanBillingTiming"];
|
|
8802
|
+
};
|
|
8803
|
+
/** The trial configuration. Set `null` if no trial. */
|
|
8804
|
+
trial?: {
|
|
8805
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
8806
|
+
price: number;
|
|
8807
|
+
period: coreComponents["schemas"]["PlanPeriod"];
|
|
8808
|
+
};
|
|
8809
|
+
/**
|
|
8810
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
8811
|
+
* when billing must occur before the service period changes.
|
|
8812
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
8813
|
+
* be in advance of the billing date. For more information, see
|
|
8814
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
8815
|
+
*/
|
|
8816
|
+
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
8817
|
+
};
|
|
8818
|
+
TrialOnlyPlan: coreComponents["schemas"]["CommonPlan"] & {
|
|
8819
|
+
/** The trial configuration. */
|
|
8820
|
+
trial: {
|
|
8821
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
8822
|
+
price: number;
|
|
8823
|
+
period: coreComponents["schemas"]["PlanPeriod"];
|
|
8824
|
+
};
|
|
8825
|
+
/**
|
|
8826
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
8827
|
+
* when billing must occur before the service period changes.
|
|
8828
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
8829
|
+
* be in advance of the billing date. For more information, see
|
|
8830
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
8831
|
+
*/
|
|
8657
8832
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
8658
|
-
/** The links related to resource. */
|
|
8659
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
8660
8833
|
};
|
|
8834
|
+
Plan:
|
|
8835
|
+
| coreComponents["schemas"]["OneTimeSalePlan"]
|
|
8836
|
+
| coreComponents["schemas"]["SubscriptionOrderPlan"]
|
|
8837
|
+
| coreComponents["schemas"]["TrialOnlyPlan"];
|
|
8661
8838
|
/** Plan object. */
|
|
8662
8839
|
PlanEmbed: {
|
|
8663
8840
|
plan?: coreComponents["schemas"]["Plan"];
|
|
@@ -9653,24 +9830,32 @@ export interface coreComponents {
|
|
|
9653
9830
|
isIdentityDocument?: boolean;
|
|
9654
9831
|
/** If there is an exact match found online. */
|
|
9655
9832
|
isPublishedOnline?: boolean;
|
|
9833
|
+
/** Contains urls to matching images found online. */
|
|
9834
|
+
matchingImages?: string[];
|
|
9656
9835
|
/** The customer first name if it was matched, null otherwise. */
|
|
9657
9836
|
firstName?: string | null;
|
|
9658
9837
|
/** The customer last name if it was matched, null otherwise. */
|
|
9659
9838
|
lastName?: string | null;
|
|
9660
9839
|
/** The date of birth found on the document, null if not found. */
|
|
9661
9840
|
dateOfBirth?: string | null;
|
|
9662
|
-
/**
|
|
9663
|
-
expiryDate?: string | null;
|
|
9664
|
-
/** The expiration date found on the document, null if not found. */
|
|
9841
|
+
/** Expiration date detected on the document. If an expiration date is not detected, this value is null. */
|
|
9665
9842
|
expirationDate?: string | null;
|
|
9666
9843
|
/** The issued date found on the document, null if not found. */
|
|
9667
9844
|
issueDate?: string | null;
|
|
9668
9845
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
9669
9846
|
hasMinimalAge?: boolean | null;
|
|
9670
|
-
/**
|
|
9847
|
+
/** Nationality detected on a passport or citizenship document. If a nationality is not detected, this value is null. */
|
|
9671
9848
|
nationality?: string | null;
|
|
9849
|
+
/** Country where the document was issued. */
|
|
9850
|
+
issuanceCountry?: string | null;
|
|
9851
|
+
/** Region, state, province, or territory where the document was issued. */
|
|
9852
|
+
issuanceRegion?: string | null;
|
|
9853
|
+
/** Unique number on the identity document. This value may contain alphanumeric characters. */
|
|
9854
|
+
documentNumber?: string | null;
|
|
9672
9855
|
/** The interpreted subtype of the uploaded document. */
|
|
9673
9856
|
documentSubtype?: string | null;
|
|
9857
|
+
/** Expiry date detected on the document. If an expiry date is not detected, this value is null. */
|
|
9858
|
+
expiryDate?: string | null;
|
|
9674
9859
|
};
|
|
9675
9860
|
KycSettingsIdentity: {
|
|
9676
9861
|
/** The weights of all matched properties. */
|
|
@@ -9861,6 +10046,32 @@ export interface coreComponents {
|
|
|
9861
10046
|
*/
|
|
9862
10047
|
_embedded?: Partial<coreComponents["schemas"]["CustomerEmbed"]>[];
|
|
9863
10048
|
};
|
|
10049
|
+
CreditFileCommonDecisionData: {
|
|
10050
|
+
/** Last name match. */
|
|
10051
|
+
lastNameMatch?: string;
|
|
10052
|
+
/** First name match. */
|
|
10053
|
+
firstNameMatch?: string;
|
|
10054
|
+
/** Civic number match. */
|
|
10055
|
+
civicNumberMatch?: string;
|
|
10056
|
+
/** Street name match. */
|
|
10057
|
+
streetNameMatch?: string;
|
|
10058
|
+
/** City match. */
|
|
10059
|
+
cityMatch?: string;
|
|
10060
|
+
/** Postal code match. */
|
|
10061
|
+
postalCodeMatch?: string;
|
|
10062
|
+
/** Province match. */
|
|
10063
|
+
provinceMatch?: string;
|
|
10064
|
+
/** Date of birth match. */
|
|
10065
|
+
dateOfBirthMatch?: string;
|
|
10066
|
+
/** Age of credit file is three or more years old. */
|
|
10067
|
+
ageOfCreditFileThreeOrMoreYearsOld?: string;
|
|
10068
|
+
/** Address as reported. */
|
|
10069
|
+
addressAsReported?: string;
|
|
10070
|
+
/** Name as reported. */
|
|
10071
|
+
nameAsReported?: string;
|
|
10072
|
+
/** Date of birth as reported. */
|
|
10073
|
+
dateOfBirthAsReported?: string;
|
|
10074
|
+
};
|
|
9864
10075
|
CreditFileMatches: {
|
|
9865
10076
|
/** The credit bureau which is used to get credit file data. */
|
|
9866
10077
|
creditBureau?: "equifax" | "experian" | "transunion" | "test-bureau";
|
|
@@ -9880,7 +10091,24 @@ export interface coreComponents {
|
|
|
9880
10091
|
dateOpened?: string;
|
|
9881
10092
|
}[];
|
|
9882
10093
|
/** Extra data from credit bureau. */
|
|
9883
|
-
referenceData?: {
|
|
10094
|
+
referenceData?: {
|
|
10095
|
+
/** Single source hit. */
|
|
10096
|
+
singleSourceHit?: string;
|
|
10097
|
+
/** Dual source hit. */
|
|
10098
|
+
dualSourceHit?: string;
|
|
10099
|
+
/** Waterfall process. */
|
|
10100
|
+
waterfallProcess?: string;
|
|
10101
|
+
/** Credit file create date. */
|
|
10102
|
+
creditFileCreatedDate?: string;
|
|
10103
|
+
/** Number of trades on file. */
|
|
10104
|
+
numberOfTradesOnFile?: string;
|
|
10105
|
+
/** Data related to single source decision. */
|
|
10106
|
+
singleDecision?: coreComponents["schemas"]["CreditFileCommonDecisionData"];
|
|
10107
|
+
/** Data related to dual source decision. */
|
|
10108
|
+
dualDecision?:
|
|
10109
|
+
| coreComponents["schemas"]["CreditFileCommonDecisionData"][]
|
|
10110
|
+
| null;
|
|
10111
|
+
};
|
|
9884
10112
|
};
|
|
9885
10113
|
ProofOfCreditFileKycDocument: coreComponents["schemas"]["BaseKycDocument"] &
|
|
9886
10114
|
coreComponents["schemas"]["KycDocument"] & {
|
|
@@ -10031,6 +10259,7 @@ export interface coreComponents {
|
|
|
10031
10259
|
| "CASHlib"
|
|
10032
10260
|
| "CashToCode"
|
|
10033
10261
|
| "China UnionPay"
|
|
10262
|
+
| "Cleo"
|
|
10034
10263
|
| "CODVoucher"
|
|
10035
10264
|
| "Conekta-oxxo"
|
|
10036
10265
|
| "Cupon-de-pagos"
|
|
@@ -10319,6 +10548,9 @@ export interface coreComponents {
|
|
|
10319
10548
|
CoreReadyToPay: {
|
|
10320
10549
|
customerId?: coreComponents["schemas"]["CustomerId"];
|
|
10321
10550
|
} & coreComponents["schemas"]["ReadyToPay"];
|
|
10551
|
+
ReadyToPayMethods: {
|
|
10552
|
+
method?: string;
|
|
10553
|
+
};
|
|
10322
10554
|
/** The feature name. */
|
|
10323
10555
|
ApplePayFeatureName: "Apple Pay";
|
|
10324
10556
|
ApplePayFeature: {
|
|
@@ -10342,7 +10574,7 @@ export interface coreComponents {
|
|
|
10342
10574
|
* If no filters are sent, then no restrictions applied. This follows our standard filter format.
|
|
10343
10575
|
*/
|
|
10344
10576
|
ReadyToPayMethodFilters: string[];
|
|
10345
|
-
ReadyToPayPaymentCardMethod: {
|
|
10577
|
+
ReadyToPayPaymentCardMethod: coreComponents["schemas"]["ReadyToPayMethods"] & {
|
|
10346
10578
|
/** The payment method. */
|
|
10347
10579
|
method: "payment-card";
|
|
10348
10580
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features - will be null. */
|
|
@@ -10365,14 +10597,14 @@ export interface coreComponents {
|
|
|
10365
10597
|
/** The expiration time of a `linkToken`. */
|
|
10366
10598
|
expirationTime?: string;
|
|
10367
10599
|
};
|
|
10368
|
-
ReadyToPayAchMethod: {
|
|
10600
|
+
ReadyToPayAchMethod: coreComponents["schemas"]["ReadyToPayMethods"] & {
|
|
10369
10601
|
/** The payment method. */
|
|
10370
10602
|
method: "ach";
|
|
10371
10603
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features it will be null. */
|
|
10372
10604
|
feature?: coreComponents["schemas"]["AchPlaidFeature"] | null;
|
|
10373
10605
|
filters?: coreComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
10374
10606
|
};
|
|
10375
|
-
ReadyToPayGenericMethod: {
|
|
10607
|
+
ReadyToPayGenericMethod: coreComponents["schemas"]["ReadyToPayMethods"] & {
|
|
10376
10608
|
/** The payment method. */
|
|
10377
10609
|
method: coreComponents["schemas"]["AlternativePaymentMethods"];
|
|
10378
10610
|
filters?: coreComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
@@ -10388,7 +10620,7 @@ export interface coreComponents {
|
|
|
10388
10620
|
/** The expiration time of a billing agreement token. */
|
|
10389
10621
|
expirationTime: string;
|
|
10390
10622
|
};
|
|
10391
|
-
ReadyToPayPayPalMethod: {
|
|
10623
|
+
ReadyToPayPayPalMethod: coreComponents["schemas"]["ReadyToPayMethods"] & {
|
|
10392
10624
|
/** The payment method. */
|
|
10393
10625
|
method: "paypal";
|
|
10394
10626
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features it will be null. */
|
|
@@ -10403,20 +10635,13 @@ export interface coreComponents {
|
|
|
10403
10635
|
/** Klarna session token. */
|
|
10404
10636
|
sessionId: string;
|
|
10405
10637
|
};
|
|
10406
|
-
ReadyToPayKlarnaMethod: {
|
|
10638
|
+
ReadyToPayKlarnaMethod: coreComponents["schemas"]["ReadyToPayMethods"] & {
|
|
10407
10639
|
/** The payment method. */
|
|
10408
10640
|
method: "Klarna";
|
|
10409
10641
|
/** 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. */
|
|
10410
10642
|
feature?: coreComponents["schemas"]["KlarnaFeature"] | null;
|
|
10411
10643
|
filters?: coreComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
10412
10644
|
};
|
|
10413
|
-
ReadyToPayMethods: (Partial<
|
|
10414
|
-
coreComponents["schemas"]["ReadyToPayPaymentCardMethod"]
|
|
10415
|
-
> &
|
|
10416
|
-
Partial<coreComponents["schemas"]["ReadyToPayAchMethod"]> &
|
|
10417
|
-
Partial<coreComponents["schemas"]["ReadyToPayGenericMethod"]> &
|
|
10418
|
-
Partial<coreComponents["schemas"]["ReadyToPayPayPalMethod"]> &
|
|
10419
|
-
Partial<coreComponents["schemas"]["ReadyToPayKlarnaMethod"]>)[];
|
|
10420
10645
|
Subscription: {
|
|
10421
10646
|
/** Specifies the type of order, a subscription or a one-time purchase. */
|
|
10422
10647
|
orderType?: "subscription-order" | "one-time-order";
|
|
@@ -10426,25 +10651,9 @@ export interface coreComponents {
|
|
|
10426
10651
|
/** The ID of plan to use. */
|
|
10427
10652
|
id: coreComponents["schemas"]["ResourceId"];
|
|
10428
10653
|
};
|
|
10429
|
-
FlexiblePlan: coreComponents["schemas"]["
|
|
10654
|
+
FlexiblePlan: coreComponents["schemas"]["Plan"] & {
|
|
10430
10655
|
/** ID of a plan you wish to modify. */
|
|
10431
|
-
id
|
|
10432
|
-
/** Specifies whether a plan is active. */
|
|
10433
|
-
isActive?: boolean;
|
|
10434
|
-
/**
|
|
10435
|
-
* Use invoice time shift to adjust the invoice issue and due date
|
|
10436
|
-
* when billing must occur before the service period changes.
|
|
10437
|
-
* For example, rent must be paid in advance, so the invoice must
|
|
10438
|
-
* be in advance of the billing date. For more information, see
|
|
10439
|
-
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
10440
|
-
*/
|
|
10441
|
-
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"] | null;
|
|
10442
|
-
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
10443
|
-
description?: string;
|
|
10444
|
-
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
10445
|
-
richDescription?: string;
|
|
10446
|
-
/** Related resource links. */
|
|
10447
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10656
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
10448
10657
|
};
|
|
10449
10658
|
OrderItem: {
|
|
10450
10659
|
/** The plan identifier string. */
|
|
@@ -11410,7 +11619,7 @@ export interface coreComponents {
|
|
|
11410
11619
|
OrderPreview: coreComponents["schemas"]["CommonOrderPreview"] & {
|
|
11411
11620
|
shipping?: coreComponents["schemas"]["Shipping"];
|
|
11412
11621
|
};
|
|
11413
|
-
/** Rebilly
|
|
11622
|
+
/** Rebilly webhook event type. */
|
|
11414
11623
|
GlobalWebhookEventType:
|
|
11415
11624
|
| "aml-list-possibly-matched"
|
|
11416
11625
|
| "application-instance-disabled"
|
|
@@ -11753,7 +11962,10 @@ export interface coreComponents {
|
|
|
11753
11962
|
/** Plan resource. */
|
|
11754
11963
|
Plan: {
|
|
11755
11964
|
content: {
|
|
11756
|
-
"application/json":
|
|
11965
|
+
"application/json":
|
|
11966
|
+
| coreComponents["schemas"]["OneTimeSalePlan"]
|
|
11967
|
+
| coreComponents["schemas"]["SubscriptionOrderPlan"]
|
|
11968
|
+
| coreComponents["schemas"]["TrialOnlyPlan"];
|
|
11757
11969
|
};
|
|
11758
11970
|
};
|
|
11759
11971
|
/** Product resource. */
|
|
@@ -11815,7 +12027,7 @@ export interface coreComponents {
|
|
|
11815
12027
|
_embedded?: {
|
|
11816
12028
|
customer?: coreComponents["schemas"]["Customer"];
|
|
11817
12029
|
};
|
|
11818
|
-
/**
|
|
12030
|
+
/** Related resource links. */
|
|
11819
12031
|
_links?: Partial<coreComponents["schemas"]["CustomerLink"]>[];
|
|
11820
12032
|
};
|
|
11821
12033
|
};
|
|
@@ -12106,11 +12318,17 @@ export interface coreComponents {
|
|
|
12106
12318
|
};
|
|
12107
12319
|
};
|
|
12108
12320
|
headers: {
|
|
12109
|
-
/** Total items
|
|
12321
|
+
/** Total number of items. */
|
|
12110
12322
|
"Pagination-Total"?: number;
|
|
12111
|
-
/**
|
|
12323
|
+
/** Maximum number of items per page. */
|
|
12112
12324
|
"Pagination-Limit"?: number;
|
|
12113
|
-
/**
|
|
12325
|
+
/**
|
|
12326
|
+
* Specifies the starting point within the
|
|
12327
|
+
* collection of resource results. For example, a request with
|
|
12328
|
+
* `limit=20` retrieves and displays the first 20 results on a page. A
|
|
12329
|
+
* following request with `limit=20` and `offset=20`, retrieves the next
|
|
12330
|
+
* page of 20 results.
|
|
12331
|
+
*/
|
|
12114
12332
|
"Pagination-Offset"?: number;
|
|
12115
12333
|
/** The location of the related resource. */
|
|
12116
12334
|
Location?: string;
|
|
@@ -12119,24 +12337,35 @@ export interface coreComponents {
|
|
|
12119
12337
|
|
|
12120
12338
|
export interface operations {
|
|
12121
12339
|
/**
|
|
12122
|
-
*
|
|
12123
|
-
*
|
|
12340
|
+
* Searches a individual's details against multiple
|
|
12341
|
+
* Politically Exposed Person (PEP), sanction, or
|
|
12342
|
+
* adverse media lists to determine if the customer is blocklisted.
|
|
12343
|
+
* Performs a fuzzy search that uses Soundex. Note that
|
|
12344
|
+
* some returned fields may not contain values.
|
|
12124
12345
|
*/
|
|
12125
12346
|
GetAmlEntry: {
|
|
12126
12347
|
parameters: {
|
|
12127
12348
|
query: {
|
|
12128
|
-
/** First name of individual to search. */
|
|
12349
|
+
/** First name of the individual to search. */
|
|
12129
12350
|
firstName: string;
|
|
12130
|
-
/** Last name of individual to search. */
|
|
12351
|
+
/** Last name of the individual to search. */
|
|
12131
12352
|
lastName: string;
|
|
12132
|
-
/**
|
|
12353
|
+
/** Individual's date of birth in YYYY-MM-DD format. */
|
|
12133
12354
|
dob?: string;
|
|
12134
|
-
/**
|
|
12355
|
+
/**
|
|
12356
|
+
* Country where the individual lives in
|
|
12357
|
+
* ISO Alpha-2 code format. For examples, see
|
|
12358
|
+
* [ISO.org](https://www.iso.org/obp/ui/#search/code/).
|
|
12359
|
+
*/
|
|
12135
12360
|
country?: coreComponents["schemas"]["Country"];
|
|
12136
12361
|
};
|
|
12137
12362
|
};
|
|
12138
12363
|
responses: {
|
|
12139
|
-
/**
|
|
12364
|
+
/**
|
|
12365
|
+
* Results successfully retrieved.
|
|
12366
|
+
* - - -
|
|
12367
|
+
* Returns an array of objects that represent hits, or an empty array if no hits are found.
|
|
12368
|
+
*/
|
|
12140
12369
|
200: {
|
|
12141
12370
|
headers: {};
|
|
12142
12371
|
content: {
|
|
@@ -13154,8 +13383,11 @@ export interface operations {
|
|
|
13154
13383
|
};
|
|
13155
13384
|
};
|
|
13156
13385
|
/**
|
|
13157
|
-
*
|
|
13158
|
-
*
|
|
13386
|
+
* Searches a customer's information, by Rebilly customer ID, against
|
|
13387
|
+
* multiple Politically Exposed Person (PEP), sanction, or adverse
|
|
13388
|
+
* media lists to determine if the customer is blocklisted. Performs
|
|
13389
|
+
* a fuzzy search that uses Soundex. Note that some returned fields
|
|
13390
|
+
* may not contain values.
|
|
13159
13391
|
*/
|
|
13160
13392
|
GetCustomerAmlEntryCollection: {
|
|
13161
13393
|
parameters: {
|
|
@@ -13165,7 +13397,11 @@ export interface operations {
|
|
|
13165
13397
|
};
|
|
13166
13398
|
};
|
|
13167
13399
|
responses: {
|
|
13168
|
-
/**
|
|
13400
|
+
/**
|
|
13401
|
+
* Results successfully retrieved.
|
|
13402
|
+
* - - -
|
|
13403
|
+
* Returns an array of objects that represent hits, or an empty array if no hits are found.
|
|
13404
|
+
*/
|
|
13169
13405
|
200: {
|
|
13170
13406
|
headers: {};
|
|
13171
13407
|
content: {
|
|
@@ -13607,7 +13843,7 @@ export interface operations {
|
|
|
13607
13843
|
"Content-Type"?: string;
|
|
13608
13844
|
};
|
|
13609
13845
|
content: {
|
|
13610
|
-
"application/json": string;
|
|
13846
|
+
"application/json, application/pdf, image/jpg, image/png, image/gif, audio/mpeg": string;
|
|
13611
13847
|
};
|
|
13612
13848
|
};
|
|
13613
13849
|
302: coreComponents["responses"]["Found"];
|
|
@@ -14438,7 +14674,7 @@ export interface operations {
|
|
|
14438
14674
|
404: coreComponents["responses"]["NotFound"];
|
|
14439
14675
|
};
|
|
14440
14676
|
};
|
|
14441
|
-
/**
|
|
14677
|
+
/** Retrieves the credit amount allocated to the given invoice from a specific credit memo. */
|
|
14442
14678
|
GetInvoiceCreditMemoAllocation: {
|
|
14443
14679
|
parameters: {
|
|
14444
14680
|
path: {
|
|
@@ -14447,12 +14683,6 @@ export interface operations {
|
|
|
14447
14683
|
/** Credit memo ID. */
|
|
14448
14684
|
creditMemoId: string;
|
|
14449
14685
|
};
|
|
14450
|
-
query: {
|
|
14451
|
-
/** The collection items limit. */
|
|
14452
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
14453
|
-
/** The collection items offset. */
|
|
14454
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
14455
|
-
};
|
|
14456
14686
|
};
|
|
14457
14687
|
responses: {
|
|
14458
14688
|
/** The allocation was retrieved successfully. */
|
|
@@ -15375,7 +15605,7 @@ export interface operations {
|
|
|
15375
15605
|
/** Payment methods retrieved. */
|
|
15376
15606
|
200: {
|
|
15377
15607
|
content: {
|
|
15378
|
-
"application/json": coreComponents["schemas"]["ReadyToPayMethods"];
|
|
15608
|
+
"application/json": coreComponents["schemas"]["ReadyToPayMethods"][];
|
|
15379
15609
|
};
|
|
15380
15610
|
};
|
|
15381
15611
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -17308,6 +17538,12 @@ export interface operations {
|
|
|
17308
17538
|
/** The resource identifier string. */
|
|
17309
17539
|
id: coreComponents["parameters"]["resourceId"];
|
|
17310
17540
|
};
|
|
17541
|
+
query: {
|
|
17542
|
+
/** The collection items limit. */
|
|
17543
|
+
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
17544
|
+
/** The collection items offset. */
|
|
17545
|
+
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
17546
|
+
};
|
|
17311
17547
|
};
|
|
17312
17548
|
responses: {
|
|
17313
17549
|
/** EDD search results were retrieved successfully. */
|
|
@@ -18462,19 +18698,22 @@ export interface usersPaths {
|
|
|
18462
18698
|
|
|
18463
18699
|
export interface usersComponents {
|
|
18464
18700
|
schemas: {
|
|
18465
|
-
/**
|
|
18701
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
18466
18702
|
Country: string;
|
|
18467
18703
|
SelfLink: {
|
|
18468
|
-
/**
|
|
18704
|
+
/** Type of link. */
|
|
18469
18705
|
rel: "self";
|
|
18470
|
-
/**
|
|
18706
|
+
/** Link URL. */
|
|
18471
18707
|
href: string;
|
|
18472
18708
|
};
|
|
18473
|
-
/**
|
|
18709
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
18474
18710
|
ResourceId: string;
|
|
18475
|
-
/** Read-only timestamp
|
|
18711
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
18476
18712
|
ServerTimestamp: string;
|
|
18477
|
-
/**
|
|
18713
|
+
/**
|
|
18714
|
+
* Read-only timestamp. This value updates when the resource
|
|
18715
|
+
* is updated.
|
|
18716
|
+
*/
|
|
18478
18717
|
UpdatedTime: string;
|
|
18479
18718
|
Link: {
|
|
18480
18719
|
/** The link URL. */
|
|
@@ -18517,7 +18756,7 @@ export interface usersComponents {
|
|
|
18517
18756
|
/** The HTTP status code. */
|
|
18518
18757
|
status?: number;
|
|
18519
18758
|
} & usersComponents["schemas"]["BaseProblem"];
|
|
18520
|
-
/**
|
|
18759
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
18521
18760
|
CustomerId: string;
|
|
18522
18761
|
ApiKeyScope: {
|
|
18523
18762
|
/** The array of account identifier strings. */
|
|
@@ -18537,10 +18776,10 @@ export interface usersComponents {
|
|
|
18537
18776
|
permissions: usersComponents["schemas"]["AclPermissions"];
|
|
18538
18777
|
}[];
|
|
18539
18778
|
CustomerLink: usersComponents["schemas"]["Link"] & {
|
|
18540
|
-
/**
|
|
18779
|
+
/** Type of link. */
|
|
18541
18780
|
rel: "customer" | "targetCustomer";
|
|
18542
18781
|
};
|
|
18543
|
-
/** ISO 4217
|
|
18782
|
+
/** ISO 4217 currency code. */
|
|
18544
18783
|
CurrencyCode: string;
|
|
18545
18784
|
/** The context in which the discount applies. */
|
|
18546
18785
|
DiscountContext: "items" | "shipping" | "items-and-shipping";
|
|
@@ -18564,7 +18803,7 @@ export interface usersComponents {
|
|
|
18564
18803
|
Error: usersComponents["schemas"]["Problem"] & {
|
|
18565
18804
|
error?: string;
|
|
18566
18805
|
};
|
|
18567
|
-
/**
|
|
18806
|
+
/** Payment method. */
|
|
18568
18807
|
PaymentMethod:
|
|
18569
18808
|
| "payment-card"
|
|
18570
18809
|
| "ach"
|
|
@@ -18603,6 +18842,7 @@ export interface usersComponents {
|
|
|
18603
18842
|
| "CashToCode"
|
|
18604
18843
|
| "CCAvenue"
|
|
18605
18844
|
| "China UnionPay"
|
|
18845
|
+
| "Cleo"
|
|
18606
18846
|
| "CODVoucher"
|
|
18607
18847
|
| "Conekta-oxxo"
|
|
18608
18848
|
| "Conekta-spei"
|
|
@@ -18735,8 +18975,8 @@ export interface usersComponents {
|
|
|
18735
18975
|
/** Vaulted payment instrument. */
|
|
18736
18976
|
VaultedInstrument: {
|
|
18737
18977
|
/**
|
|
18738
|
-
*
|
|
18739
|
-
*
|
|
18978
|
+
* Payment method supported vault. For more information, see
|
|
18979
|
+
* [Payment Instrument](https://api-reference.rebilly.com/tag/Payment-Instruments).
|
|
18740
18980
|
*/
|
|
18741
18981
|
method: "payment-card" | "ach" | "paypal";
|
|
18742
18982
|
/** The payment instrument identifier. */
|
|
@@ -18745,13 +18985,13 @@ export interface usersComponents {
|
|
|
18745
18985
|
/** Alternative payment method instrument. */
|
|
18746
18986
|
AlternativePaymentInstrument: {
|
|
18747
18987
|
method: usersComponents["schemas"]["PaymentMethod"];
|
|
18748
|
-
/**
|
|
18988
|
+
/** Payment instrument ID. */
|
|
18749
18989
|
paymentInstrumentId?: usersComponents["schemas"]["ResourceId"];
|
|
18750
18990
|
};
|
|
18751
18991
|
/** Cash payment instrument object. */
|
|
18752
18992
|
CashInstrument: {
|
|
18753
18993
|
method: "cash";
|
|
18754
|
-
/**
|
|
18994
|
+
/** Individual or entity that received the payment. */
|
|
18755
18995
|
receivedBy?: string;
|
|
18756
18996
|
};
|
|
18757
18997
|
/** Check payment instrument object. */
|
|
@@ -18766,58 +19006,78 @@ export interface usersComponents {
|
|
|
18766
19006
|
Partial<usersComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
18767
19007
|
Partial<usersComponents["schemas"]["CashInstrument"]> &
|
|
18768
19008
|
Partial<usersComponents["schemas"]["CheckInstrument"]>;
|
|
18769
|
-
/**
|
|
19009
|
+
/**
|
|
19010
|
+
* Use custom fields to extend a resource scheme to include custom data
|
|
19011
|
+
* that is not provided as a common field. For more information, see
|
|
19012
|
+
* [Custom fields](https://api-reference.rebilly.com/tag/Custom-fields).
|
|
19013
|
+
*/
|
|
18770
19014
|
ResourceCustomFields: { [key: string]: any };
|
|
18771
|
-
/**
|
|
19015
|
+
/** List of phone numbers associated with the contact. */
|
|
18772
19016
|
ContactPhoneNumbers: {
|
|
18773
|
-
/**
|
|
19017
|
+
/** Phone number label or name. */
|
|
18774
19018
|
label: string;
|
|
18775
|
-
/**
|
|
19019
|
+
/** Phone number value. */
|
|
18776
19020
|
value: string;
|
|
18777
|
-
/**
|
|
19021
|
+
/**
|
|
19022
|
+
* Specifies whether the phone number is the contact's
|
|
19023
|
+
* primary phone number.
|
|
19024
|
+
*/
|
|
18778
19025
|
primary?: boolean;
|
|
18779
19026
|
}[];
|
|
18780
|
-
/**
|
|
19027
|
+
/** List of email addresses associated with the contact. */
|
|
18781
19028
|
ContactEmails: {
|
|
18782
|
-
/**
|
|
19029
|
+
/** Email label or name. */
|
|
18783
19030
|
label: string;
|
|
18784
|
-
/**
|
|
19031
|
+
/** Email address value. */
|
|
18785
19032
|
value: string;
|
|
18786
|
-
/**
|
|
19033
|
+
/**
|
|
19034
|
+
* Specifies whether the email address is the contact's
|
|
19035
|
+
* primary email address.
|
|
19036
|
+
*/
|
|
18787
19037
|
primary?: boolean;
|
|
18788
19038
|
}[];
|
|
18789
19039
|
ContactObject: {
|
|
18790
|
-
/**
|
|
19040
|
+
/** Contact's first name. */
|
|
18791
19041
|
firstName?: string | null;
|
|
18792
|
-
/**
|
|
19042
|
+
/** Contact's last name. */
|
|
18793
19043
|
lastName?: string | null;
|
|
18794
|
-
/** The contact organization. */
|
|
19044
|
+
/** The contact's organization. */
|
|
18795
19045
|
organization?: string | null;
|
|
18796
|
-
/**
|
|
19046
|
+
/** First line of the contact's street address. */
|
|
18797
19047
|
address?: string | null;
|
|
18798
|
-
/**
|
|
19048
|
+
/** Second line of the contact's street address. */
|
|
18799
19049
|
address2?: string | null;
|
|
18800
|
-
/**
|
|
19050
|
+
/** Contact's city of residence. */
|
|
18801
19051
|
city?: string | null;
|
|
18802
|
-
/**
|
|
19052
|
+
/** Contact's region of residence. */
|
|
18803
19053
|
region?: string | null;
|
|
18804
|
-
/**
|
|
19054
|
+
/**
|
|
19055
|
+
* Contact's country of residence in ISO 3166 alpha-2 country
|
|
19056
|
+
* code. For examples, see
|
|
19057
|
+
* [ISO.org](https://www.iso.org/obp/ui/#search/code/).
|
|
19058
|
+
*/
|
|
18805
19059
|
country?: string | null;
|
|
18806
|
-
/**
|
|
19060
|
+
/** Contact's postal code. */
|
|
18807
19061
|
postalCode?: string | null;
|
|
18808
19062
|
phoneNumbers?: usersComponents["schemas"]["ContactPhoneNumbers"];
|
|
18809
19063
|
emails?: usersComponents["schemas"]["ContactEmails"];
|
|
18810
|
-
/**
|
|
19064
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
18811
19065
|
dob?: string | null;
|
|
18812
19066
|
/** The contact's job title. */
|
|
18813
19067
|
jobTitle?: string | null;
|
|
18814
|
-
/**
|
|
19068
|
+
/**
|
|
19069
|
+
* Use this value to compare contacts for identical
|
|
19070
|
+
* attribute values.
|
|
19071
|
+
*/
|
|
18815
19072
|
hash?: string;
|
|
18816
19073
|
};
|
|
18817
19074
|
CustomerAverageValue: {
|
|
18818
19075
|
/** Merchant's reporting currency. */
|
|
18819
19076
|
currency?: usersComponents["schemas"]["CurrencyCode"];
|
|
18820
|
-
/**
|
|
19077
|
+
/**
|
|
19078
|
+
* Average approved payment amount in merchant's
|
|
19079
|
+
* reporting currency.
|
|
19080
|
+
*/
|
|
18821
19081
|
amount?: number;
|
|
18822
19082
|
/** Average approved payment amount in USD. */
|
|
18823
19083
|
amountUsd?: number;
|
|
@@ -18825,123 +19085,181 @@ export interface usersComponents {
|
|
|
18825
19085
|
CustomerLifetimeRevenue: {
|
|
18826
19086
|
/** Merchant's reporting currency. */
|
|
18827
19087
|
currency?: usersComponents["schemas"]["CurrencyCode"];
|
|
18828
|
-
/** Revenue amount in
|
|
19088
|
+
/** Revenue amount in the merchant's reporting currency. */
|
|
18829
19089
|
amount?: number;
|
|
18830
19090
|
/** Revenue amount in USD. */
|
|
18831
19091
|
amountUsd?: number;
|
|
18832
19092
|
};
|
|
18833
|
-
/**
|
|
19093
|
+
/**
|
|
19094
|
+
* Use tags to organize and categorize customers or KYC documents based
|
|
19095
|
+
* on keywords. For more information, see
|
|
19096
|
+
* [Tags](https://www.rebilly.com/docs/dev-docs/api/tag/Tags/).
|
|
19097
|
+
*/
|
|
18834
19098
|
Tag: {
|
|
18835
|
-
/**
|
|
19099
|
+
/** Unique tag identifier string. */
|
|
18836
19100
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
18837
|
-
/**
|
|
19101
|
+
/** Unique tag name. Tag names are not case-sensitive. */
|
|
18838
19102
|
name: string;
|
|
18839
|
-
/**
|
|
19103
|
+
/**
|
|
19104
|
+
* Type of tag. Tags of a specific type can only be
|
|
19105
|
+
* assigned to corresponding entity types. For example, you can only use customer tags on customers.
|
|
19106
|
+
*/
|
|
18840
19107
|
type: "customer" | "kyc-document";
|
|
18841
|
-
/**
|
|
19108
|
+
/** Date and time at which the tag was created. */
|
|
18842
19109
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18843
19110
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
18844
|
-
/**
|
|
19111
|
+
/** Resource related links. */
|
|
18845
19112
|
_links?: Partial<usersComponents["schemas"]["SelfLink"]>[];
|
|
18846
19113
|
};
|
|
18847
19114
|
DefaultPaymentInstrumentLink: usersComponents["schemas"]["Link"] & {
|
|
18848
|
-
/**
|
|
19115
|
+
/** Type of link. */
|
|
18849
19116
|
rel: "defaultPaymentInstrument";
|
|
18850
19117
|
};
|
|
18851
19118
|
LeadSourceLink: usersComponents["schemas"]["Link"] & {
|
|
18852
|
-
/**
|
|
19119
|
+
/** Type of link. */
|
|
18853
19120
|
rel: "leadSource";
|
|
18854
19121
|
};
|
|
18855
19122
|
WebsiteLink: usersComponents["schemas"]["Link"] & {
|
|
18856
|
-
/**
|
|
19123
|
+
/** Type of link. */
|
|
18857
19124
|
rel: "website";
|
|
18858
19125
|
};
|
|
18859
19126
|
LeadSourceData: {
|
|
18860
|
-
/**
|
|
19127
|
+
/**
|
|
19128
|
+
* Category of the lead source traffic. For example, the
|
|
19129
|
+
* medium could be organic search, Google ads, Display ads, and so on.
|
|
19130
|
+
*/
|
|
18861
19131
|
medium?: string;
|
|
18862
|
-
/**
|
|
19132
|
+
/**
|
|
19133
|
+
* Domain, platform, or channel from which the lead
|
|
19134
|
+
* source originates.
|
|
19135
|
+
*/
|
|
18863
19136
|
source?: string;
|
|
18864
|
-
/**
|
|
19137
|
+
/** Campaign name of the lead source. */
|
|
18865
19138
|
campaign?: string;
|
|
18866
|
-
/**
|
|
19139
|
+
/** Term associated with a lead source. */
|
|
18867
19140
|
term?: string;
|
|
18868
|
-
/**
|
|
19141
|
+
/**
|
|
19142
|
+
* Content contained in the lead source content.
|
|
19143
|
+
* For example, content could be graphics, video, and so on.
|
|
19144
|
+
*/
|
|
18869
19145
|
content?: string;
|
|
18870
|
-
/**
|
|
19146
|
+
/**
|
|
19147
|
+
* Individual or entity that is affilated with the lead
|
|
19148
|
+
* source.
|
|
19149
|
+
*/
|
|
18871
19150
|
affiliate?: string;
|
|
18872
|
-
/**
|
|
19151
|
+
/**
|
|
19152
|
+
* Individual or entity that is associated with a lead source
|
|
19153
|
+
* affiliate. In other products, this field may also be referred to
|
|
19154
|
+
* as sub ID or click ID in some.
|
|
19155
|
+
*/
|
|
18873
19156
|
subAffiliate?: string;
|
|
18874
|
-
/**
|
|
19157
|
+
/** Name of the sales agent associated with the lead source. */
|
|
18875
19158
|
salesAgent?: string;
|
|
18876
|
-
/**
|
|
19159
|
+
/**
|
|
19160
|
+
* Lead source click ID. This value is passed in the ad
|
|
19161
|
+
* click URL for tracking and campaign attribution.
|
|
19162
|
+
*/
|
|
18877
19163
|
clickId?: string;
|
|
18878
|
-
/**
|
|
19164
|
+
/** URL from which the lead source originates. */
|
|
18879
19165
|
path?: string;
|
|
18880
|
-
/**
|
|
19166
|
+
/**
|
|
19167
|
+
* Lead source
|
|
19168
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
19169
|
+
*/
|
|
18881
19170
|
referrer?: string;
|
|
18882
|
-
/**
|
|
19171
|
+
/** Date and time at which the lead source was created. */
|
|
18883
19172
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18884
|
-
/**
|
|
19173
|
+
/** Related resource links. */
|
|
18885
19174
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
18886
19175
|
Partial<usersComponents["schemas"]["CustomerLink"]>)[];
|
|
18887
19176
|
};
|
|
18888
19177
|
LeadSource: usersComponents["schemas"]["LeadSourceData"] & {
|
|
18889
19178
|
original?: usersComponents["schemas"]["LeadSourceData"];
|
|
18890
19179
|
};
|
|
18891
|
-
/**
|
|
19180
|
+
/**
|
|
19181
|
+
* Lead source object. A lead source is the marketing campaign that
|
|
19182
|
+
* generates customer interaction, a sale, or a trial. For more
|
|
19183
|
+
* information, see
|
|
19184
|
+
* [Lead source attribution](https://www.rebilly.com/docs/dev-docs/concepts/#lead-source-attribution).
|
|
19185
|
+
*/
|
|
18892
19186
|
LeadSourceEmbed: {
|
|
18893
19187
|
leadSource?: usersComponents["schemas"]["LeadSource"];
|
|
18894
19188
|
};
|
|
18895
19189
|
Customer: {
|
|
18896
|
-
/**
|
|
19190
|
+
/** Unique customer identifier string. */
|
|
18897
19191
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
18898
|
-
/**
|
|
19192
|
+
/** Customer's email address. */
|
|
18899
19193
|
email?: string;
|
|
18900
|
-
/**
|
|
19194
|
+
/** Customer's first name. */
|
|
18901
19195
|
firstName?: string;
|
|
18902
|
-
/**
|
|
19196
|
+
/** Customer's last name. */
|
|
18903
19197
|
lastName?: string;
|
|
18904
|
-
/**
|
|
19198
|
+
/**
|
|
19199
|
+
* ID of the website where the customer made a transaction. A
|
|
19200
|
+
* website is where your organization obtains a customer.
|
|
19201
|
+
* For more information, see
|
|
19202
|
+
* [My organizations and websites](https://www.rebilly.com/docs/settings/organizations-and-websites/).
|
|
19203
|
+
*/
|
|
18905
19204
|
websiteId?: usersComponents["schemas"]["ResourceId"];
|
|
18906
19205
|
/**
|
|
18907
|
-
*
|
|
18908
|
-
* payment instrument and
|
|
18909
|
-
* value
|
|
18910
|
-
*
|
|
18911
|
-
*
|
|
19206
|
+
* Write-only payment token. If supplied, the token is converted
|
|
19207
|
+
* into a payment instrument and set as the
|
|
19208
|
+
* `defaultPaymentInstrument` value. If both are supplied, the
|
|
19209
|
+
* value of this property overrides the `defaultPaymentInstrument`
|
|
19210
|
+
* value. The token expires after first use.
|
|
18912
19211
|
*/
|
|
18913
19212
|
paymentToken?: string;
|
|
18914
19213
|
defaultPaymentInstrument?: usersComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
18915
|
-
/**
|
|
19214
|
+
/** Date and time at which the was customer created. */
|
|
18916
19215
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18917
19216
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
18918
19217
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
18919
19218
|
primaryAddress?: usersComponents["schemas"]["ContactObject"];
|
|
18920
19219
|
averageValue?: usersComponents["schemas"]["CustomerAverageValue"];
|
|
18921
|
-
/**
|
|
19220
|
+
/** Total number of approved payments made by the customer. */
|
|
18922
19221
|
paymentCount?: number;
|
|
18923
|
-
/**
|
|
19222
|
+
/** Time and date of the customer's last approved payment. */
|
|
18924
19223
|
lastPaymentTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18925
19224
|
lifetimeRevenue?: usersComponents["schemas"]["CustomerLifetimeRevenue"];
|
|
18926
|
-
/**
|
|
19225
|
+
/**
|
|
19226
|
+
* Total number of invoices issued to the customer. This value is
|
|
19227
|
+
* auto-incrementing. If this value is `0`, the record relates to
|
|
19228
|
+
* a lead. A lead is a customer who has not made a payment yet. If
|
|
19229
|
+
* this value is greater than or equal to `1` the record relates to
|
|
19230
|
+
* a customer.
|
|
19231
|
+
*/
|
|
18927
19232
|
invoiceCount?: number;
|
|
18928
19233
|
/** A list of customer's tags. */
|
|
18929
19234
|
tags?: usersComponents["schemas"]["Tag"][];
|
|
18930
19235
|
/**
|
|
18931
|
-
*
|
|
18932
|
-
*
|
|
19236
|
+
* Number of times the customer's data has been modified.
|
|
19237
|
+
*
|
|
19238
|
+
* Use this value when analyzing webhook data to determine if a
|
|
19239
|
+
* change must take precedence over the current representation.
|
|
18933
19240
|
*/
|
|
18934
19241
|
revision?: number;
|
|
18935
|
-
/**
|
|
19242
|
+
/**
|
|
19243
|
+
* Specifies whether Enhanced Due Diligence (EDD) is enabled for
|
|
19244
|
+
* this customer. For more information, see
|
|
19245
|
+
* [Enhanced Due Diligence](https://www.rebilly.com/docs/kyc-and-aml/edd/).
|
|
19246
|
+
*/
|
|
18936
19247
|
isEddRequired: boolean;
|
|
18937
|
-
/**
|
|
19248
|
+
/**
|
|
19249
|
+
* Specifies whether the customer has accepted and reviewed
|
|
19250
|
+
* identity and address documents, or an accepted credit file
|
|
19251
|
+
* document.
|
|
19252
|
+
*/
|
|
18938
19253
|
hasFulfilledKyc?: boolean;
|
|
18939
|
-
/**
|
|
19254
|
+
/** Related resource links. */
|
|
18940
19255
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
18941
19256
|
Partial<usersComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
18942
19257
|
Partial<usersComponents["schemas"]["LeadSourceLink"]> &
|
|
18943
19258
|
Partial<usersComponents["schemas"]["WebsiteLink"]>)[];
|
|
18944
|
-
/**
|
|
19259
|
+
/**
|
|
19260
|
+
* Array of embedded objects that are requested using the `expand`
|
|
19261
|
+
* query string parameter.
|
|
19262
|
+
*/
|
|
18945
19263
|
_embedded?: Partial<usersComponents["schemas"]["LeadSourceEmbed"]>[];
|
|
18946
19264
|
};
|
|
18947
19265
|
TimelineAction: {
|
|
@@ -19079,6 +19397,7 @@ export interface usersComponents {
|
|
|
19079
19397
|
| "Circle"
|
|
19080
19398
|
| "Citadel"
|
|
19081
19399
|
| "Clearhaus"
|
|
19400
|
+
| "Cleo"
|
|
19082
19401
|
| "CODVoucher"
|
|
19083
19402
|
| "Coinbase"
|
|
19084
19403
|
| "CoinGate"
|
|
@@ -19101,6 +19420,7 @@ export interface usersComponents {
|
|
|
19101
19420
|
| "Euteller"
|
|
19102
19421
|
| "eMerchantPay"
|
|
19103
19422
|
| "EMS"
|
|
19423
|
+
| "ePay"
|
|
19104
19424
|
| "EPG"
|
|
19105
19425
|
| "EPro"
|
|
19106
19426
|
| "eZeeWallet"
|
|
@@ -19142,6 +19462,7 @@ export interface usersComponents {
|
|
|
19142
19462
|
| "Moneris"
|
|
19143
19463
|
| "MtaPay"
|
|
19144
19464
|
| "MuchBetter"
|
|
19465
|
+
| "MuchBetterGateway"
|
|
19145
19466
|
| "MyFatoorah"
|
|
19146
19467
|
| "Neosurf"
|
|
19147
19468
|
| "Netbanking"
|
|
@@ -19351,6 +19672,7 @@ export interface usersComponents {
|
|
|
19351
19672
|
| "Circle"
|
|
19352
19673
|
| "Citadel"
|
|
19353
19674
|
| "Clearhaus"
|
|
19675
|
+
| "Cleo"
|
|
19354
19676
|
| "CODVoucher"
|
|
19355
19677
|
| "Coinbase"
|
|
19356
19678
|
| "CoinGate"
|
|
@@ -19368,6 +19690,7 @@ export interface usersComponents {
|
|
|
19368
19690
|
| "EcorePay"
|
|
19369
19691
|
| "Elavon"
|
|
19370
19692
|
| "EMS"
|
|
19693
|
+
| "ePay"
|
|
19371
19694
|
| "EPG"
|
|
19372
19695
|
| "Euteller"
|
|
19373
19696
|
| "eZeeWallet"
|
|
@@ -19410,6 +19733,7 @@ export interface usersComponents {
|
|
|
19410
19733
|
| "MiFinity"
|
|
19411
19734
|
| "Moneris"
|
|
19412
19735
|
| "MuchBetter"
|
|
19736
|
+
| "MuchBetterGateway"
|
|
19413
19737
|
| "MyFatoorah"
|
|
19414
19738
|
| "NATWEST"
|
|
19415
19739
|
| "Neosurf"
|
|
@@ -20457,6 +20781,14 @@ export interface usersComponents {
|
|
|
20457
20781
|
};
|
|
20458
20782
|
threeDSecureServer?: usersComponents["schemas"]["Clearhaus3dsServers"];
|
|
20459
20783
|
};
|
|
20784
|
+
/** Cleo config. */
|
|
20785
|
+
Cleo: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20786
|
+
/** Cleo credentials object. */
|
|
20787
|
+
credentials: {
|
|
20788
|
+
/** Cleo access token. */
|
|
20789
|
+
accessToken: string;
|
|
20790
|
+
};
|
|
20791
|
+
};
|
|
20460
20792
|
/** Conekta config. */
|
|
20461
20793
|
Conekta: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20462
20794
|
/** Conekta credentials object. */
|
|
@@ -20675,6 +21007,10 @@ export interface usersComponents {
|
|
|
20675
21007
|
web_pay_login: string;
|
|
20676
21008
|
/** Directa24 web pay status password. */
|
|
20677
21009
|
web_pay_tran_key: string;
|
|
21010
|
+
/** Directa24 cashout login. */
|
|
21011
|
+
cashout_login?: string;
|
|
21012
|
+
/** Directa24 cashout password. */
|
|
21013
|
+
cashout_password?: string;
|
|
20678
21014
|
};
|
|
20679
21015
|
/** Directa24 settings object. */
|
|
20680
21016
|
settings?: {
|
|
@@ -20774,6 +21110,14 @@ export interface usersComponents {
|
|
|
20774
21110
|
};
|
|
20775
21111
|
threeDSecureServer?: usersComponents["schemas"]["EMS3dsServers"];
|
|
20776
21112
|
};
|
|
21113
|
+
/** ePay config. */
|
|
21114
|
+
ePay: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21115
|
+
/** ePay credentials object. */
|
|
21116
|
+
credentials: {
|
|
21117
|
+
merchantId: string;
|
|
21118
|
+
secretKey: string;
|
|
21119
|
+
};
|
|
21120
|
+
};
|
|
20777
21121
|
/** Euteller config. */
|
|
20778
21122
|
Euteller: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20779
21123
|
/** Euteller credentials object. */
|
|
@@ -21250,6 +21594,16 @@ export interface usersComponents {
|
|
|
21250
21594
|
hasPhoneNumberRequest: boolean;
|
|
21251
21595
|
};
|
|
21252
21596
|
};
|
|
21597
|
+
/** MuchBetterGateway config. */
|
|
21598
|
+
MuchBetterGateway: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21599
|
+
/** MuchBetterGateway credentials object. */
|
|
21600
|
+
credentials: {
|
|
21601
|
+
/** MuchBetterGateway api key. */
|
|
21602
|
+
apiKey: string;
|
|
21603
|
+
/** MuchBetterGateway secret key. */
|
|
21604
|
+
secretKey: string;
|
|
21605
|
+
};
|
|
21606
|
+
};
|
|
21253
21607
|
/** MyFatoorah config. */
|
|
21254
21608
|
MyFatoorah: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21255
21609
|
/** MyFatoorah credentials object. */
|
|
@@ -21897,6 +22251,11 @@ export interface usersComponents {
|
|
|
21897
22251
|
/** Redsys Gateway secret code. */
|
|
21898
22252
|
secretCode: string;
|
|
21899
22253
|
};
|
|
22254
|
+
/** Redsys settings object. */
|
|
22255
|
+
settings?: {
|
|
22256
|
+
/** Redsys terminal. */
|
|
22257
|
+
terminal?: string;
|
|
22258
|
+
};
|
|
21900
22259
|
};
|
|
21901
22260
|
/** Rotessa config. */
|
|
21902
22261
|
Rotessa: usersComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -22976,17 +23335,13 @@ export interface usersComponents {
|
|
|
22976
23335
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
22977
23336
|
};
|
|
22978
23337
|
Product: usersComponents["schemas"]["CommonProduct"] & {
|
|
22979
|
-
/**
|
|
22980
|
-
|
|
22981
|
-
|
|
22982
|
-
|
|
22983
|
-
|
|
22984
|
-
|
|
22985
|
-
|
|
22986
|
-
| "51010"
|
|
22987
|
-
| "31000"
|
|
22988
|
-
| "30070";
|
|
22989
|
-
/** The product accounting code. */
|
|
23338
|
+
/**
|
|
23339
|
+
* Tax category of the product.
|
|
23340
|
+
* For a complete list of supported tax categories, see [TaxJar sales tax API reference](https://developers.taxjar.com/api/reference/#get-list-tax-categories).
|
|
23341
|
+
* If none of the tax categories from the list are applicable for your product, use the general tax category `00000`.
|
|
23342
|
+
*/
|
|
23343
|
+
taxCategoryId?: string;
|
|
23344
|
+
/** Accounting code of the product. */
|
|
22990
23345
|
accountingCode?: string;
|
|
22991
23346
|
/** The links related to resource. */
|
|
22992
23347
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
@@ -23109,23 +23464,15 @@ export interface usersComponents {
|
|
|
23109
23464
|
maxQuantity?: number;
|
|
23110
23465
|
}[];
|
|
23111
23466
|
};
|
|
23112
|
-
PlanPeriod: {
|
|
23113
|
-
/** The unit of time. */
|
|
23114
|
-
unit: "day" | "week" | "month" | "year";
|
|
23115
|
-
/** The length of time. */
|
|
23116
|
-
length: number;
|
|
23117
|
-
};
|
|
23118
|
-
/**
|
|
23119
|
-
* The billing timing in relation to the service period.
|
|
23120
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
23121
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
23122
|
-
*/
|
|
23123
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
23124
23467
|
CommonPlan: {
|
|
23125
23468
|
/** The plan ID. */
|
|
23126
23469
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
23127
23470
|
/** The plan name, displayed on invoices and receipts. */
|
|
23128
23471
|
name: string;
|
|
23472
|
+
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
23473
|
+
description?: string;
|
|
23474
|
+
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
23475
|
+
richDescription?: string;
|
|
23129
23476
|
/** The related product ID. */
|
|
23130
23477
|
productId: usersComponents["schemas"]["ResourceId"];
|
|
23131
23478
|
/** Name-value pairs to specify the product options. */
|
|
@@ -23134,31 +23481,14 @@ export interface usersComponents {
|
|
|
23134
23481
|
/** Currency sign. */
|
|
23135
23482
|
currencySign?: string;
|
|
23136
23483
|
pricing: usersComponents["schemas"]["PlanPriceFormula"];
|
|
23137
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
23138
|
-
recurringInterval?: usersComponents["schemas"]["PlanPeriod"] & {
|
|
23139
|
-
/**
|
|
23140
|
-
* The number of invoices this subscription order will generate
|
|
23141
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
23142
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
23143
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
23144
|
-
*/
|
|
23145
|
-
limit?: number;
|
|
23146
|
-
billingTiming?: usersComponents["schemas"]["PlanBillingTiming"];
|
|
23147
|
-
};
|
|
23148
|
-
/** The trial. Set `null` if no trial. */
|
|
23149
|
-
trial?: {
|
|
23150
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
23151
|
-
price: number;
|
|
23152
|
-
period: usersComponents["schemas"]["PlanPeriod"];
|
|
23153
|
-
};
|
|
23154
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
23155
|
-
isTrialOnly?: boolean;
|
|
23156
23484
|
/** The setup. Set `null` if no setup. */
|
|
23157
23485
|
setup?: {
|
|
23158
23486
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
23159
23487
|
price: number;
|
|
23160
23488
|
};
|
|
23161
23489
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
23490
|
+
/** Specifies whether a plan is active. */
|
|
23491
|
+
isActive?: boolean;
|
|
23162
23492
|
/**
|
|
23163
23493
|
* Increments when the plan is modified.
|
|
23164
23494
|
* Compare to materialized subscription items revision.
|
|
@@ -23167,7 +23497,24 @@ export interface usersComponents {
|
|
|
23167
23497
|
/** Plan created time. */
|
|
23168
23498
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23169
23499
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
23500
|
+
/** Whether a plan has a trial without recurring instructions. */
|
|
23501
|
+
isTrialOnly?: boolean;
|
|
23502
|
+
/** The links related to resource. */
|
|
23503
|
+
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23170
23504
|
};
|
|
23505
|
+
OneTimeSalePlan: usersComponents["schemas"]["CommonPlan"];
|
|
23506
|
+
PlanPeriod: {
|
|
23507
|
+
/** The unit of time. */
|
|
23508
|
+
unit: "day" | "week" | "month" | "year";
|
|
23509
|
+
/** The length of time. */
|
|
23510
|
+
length: number;
|
|
23511
|
+
};
|
|
23512
|
+
/**
|
|
23513
|
+
* The billing timing in relation to the service period.
|
|
23514
|
+
* For `prepaid` plans the customer pays when the service period starts,
|
|
23515
|
+
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
23516
|
+
*/
|
|
23517
|
+
PlanBillingTiming: "prepaid" | "postpaid";
|
|
23171
23518
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
23172
23519
|
TimePluralUnit:
|
|
23173
23520
|
| "seconds"
|
|
@@ -23215,12 +23562,53 @@ export interface usersComponents {
|
|
|
23215
23562
|
issueTimeShift?: usersComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
23216
23563
|
dueTimeShift?: usersComponents["schemas"]["DueTimeShiftInstruction"];
|
|
23217
23564
|
};
|
|
23218
|
-
|
|
23219
|
-
/**
|
|
23565
|
+
SubscriptionOrderPlan: usersComponents["schemas"]["CommonPlan"] & {
|
|
23566
|
+
/** The service interval. For a one-time item, use `null`. */
|
|
23567
|
+
recurringInterval: usersComponents["schemas"]["PlanPeriod"] & {
|
|
23568
|
+
/**
|
|
23569
|
+
* The number of invoices this subscription order will generate
|
|
23570
|
+
* (if 1, it will not generate any beyond the initial order creation).
|
|
23571
|
+
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
23572
|
+
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
23573
|
+
*/
|
|
23574
|
+
limit?: number;
|
|
23575
|
+
billingTiming?: usersComponents["schemas"]["PlanBillingTiming"];
|
|
23576
|
+
};
|
|
23577
|
+
/** The trial configuration. Set `null` if no trial. */
|
|
23578
|
+
trial?: {
|
|
23579
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
23580
|
+
price: number;
|
|
23581
|
+
period: usersComponents["schemas"]["PlanPeriod"];
|
|
23582
|
+
};
|
|
23583
|
+
/**
|
|
23584
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
23585
|
+
* when billing must occur before the service period changes.
|
|
23586
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
23587
|
+
* be in advance of the billing date. For more information, see
|
|
23588
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
23589
|
+
*/
|
|
23590
|
+
invoiceTimeShift?: usersComponents["schemas"]["InvoiceTimeShift"];
|
|
23591
|
+
};
|
|
23592
|
+
TrialOnlyPlan: usersComponents["schemas"]["CommonPlan"] & {
|
|
23593
|
+
/** The trial configuration. */
|
|
23594
|
+
trial: {
|
|
23595
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
23596
|
+
price: number;
|
|
23597
|
+
period: usersComponents["schemas"]["PlanPeriod"];
|
|
23598
|
+
};
|
|
23599
|
+
/**
|
|
23600
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
23601
|
+
* when billing must occur before the service period changes.
|
|
23602
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
23603
|
+
* be in advance of the billing date. For more information, see
|
|
23604
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
23605
|
+
*/
|
|
23220
23606
|
invoiceTimeShift?: usersComponents["schemas"]["InvoiceTimeShift"];
|
|
23221
|
-
/** The links related to resource. */
|
|
23222
|
-
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23223
23607
|
};
|
|
23608
|
+
Plan:
|
|
23609
|
+
| usersComponents["schemas"]["OneTimeSalePlan"]
|
|
23610
|
+
| usersComponents["schemas"]["SubscriptionOrderPlan"]
|
|
23611
|
+
| usersComponents["schemas"]["TrialOnlyPlan"];
|
|
23224
23612
|
/** Plan object. */
|
|
23225
23613
|
PlanEmbed: {
|
|
23226
23614
|
plan?: usersComponents["schemas"]["Plan"];
|
|
@@ -23789,6 +24177,7 @@ export interface usersComponents {
|
|
|
23789
24177
|
| "CASHlib"
|
|
23790
24178
|
| "CashToCode"
|
|
23791
24179
|
| "China UnionPay"
|
|
24180
|
+
| "Cleo"
|
|
23792
24181
|
| "CODVoucher"
|
|
23793
24182
|
| "Conekta-oxxo"
|
|
23794
24183
|
| "Cupon-de-pagos"
|
|
@@ -25553,7 +25942,7 @@ export interface usersComponents {
|
|
|
25553
25942
|
SendTestEmail: usersComponents["schemas"]["RulesEmailNotification"];
|
|
25554
25943
|
/** Trigger a test webhook. */
|
|
25555
25944
|
SendPreviewWebhook: usersComponents["schemas"]["Webhook"];
|
|
25556
|
-
/** Rebilly
|
|
25945
|
+
/** Rebilly webhook event type. */
|
|
25557
25946
|
GlobalWebhookEventType:
|
|
25558
25947
|
| "aml-list-possibly-matched"
|
|
25559
25948
|
| "application-instance-disabled"
|
|
@@ -25795,9 +26184,9 @@ export interface usersComponents {
|
|
|
25795
26184
|
description?: string;
|
|
25796
26185
|
acl: usersComponents["schemas"]["Acl"];
|
|
25797
26186
|
allowedIps?: usersComponents["schemas"]["AllowedIps"];
|
|
25798
|
-
/** The list of senior roles
|
|
26187
|
+
/** The list of senior roles identifiers. */
|
|
25799
26188
|
seniorIds?: string[];
|
|
25800
|
-
/** The list of junior roles
|
|
26189
|
+
/** The list of junior roles identifiers. */
|
|
25801
26190
|
juniorIds?: string[];
|
|
25802
26191
|
/** The number of users with this role assigned. */
|
|
25803
26192
|
usersCount?: number;
|
|
@@ -26255,11 +26644,17 @@ export interface usersComponents {
|
|
|
26255
26644
|
};
|
|
26256
26645
|
};
|
|
26257
26646
|
headers: {
|
|
26258
|
-
/** Total items
|
|
26647
|
+
/** Total number of items. */
|
|
26259
26648
|
"Pagination-Total"?: number;
|
|
26260
|
-
/**
|
|
26649
|
+
/** Maximum number of items per page. */
|
|
26261
26650
|
"Pagination-Limit"?: number;
|
|
26262
|
-
/**
|
|
26651
|
+
/**
|
|
26652
|
+
* Specifies the starting point within the
|
|
26653
|
+
* collection of resource results. For example, a request with
|
|
26654
|
+
* `limit=20` retrieves and displays the first 20 results on a page. A
|
|
26655
|
+
* following request with `limit=20` and `offset=20`, retrieves the next
|
|
26656
|
+
* page of 20 results.
|
|
26657
|
+
*/
|
|
26263
26658
|
"Pagination-Offset"?: number;
|
|
26264
26659
|
/** The location of the related resource. */
|
|
26265
26660
|
Location?: string;
|
|
@@ -26429,6 +26824,12 @@ export interface operations {
|
|
|
26429
26824
|
/** The resource identifier string. */
|
|
26430
26825
|
id: usersComponents["parameters"]["resourceId"];
|
|
26431
26826
|
};
|
|
26827
|
+
query: {
|
|
26828
|
+
/** The collection items limit. */
|
|
26829
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
26830
|
+
/** The collection items offset. */
|
|
26831
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
26832
|
+
};
|
|
26432
26833
|
};
|
|
26433
26834
|
responses: {
|
|
26434
26835
|
/** Application instances were retrieved successfully. */
|
|
@@ -28247,6 +28648,14 @@ export interface operations {
|
|
|
28247
28648
|
};
|
|
28248
28649
|
};
|
|
28249
28650
|
GetEmailNotificationCollection: {
|
|
28651
|
+
parameters: {
|
|
28652
|
+
query: {
|
|
28653
|
+
/** The collection items limit. */
|
|
28654
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
28655
|
+
/** The collection items offset. */
|
|
28656
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
28657
|
+
};
|
|
28658
|
+
};
|
|
28250
28659
|
responses: {
|
|
28251
28660
|
/** A list of email notification events was retrieved successfully. */
|
|
28252
28661
|
200: {
|
|
@@ -29477,6 +29886,14 @@ export interface operations {
|
|
|
29477
29886
|
};
|
|
29478
29887
|
/** Retrieve a list of integrations. */
|
|
29479
29888
|
GetIntegrationCollection: {
|
|
29889
|
+
parameters: {
|
|
29890
|
+
query: {
|
|
29891
|
+
/** The collection items limit. */
|
|
29892
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
29893
|
+
/** The collection items offset. */
|
|
29894
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
29895
|
+
};
|
|
29896
|
+
};
|
|
29480
29897
|
responses: {
|
|
29481
29898
|
/** A list of integrations was retrieved successfully. */
|
|
29482
29899
|
200: {
|
|
@@ -29888,6 +30305,14 @@ export interface operations {
|
|
|
29888
30305
|
};
|
|
29889
30306
|
/** Retrieve payment methods metadata. */
|
|
29890
30307
|
GetPaymentMethodCollection: {
|
|
30308
|
+
parameters: {
|
|
30309
|
+
query: {
|
|
30310
|
+
/** The collection items limit. */
|
|
30311
|
+
limit?: usersComponents["parameters"]["collectionLimit"];
|
|
30312
|
+
/** The collection items offset. */
|
|
30313
|
+
offset?: usersComponents["parameters"]["collectionOffset"];
|
|
30314
|
+
};
|
|
30315
|
+
};
|
|
29891
30316
|
responses: {
|
|
29892
30317
|
/** Payment methods metadata was received. */
|
|
29893
30318
|
200: {
|
|
@@ -31303,19 +31728,22 @@ export interface storefrontPaths {
|
|
|
31303
31728
|
|
|
31304
31729
|
export interface storefrontComponents {
|
|
31305
31730
|
schemas: {
|
|
31306
|
-
/**
|
|
31731
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
31307
31732
|
Country: string;
|
|
31308
31733
|
SelfLink: {
|
|
31309
|
-
/**
|
|
31734
|
+
/** Type of link. */
|
|
31310
31735
|
rel: "self";
|
|
31311
|
-
/**
|
|
31736
|
+
/** Link URL. */
|
|
31312
31737
|
href: string;
|
|
31313
31738
|
};
|
|
31314
|
-
/**
|
|
31739
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
31315
31740
|
ResourceId: string;
|
|
31316
|
-
/** Read-only timestamp
|
|
31741
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
31317
31742
|
ServerTimestamp: string;
|
|
31318
|
-
/**
|
|
31743
|
+
/**
|
|
31744
|
+
* Read-only timestamp. This value updates when the resource
|
|
31745
|
+
* is updated.
|
|
31746
|
+
*/
|
|
31319
31747
|
UpdatedTime: string;
|
|
31320
31748
|
Link: {
|
|
31321
31749
|
/** The link URL. */
|
|
@@ -31358,17 +31786,17 @@ export interface storefrontComponents {
|
|
|
31358
31786
|
/** The HTTP status code. */
|
|
31359
31787
|
status?: number;
|
|
31360
31788
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
31361
|
-
/**
|
|
31789
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
31362
31790
|
CustomerId: string;
|
|
31363
31791
|
CustomerLink: storefrontComponents["schemas"]["Link"] & {
|
|
31364
|
-
/**
|
|
31792
|
+
/** Type of link. */
|
|
31365
31793
|
rel: "customer" | "targetCustomer";
|
|
31366
31794
|
};
|
|
31367
|
-
/** ISO 4217
|
|
31795
|
+
/** ISO 4217 currency code. */
|
|
31368
31796
|
CurrencyCode: string;
|
|
31369
31797
|
/** The context in which the discount applies. */
|
|
31370
31798
|
DiscountContext: "items" | "shipping" | "items-and-shipping";
|
|
31371
|
-
/**
|
|
31799
|
+
/** Payment method. */
|
|
31372
31800
|
PaymentMethod:
|
|
31373
31801
|
| "payment-card"
|
|
31374
31802
|
| "ach"
|
|
@@ -31407,6 +31835,7 @@ export interface storefrontComponents {
|
|
|
31407
31835
|
| "CashToCode"
|
|
31408
31836
|
| "CCAvenue"
|
|
31409
31837
|
| "China UnionPay"
|
|
31838
|
+
| "Cleo"
|
|
31410
31839
|
| "CODVoucher"
|
|
31411
31840
|
| "Conekta-oxxo"
|
|
31412
31841
|
| "Conekta-spei"
|
|
@@ -31536,80 +31965,119 @@ export interface storefrontComponents {
|
|
|
31536
31965
|
| "Yandex-money"
|
|
31537
31966
|
| "Zotapay"
|
|
31538
31967
|
| "Zimpler";
|
|
31539
|
-
/**
|
|
31968
|
+
/**
|
|
31969
|
+
* Use custom fields to extend a resource scheme to include custom data
|
|
31970
|
+
* that is not provided as a common field. For more information, see
|
|
31971
|
+
* [Custom fields](https://api-reference.rebilly.com/tag/Custom-fields).
|
|
31972
|
+
*/
|
|
31540
31973
|
ResourceCustomFields: { [key: string]: any };
|
|
31541
|
-
/**
|
|
31974
|
+
/** List of phone numbers associated with the contact. */
|
|
31542
31975
|
ContactPhoneNumbers: {
|
|
31543
|
-
/**
|
|
31976
|
+
/** Phone number label or name. */
|
|
31544
31977
|
label: string;
|
|
31545
|
-
/**
|
|
31978
|
+
/** Phone number value. */
|
|
31546
31979
|
value: string;
|
|
31547
|
-
/**
|
|
31980
|
+
/**
|
|
31981
|
+
* Specifies whether the phone number is the contact's
|
|
31982
|
+
* primary phone number.
|
|
31983
|
+
*/
|
|
31548
31984
|
primary?: boolean;
|
|
31549
31985
|
}[];
|
|
31550
|
-
/**
|
|
31986
|
+
/** List of email addresses associated with the contact. */
|
|
31551
31987
|
ContactEmails: {
|
|
31552
|
-
/**
|
|
31988
|
+
/** Email label or name. */
|
|
31553
31989
|
label: string;
|
|
31554
|
-
/**
|
|
31990
|
+
/** Email address value. */
|
|
31555
31991
|
value: string;
|
|
31556
|
-
/**
|
|
31992
|
+
/**
|
|
31993
|
+
* Specifies whether the email address is the contact's
|
|
31994
|
+
* primary email address.
|
|
31995
|
+
*/
|
|
31557
31996
|
primary?: boolean;
|
|
31558
31997
|
}[];
|
|
31559
31998
|
ContactObject: {
|
|
31560
|
-
/**
|
|
31999
|
+
/** Contact's first name. */
|
|
31561
32000
|
firstName?: string | null;
|
|
31562
|
-
/**
|
|
32001
|
+
/** Contact's last name. */
|
|
31563
32002
|
lastName?: string | null;
|
|
31564
|
-
/** The contact organization. */
|
|
32003
|
+
/** The contact's organization. */
|
|
31565
32004
|
organization?: string | null;
|
|
31566
|
-
/**
|
|
32005
|
+
/** First line of the contact's street address. */
|
|
31567
32006
|
address?: string | null;
|
|
31568
|
-
/**
|
|
32007
|
+
/** Second line of the contact's street address. */
|
|
31569
32008
|
address2?: string | null;
|
|
31570
|
-
/**
|
|
32009
|
+
/** Contact's city of residence. */
|
|
31571
32010
|
city?: string | null;
|
|
31572
|
-
/**
|
|
32011
|
+
/** Contact's region of residence. */
|
|
31573
32012
|
region?: string | null;
|
|
31574
|
-
/**
|
|
32013
|
+
/**
|
|
32014
|
+
* Contact's country of residence in ISO 3166 alpha-2 country
|
|
32015
|
+
* code. For examples, see
|
|
32016
|
+
* [ISO.org](https://www.iso.org/obp/ui/#search/code/).
|
|
32017
|
+
*/
|
|
31575
32018
|
country?: string | null;
|
|
31576
|
-
/**
|
|
32019
|
+
/** Contact's postal code. */
|
|
31577
32020
|
postalCode?: string | null;
|
|
31578
32021
|
phoneNumbers?: storefrontComponents["schemas"]["ContactPhoneNumbers"];
|
|
31579
32022
|
emails?: storefrontComponents["schemas"]["ContactEmails"];
|
|
31580
|
-
/**
|
|
32023
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
31581
32024
|
dob?: string | null;
|
|
31582
32025
|
/** The contact's job title. */
|
|
31583
32026
|
jobTitle?: string | null;
|
|
31584
|
-
/**
|
|
32027
|
+
/**
|
|
32028
|
+
* Use this value to compare contacts for identical
|
|
32029
|
+
* attribute values.
|
|
32030
|
+
*/
|
|
31585
32031
|
hash?: string;
|
|
31586
32032
|
};
|
|
31587
32033
|
LeadSourceData: {
|
|
31588
|
-
/**
|
|
32034
|
+
/**
|
|
32035
|
+
* Category of the lead source traffic. For example, the
|
|
32036
|
+
* medium could be organic search, Google ads, Display ads, and so on.
|
|
32037
|
+
*/
|
|
31589
32038
|
medium?: string;
|
|
31590
|
-
/**
|
|
32039
|
+
/**
|
|
32040
|
+
* Domain, platform, or channel from which the lead
|
|
32041
|
+
* source originates.
|
|
32042
|
+
*/
|
|
31591
32043
|
source?: string;
|
|
31592
|
-
/**
|
|
32044
|
+
/** Campaign name of the lead source. */
|
|
31593
32045
|
campaign?: string;
|
|
31594
|
-
/**
|
|
32046
|
+
/** Term associated with a lead source. */
|
|
31595
32047
|
term?: string;
|
|
31596
|
-
/**
|
|
32048
|
+
/**
|
|
32049
|
+
* Content contained in the lead source content.
|
|
32050
|
+
* For example, content could be graphics, video, and so on.
|
|
32051
|
+
*/
|
|
31597
32052
|
content?: string;
|
|
31598
|
-
/**
|
|
32053
|
+
/**
|
|
32054
|
+
* Individual or entity that is affilated with the lead
|
|
32055
|
+
* source.
|
|
32056
|
+
*/
|
|
31599
32057
|
affiliate?: string;
|
|
31600
|
-
/**
|
|
32058
|
+
/**
|
|
32059
|
+
* Individual or entity that is associated with a lead source
|
|
32060
|
+
* affiliate. In other products, this field may also be referred to
|
|
32061
|
+
* as sub ID or click ID in some.
|
|
32062
|
+
*/
|
|
31601
32063
|
subAffiliate?: string;
|
|
31602
|
-
/**
|
|
32064
|
+
/** Name of the sales agent associated with the lead source. */
|
|
31603
32065
|
salesAgent?: string;
|
|
31604
|
-
/**
|
|
32066
|
+
/**
|
|
32067
|
+
* Lead source click ID. This value is passed in the ad
|
|
32068
|
+
* click URL for tracking and campaign attribution.
|
|
32069
|
+
*/
|
|
31605
32070
|
clickId?: string;
|
|
31606
|
-
/**
|
|
32071
|
+
/** URL from which the lead source originates. */
|
|
31607
32072
|
path?: string;
|
|
31608
|
-
/**
|
|
32073
|
+
/**
|
|
32074
|
+
* Lead source
|
|
32075
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
32076
|
+
*/
|
|
31609
32077
|
referrer?: string;
|
|
31610
|
-
/**
|
|
32078
|
+
/** Date and time at which the lead source was created. */
|
|
31611
32079
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
31612
|
-
/**
|
|
32080
|
+
/** Related resource links. */
|
|
31613
32081
|
_links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
|
|
31614
32082
|
Partial<storefrontComponents["schemas"]["CustomerLink"]>)[];
|
|
31615
32083
|
};
|
|
@@ -31659,6 +32127,7 @@ export interface storefrontComponents {
|
|
|
31659
32127
|
| "Circle"
|
|
31660
32128
|
| "Citadel"
|
|
31661
32129
|
| "Clearhaus"
|
|
32130
|
+
| "Cleo"
|
|
31662
32131
|
| "CODVoucher"
|
|
31663
32132
|
| "Coinbase"
|
|
31664
32133
|
| "CoinGate"
|
|
@@ -31681,6 +32150,7 @@ export interface storefrontComponents {
|
|
|
31681
32150
|
| "Euteller"
|
|
31682
32151
|
| "eMerchantPay"
|
|
31683
32152
|
| "EMS"
|
|
32153
|
+
| "ePay"
|
|
31684
32154
|
| "EPG"
|
|
31685
32155
|
| "EPro"
|
|
31686
32156
|
| "eZeeWallet"
|
|
@@ -31722,6 +32192,7 @@ export interface storefrontComponents {
|
|
|
31722
32192
|
| "Moneris"
|
|
31723
32193
|
| "MtaPay"
|
|
31724
32194
|
| "MuchBetter"
|
|
32195
|
+
| "MuchBetterGateway"
|
|
31725
32196
|
| "MyFatoorah"
|
|
31726
32197
|
| "Neosurf"
|
|
31727
32198
|
| "Netbanking"
|
|
@@ -32225,17 +32696,13 @@ export interface storefrontComponents {
|
|
|
32225
32696
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
32226
32697
|
};
|
|
32227
32698
|
Product: storefrontComponents["schemas"]["CommonProduct"] & {
|
|
32228
|
-
/**
|
|
32229
|
-
|
|
32230
|
-
|
|
32231
|
-
|
|
32232
|
-
|
|
32233
|
-
|
|
32234
|
-
|
|
32235
|
-
| "51010"
|
|
32236
|
-
| "31000"
|
|
32237
|
-
| "30070";
|
|
32238
|
-
/** The product accounting code. */
|
|
32699
|
+
/**
|
|
32700
|
+
* Tax category of the product.
|
|
32701
|
+
* For a complete list of supported tax categories, see [TaxJar sales tax API reference](https://developers.taxjar.com/api/reference/#get-list-tax-categories).
|
|
32702
|
+
* If none of the tax categories from the list are applicable for your product, use the general tax category `00000`.
|
|
32703
|
+
*/
|
|
32704
|
+
taxCategoryId?: string;
|
|
32705
|
+
/** Accounting code of the product. */
|
|
32239
32706
|
accountingCode?: string;
|
|
32240
32707
|
/** The links related to resource. */
|
|
32241
32708
|
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
@@ -32358,23 +32825,15 @@ export interface storefrontComponents {
|
|
|
32358
32825
|
maxQuantity?: number;
|
|
32359
32826
|
}[];
|
|
32360
32827
|
};
|
|
32361
|
-
PlanPeriod: {
|
|
32362
|
-
/** The unit of time. */
|
|
32363
|
-
unit: "day" | "week" | "month" | "year";
|
|
32364
|
-
/** The length of time. */
|
|
32365
|
-
length: number;
|
|
32366
|
-
};
|
|
32367
|
-
/**
|
|
32368
|
-
* The billing timing in relation to the service period.
|
|
32369
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
32370
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
32371
|
-
*/
|
|
32372
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
32373
32828
|
CommonPlan: {
|
|
32374
32829
|
/** The plan ID. */
|
|
32375
32830
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
32376
32831
|
/** The plan name, displayed on invoices and receipts. */
|
|
32377
32832
|
name: string;
|
|
32833
|
+
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
32834
|
+
description?: string;
|
|
32835
|
+
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
32836
|
+
richDescription?: string;
|
|
32378
32837
|
/** The related product ID. */
|
|
32379
32838
|
productId: storefrontComponents["schemas"]["ResourceId"];
|
|
32380
32839
|
/** Name-value pairs to specify the product options. */
|
|
@@ -32383,31 +32842,14 @@ export interface storefrontComponents {
|
|
|
32383
32842
|
/** Currency sign. */
|
|
32384
32843
|
currencySign?: string;
|
|
32385
32844
|
pricing: storefrontComponents["schemas"]["PlanPriceFormula"];
|
|
32386
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
32387
|
-
recurringInterval?: storefrontComponents["schemas"]["PlanPeriod"] & {
|
|
32388
|
-
/**
|
|
32389
|
-
* The number of invoices this subscription order will generate
|
|
32390
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
32391
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
32392
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
32393
|
-
*/
|
|
32394
|
-
limit?: number;
|
|
32395
|
-
billingTiming?: storefrontComponents["schemas"]["PlanBillingTiming"];
|
|
32396
|
-
};
|
|
32397
|
-
/** The trial. Set `null` if no trial. */
|
|
32398
|
-
trial?: {
|
|
32399
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
32400
|
-
price: number;
|
|
32401
|
-
period: storefrontComponents["schemas"]["PlanPeriod"];
|
|
32402
|
-
};
|
|
32403
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
32404
|
-
isTrialOnly?: boolean;
|
|
32405
32845
|
/** The setup. Set `null` if no setup. */
|
|
32406
32846
|
setup?: {
|
|
32407
32847
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
32408
32848
|
price: number;
|
|
32409
32849
|
};
|
|
32410
32850
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
32851
|
+
/** Specifies whether a plan is active. */
|
|
32852
|
+
isActive?: boolean;
|
|
32411
32853
|
/**
|
|
32412
32854
|
* Increments when the plan is modified.
|
|
32413
32855
|
* Compare to materialized subscription items revision.
|
|
@@ -32416,7 +32858,24 @@ export interface storefrontComponents {
|
|
|
32416
32858
|
/** Plan created time. */
|
|
32417
32859
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
32418
32860
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
32861
|
+
/** Whether a plan has a trial without recurring instructions. */
|
|
32862
|
+
isTrialOnly?: boolean;
|
|
32863
|
+
/** The links related to resource. */
|
|
32864
|
+
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
32865
|
+
};
|
|
32866
|
+
OneTimeSalePlan: storefrontComponents["schemas"]["CommonPlan"];
|
|
32867
|
+
PlanPeriod: {
|
|
32868
|
+
/** The unit of time. */
|
|
32869
|
+
unit: "day" | "week" | "month" | "year";
|
|
32870
|
+
/** The length of time. */
|
|
32871
|
+
length: number;
|
|
32419
32872
|
};
|
|
32873
|
+
/**
|
|
32874
|
+
* The billing timing in relation to the service period.
|
|
32875
|
+
* For `prepaid` plans the customer pays when the service period starts,
|
|
32876
|
+
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
32877
|
+
*/
|
|
32878
|
+
PlanBillingTiming: "prepaid" | "postpaid";
|
|
32420
32879
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
32421
32880
|
TimePluralUnit:
|
|
32422
32881
|
| "seconds"
|
|
@@ -32464,12 +32923,53 @@ export interface storefrontComponents {
|
|
|
32464
32923
|
issueTimeShift?: storefrontComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
32465
32924
|
dueTimeShift?: storefrontComponents["schemas"]["DueTimeShiftInstruction"];
|
|
32466
32925
|
};
|
|
32467
|
-
|
|
32468
|
-
/**
|
|
32926
|
+
SubscriptionOrderPlan: storefrontComponents["schemas"]["CommonPlan"] & {
|
|
32927
|
+
/** The service interval. For a one-time item, use `null`. */
|
|
32928
|
+
recurringInterval: storefrontComponents["schemas"]["PlanPeriod"] & {
|
|
32929
|
+
/**
|
|
32930
|
+
* The number of invoices this subscription order will generate
|
|
32931
|
+
* (if 1, it will not generate any beyond the initial order creation).
|
|
32932
|
+
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
32933
|
+
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
32934
|
+
*/
|
|
32935
|
+
limit?: number;
|
|
32936
|
+
billingTiming?: storefrontComponents["schemas"]["PlanBillingTiming"];
|
|
32937
|
+
};
|
|
32938
|
+
/** The trial configuration. Set `null` if no trial. */
|
|
32939
|
+
trial?: {
|
|
32940
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
32941
|
+
price: number;
|
|
32942
|
+
period: storefrontComponents["schemas"]["PlanPeriod"];
|
|
32943
|
+
};
|
|
32944
|
+
/**
|
|
32945
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
32946
|
+
* when billing must occur before the service period changes.
|
|
32947
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
32948
|
+
* be in advance of the billing date. For more information, see
|
|
32949
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
32950
|
+
*/
|
|
32469
32951
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
32470
|
-
/** The links related to resource. */
|
|
32471
|
-
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
32472
32952
|
};
|
|
32953
|
+
TrialOnlyPlan: storefrontComponents["schemas"]["CommonPlan"] & {
|
|
32954
|
+
/** The trial configuration. */
|
|
32955
|
+
trial: {
|
|
32956
|
+
/** The price of the trial. For a free trial, use `0`. */
|
|
32957
|
+
price: number;
|
|
32958
|
+
period: storefrontComponents["schemas"]["PlanPeriod"];
|
|
32959
|
+
};
|
|
32960
|
+
/**
|
|
32961
|
+
* Use invoice time shift to adjust the invoice issue and due date
|
|
32962
|
+
* when billing must occur before the service period changes.
|
|
32963
|
+
* For example, rent must be paid in advance, so the invoice must
|
|
32964
|
+
* be in advance of the billing date. For more information, see
|
|
32965
|
+
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
32966
|
+
*/
|
|
32967
|
+
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
32968
|
+
};
|
|
32969
|
+
Plan:
|
|
32970
|
+
| storefrontComponents["schemas"]["OneTimeSalePlan"]
|
|
32971
|
+
| storefrontComponents["schemas"]["SubscriptionOrderPlan"]
|
|
32972
|
+
| storefrontComponents["schemas"]["TrialOnlyPlan"];
|
|
32473
32973
|
/** Plan object. */
|
|
32474
32974
|
PlanEmbed: {
|
|
32475
32975
|
plan?: storefrontComponents["schemas"]["Plan"];
|
|
@@ -32815,24 +33315,32 @@ export interface storefrontComponents {
|
|
|
32815
33315
|
isIdentityDocument?: boolean;
|
|
32816
33316
|
/** If there is an exact match found online. */
|
|
32817
33317
|
isPublishedOnline?: boolean;
|
|
33318
|
+
/** Contains urls to matching images found online. */
|
|
33319
|
+
matchingImages?: string[];
|
|
32818
33320
|
/** The customer first name if it was matched, null otherwise. */
|
|
32819
33321
|
firstName?: string | null;
|
|
32820
33322
|
/** The customer last name if it was matched, null otherwise. */
|
|
32821
33323
|
lastName?: string | null;
|
|
32822
33324
|
/** The date of birth found on the document, null if not found. */
|
|
32823
33325
|
dateOfBirth?: string | null;
|
|
32824
|
-
/**
|
|
32825
|
-
expiryDate?: string | null;
|
|
32826
|
-
/** The expiration date found on the document, null if not found. */
|
|
33326
|
+
/** Expiration date detected on the document. If an expiration date is not detected, this value is null. */
|
|
32827
33327
|
expirationDate?: string | null;
|
|
32828
33328
|
/** The issued date found on the document, null if not found. */
|
|
32829
33329
|
issueDate?: string | null;
|
|
32830
33330
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
32831
33331
|
hasMinimalAge?: boolean | null;
|
|
32832
|
-
/**
|
|
33332
|
+
/** Nationality detected on a passport or citizenship document. If a nationality is not detected, this value is null. */
|
|
32833
33333
|
nationality?: string | null;
|
|
33334
|
+
/** Country where the document was issued. */
|
|
33335
|
+
issuanceCountry?: string | null;
|
|
33336
|
+
/** Region, state, province, or territory where the document was issued. */
|
|
33337
|
+
issuanceRegion?: string | null;
|
|
33338
|
+
/** Unique number on the identity document. This value may contain alphanumeric characters. */
|
|
33339
|
+
documentNumber?: string | null;
|
|
32834
33340
|
/** The interpreted subtype of the uploaded document. */
|
|
32835
33341
|
documentSubtype?: string | null;
|
|
33342
|
+
/** Expiry date detected on the document. If an expiry date is not detected, this value is null. */
|
|
33343
|
+
expiryDate?: string | null;
|
|
32836
33344
|
};
|
|
32837
33345
|
AddressMatches: {
|
|
32838
33346
|
/** The customer first name if it was matched, null otherwise. */
|
|
@@ -32868,6 +33376,32 @@ export interface storefrontComponents {
|
|
|
32868
33376
|
/** The interpreted subtype of the uploaded document. */
|
|
32869
33377
|
documentSubtype?: string | null;
|
|
32870
33378
|
};
|
|
33379
|
+
CreditFileCommonDecisionData: {
|
|
33380
|
+
/** Last name match. */
|
|
33381
|
+
lastNameMatch?: string;
|
|
33382
|
+
/** First name match. */
|
|
33383
|
+
firstNameMatch?: string;
|
|
33384
|
+
/** Civic number match. */
|
|
33385
|
+
civicNumberMatch?: string;
|
|
33386
|
+
/** Street name match. */
|
|
33387
|
+
streetNameMatch?: string;
|
|
33388
|
+
/** City match. */
|
|
33389
|
+
cityMatch?: string;
|
|
33390
|
+
/** Postal code match. */
|
|
33391
|
+
postalCodeMatch?: string;
|
|
33392
|
+
/** Province match. */
|
|
33393
|
+
provinceMatch?: string;
|
|
33394
|
+
/** Date of birth match. */
|
|
33395
|
+
dateOfBirthMatch?: string;
|
|
33396
|
+
/** Age of credit file is three or more years old. */
|
|
33397
|
+
ageOfCreditFileThreeOrMoreYearsOld?: string;
|
|
33398
|
+
/** Address as reported. */
|
|
33399
|
+
addressAsReported?: string;
|
|
33400
|
+
/** Name as reported. */
|
|
33401
|
+
nameAsReported?: string;
|
|
33402
|
+
/** Date of birth as reported. */
|
|
33403
|
+
dateOfBirthAsReported?: string;
|
|
33404
|
+
};
|
|
32871
33405
|
CreditFileMatches: {
|
|
32872
33406
|
/** The credit bureau which is used to get credit file data. */
|
|
32873
33407
|
creditBureau?: "equifax" | "experian" | "transunion" | "test-bureau";
|
|
@@ -32887,7 +33421,24 @@ export interface storefrontComponents {
|
|
|
32887
33421
|
dateOpened?: string;
|
|
32888
33422
|
}[];
|
|
32889
33423
|
/** Extra data from credit bureau. */
|
|
32890
|
-
referenceData?: {
|
|
33424
|
+
referenceData?: {
|
|
33425
|
+
/** Single source hit. */
|
|
33426
|
+
singleSourceHit?: string;
|
|
33427
|
+
/** Dual source hit. */
|
|
33428
|
+
dualSourceHit?: string;
|
|
33429
|
+
/** Waterfall process. */
|
|
33430
|
+
waterfallProcess?: string;
|
|
33431
|
+
/** Credit file create date. */
|
|
33432
|
+
creditFileCreatedDate?: string;
|
|
33433
|
+
/** Number of trades on file. */
|
|
33434
|
+
numberOfTradesOnFile?: string;
|
|
33435
|
+
/** Data related to single source decision. */
|
|
33436
|
+
singleDecision?: storefrontComponents["schemas"]["CreditFileCommonDecisionData"];
|
|
33437
|
+
/** Data related to dual source decision. */
|
|
33438
|
+
dualDecision?:
|
|
33439
|
+
| storefrontComponents["schemas"]["CreditFileCommonDecisionData"][]
|
|
33440
|
+
| null;
|
|
33441
|
+
};
|
|
32891
33442
|
};
|
|
32892
33443
|
CommonPayPalAccount: {
|
|
32893
33444
|
/** ID of the payment instrument. */
|
|
@@ -32962,6 +33513,7 @@ export interface storefrontComponents {
|
|
|
32962
33513
|
| "CASHlib"
|
|
32963
33514
|
| "CashToCode"
|
|
32964
33515
|
| "China UnionPay"
|
|
33516
|
+
| "Cleo"
|
|
32965
33517
|
| "CODVoucher"
|
|
32966
33518
|
| "Conekta-oxxo"
|
|
32967
33519
|
| "Cupon-de-pagos"
|
|
@@ -33183,6 +33735,9 @@ export interface storefrontComponents {
|
|
|
33183
33735
|
billingAddress?: storefrontComponents["schemas"]["ContactObject"];
|
|
33184
33736
|
riskMetadata: storefrontComponents["schemas"]["RiskMetadata"];
|
|
33185
33737
|
};
|
|
33738
|
+
ReadyToPayMethods: {
|
|
33739
|
+
method?: string;
|
|
33740
|
+
};
|
|
33186
33741
|
/** The feature name. */
|
|
33187
33742
|
ApplePayFeatureName: "Apple Pay";
|
|
33188
33743
|
ApplePayFeature: {
|
|
@@ -33206,7 +33761,7 @@ export interface storefrontComponents {
|
|
|
33206
33761
|
* If no filters are sent, then no restrictions applied. This follows our standard filter format.
|
|
33207
33762
|
*/
|
|
33208
33763
|
ReadyToPayMethodFilters: string[];
|
|
33209
|
-
ReadyToPayPaymentCardMethod: {
|
|
33764
|
+
ReadyToPayPaymentCardMethod: storefrontComponents["schemas"]["ReadyToPayMethods"] & {
|
|
33210
33765
|
/** The payment method. */
|
|
33211
33766
|
method: "payment-card";
|
|
33212
33767
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features - will be null. */
|
|
@@ -33229,14 +33784,14 @@ export interface storefrontComponents {
|
|
|
33229
33784
|
/** The expiration time of a `linkToken`. */
|
|
33230
33785
|
expirationTime?: string;
|
|
33231
33786
|
};
|
|
33232
|
-
ReadyToPayAchMethod: {
|
|
33787
|
+
ReadyToPayAchMethod: storefrontComponents["schemas"]["ReadyToPayMethods"] & {
|
|
33233
33788
|
/** The payment method. */
|
|
33234
33789
|
method: "ach";
|
|
33235
33790
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features it will be null. */
|
|
33236
33791
|
feature?: storefrontComponents["schemas"]["AchPlaidFeature"] | null;
|
|
33237
33792
|
filters?: storefrontComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
33238
33793
|
};
|
|
33239
|
-
ReadyToPayGenericMethod: {
|
|
33794
|
+
ReadyToPayGenericMethod: storefrontComponents["schemas"]["ReadyToPayMethods"] & {
|
|
33240
33795
|
/** The payment method. */
|
|
33241
33796
|
method: storefrontComponents["schemas"]["AlternativePaymentMethods"];
|
|
33242
33797
|
filters?: storefrontComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
@@ -33252,7 +33807,7 @@ export interface storefrontComponents {
|
|
|
33252
33807
|
/** The expiration time of a billing agreement token. */
|
|
33253
33808
|
expirationTime: string;
|
|
33254
33809
|
};
|
|
33255
|
-
ReadyToPayPayPalMethod: {
|
|
33810
|
+
ReadyToPayPayPalMethod: storefrontComponents["schemas"]["ReadyToPayMethods"] & {
|
|
33256
33811
|
/** The payment method. */
|
|
33257
33812
|
method: "paypal";
|
|
33258
33813
|
/** The specific feature (for example, digital wallet or a processor) of this method. If method doesn't have any features it will be null. */
|
|
@@ -33267,44 +33822,21 @@ export interface storefrontComponents {
|
|
|
33267
33822
|
/** Klarna session token. */
|
|
33268
33823
|
sessionId: string;
|
|
33269
33824
|
};
|
|
33270
|
-
ReadyToPayKlarnaMethod: {
|
|
33825
|
+
ReadyToPayKlarnaMethod: storefrontComponents["schemas"]["ReadyToPayMethods"] & {
|
|
33271
33826
|
/** The payment method. */
|
|
33272
33827
|
method: "Klarna";
|
|
33273
33828
|
/** 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. */
|
|
33274
33829
|
feature?: storefrontComponents["schemas"]["KlarnaFeature"] | null;
|
|
33275
33830
|
filters?: storefrontComponents["schemas"]["ReadyToPayMethodFilters"];
|
|
33276
33831
|
};
|
|
33277
|
-
ReadyToPayMethods: (Partial<
|
|
33278
|
-
storefrontComponents["schemas"]["ReadyToPayPaymentCardMethod"]
|
|
33279
|
-
> &
|
|
33280
|
-
Partial<storefrontComponents["schemas"]["ReadyToPayAchMethod"]> &
|
|
33281
|
-
Partial<storefrontComponents["schemas"]["ReadyToPayGenericMethod"]> &
|
|
33282
|
-
Partial<storefrontComponents["schemas"]["ReadyToPayPayPalMethod"]> &
|
|
33283
|
-
Partial<storefrontComponents["schemas"]["ReadyToPayKlarnaMethod"]>)[];
|
|
33284
33832
|
/** Plan without changes. */
|
|
33285
33833
|
OriginalPlan: {
|
|
33286
33834
|
/** The ID of plan to use. */
|
|
33287
33835
|
id: storefrontComponents["schemas"]["ResourceId"];
|
|
33288
33836
|
};
|
|
33289
|
-
FlexiblePlan: storefrontComponents["schemas"]["
|
|
33837
|
+
FlexiblePlan: storefrontComponents["schemas"]["Plan"] & {
|
|
33290
33838
|
/** ID of a plan you wish to modify. */
|
|
33291
|
-
id
|
|
33292
|
-
/** Specifies whether a plan is active. */
|
|
33293
|
-
isActive?: boolean;
|
|
33294
|
-
/**
|
|
33295
|
-
* Use invoice time shift to adjust the invoice issue and due date
|
|
33296
|
-
* when billing must occur before the service period changes.
|
|
33297
|
-
* For example, rent must be paid in advance, so the invoice must
|
|
33298
|
-
* be in advance of the billing date. For more information, see
|
|
33299
|
-
* [Service period anchor, and billing timing, and invoice time shift](https://www.rebilly.com/docs/dev-docs/concepts/#service-period-anchor-and-billing-timing-and-invoice-time-shift).
|
|
33300
|
-
*/
|
|
33301
|
-
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"] | null;
|
|
33302
|
-
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
33303
|
-
description?: string;
|
|
33304
|
-
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
33305
|
-
richDescription?: string;
|
|
33306
|
-
/** Related resource links. */
|
|
33307
|
-
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
33839
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33308
33840
|
};
|
|
33309
33841
|
OrderItem: {
|
|
33310
33842
|
/** The plan identifier string. */
|
|
@@ -34149,11 +34681,17 @@ export interface storefrontComponents {
|
|
|
34149
34681
|
};
|
|
34150
34682
|
};
|
|
34151
34683
|
headers: {
|
|
34152
|
-
/** Total items
|
|
34684
|
+
/** Total number of items. */
|
|
34153
34685
|
"Pagination-Total"?: number;
|
|
34154
|
-
/**
|
|
34686
|
+
/** Maximum number of items per page. */
|
|
34155
34687
|
"Pagination-Limit"?: number;
|
|
34156
|
-
/**
|
|
34688
|
+
/**
|
|
34689
|
+
* Specifies the starting point within the
|
|
34690
|
+
* collection of resource results. For example, a request with
|
|
34691
|
+
* `limit=20` retrieves and displays the first 20 results on a page. A
|
|
34692
|
+
* following request with `limit=20` and `offset=20`, retrieves the next
|
|
34693
|
+
* page of 20 results.
|
|
34694
|
+
*/
|
|
34157
34695
|
"Pagination-Offset"?: number;
|
|
34158
34696
|
/** The location of the related resource. */
|
|
34159
34697
|
Location?: string;
|
|
@@ -34368,6 +34906,14 @@ export interface operations {
|
|
|
34368
34906
|
/** The resource identifier string. */
|
|
34369
34907
|
id: storefrontComponents["parameters"]["resourceId"];
|
|
34370
34908
|
};
|
|
34909
|
+
query: {
|
|
34910
|
+
/**
|
|
34911
|
+
* Expand a response to get a full related object included inside of the `_embedded` path in the response.
|
|
34912
|
+
* It accepts a comma-separated list of objects to expand.
|
|
34913
|
+
* See the [expand guide](https://api-reference.rebilly.com/#section/Expand-to-include-embedded-objects) for more info.
|
|
34914
|
+
*/
|
|
34915
|
+
expand?: storefrontComponents["parameters"]["collectionExpand"];
|
|
34916
|
+
};
|
|
34371
34917
|
};
|
|
34372
34918
|
responses: {
|
|
34373
34919
|
/** Invoice was retrieved successfuly. */
|
|
@@ -35258,7 +35804,7 @@ export interface reportsPaths {
|
|
|
35258
35804
|
get: operations["GetRevenueAuditReport"];
|
|
35259
35805
|
};
|
|
35260
35806
|
"/reports/subscription-cancellation": {
|
|
35261
|
-
/** Retrieve
|
|
35807
|
+
/** Retrieve a subscription cancellation report. */
|
|
35262
35808
|
get: operations["GetSubscriptionCancellationReport"];
|
|
35263
35809
|
};
|
|
35264
35810
|
"/reports/subscription-renewal": {
|
|
@@ -35270,7 +35816,7 @@ export interface reportsPaths {
|
|
|
35270
35816
|
get: operations["GetTimeSeriesTransactionReport"];
|
|
35271
35817
|
};
|
|
35272
35818
|
"/reports/transactions-time-dispute": {
|
|
35273
|
-
/** Retrieve a dispute delays in days report, how much time between a
|
|
35819
|
+
/** Retrieve a dispute delays in days report, how much time between a transaction and a dispute. */
|
|
35274
35820
|
get: operations["GetTransactionTimeDisputeReport"];
|
|
35275
35821
|
};
|
|
35276
35822
|
"/reports/transactions": {
|
|
@@ -35291,11 +35837,14 @@ export interface reportsPaths {
|
|
|
35291
35837
|
|
|
35292
35838
|
export interface reportsComponents {
|
|
35293
35839
|
schemas: {
|
|
35294
|
-
/**
|
|
35840
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
35295
35841
|
ResourceId: string;
|
|
35296
|
-
/** Read-only timestamp
|
|
35842
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
35297
35843
|
ServerTimestamp: string;
|
|
35298
|
-
/**
|
|
35844
|
+
/**
|
|
35845
|
+
* Read-only timestamp. This value updates when the resource
|
|
35846
|
+
* is updated.
|
|
35847
|
+
*/
|
|
35299
35848
|
UpdatedTime: string;
|
|
35300
35849
|
Link: {
|
|
35301
35850
|
/** The link URL. */
|
|
@@ -35334,7 +35883,7 @@ export interface reportsComponents {
|
|
|
35334
35883
|
/** The HTTP status code. */
|
|
35335
35884
|
status?: number;
|
|
35336
35885
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
35337
|
-
/** ISO 4217
|
|
35886
|
+
/** ISO 4217 currency code. */
|
|
35338
35887
|
CurrencyCode: string;
|
|
35339
35888
|
KycDocumentTypes:
|
|
35340
35889
|
| "identity-proof"
|
|
@@ -35926,6 +36475,7 @@ export interface reportsComponents {
|
|
|
35926
36475
|
planId?: reportsComponents["schemas"]["ResourceId"] | null;
|
|
35927
36476
|
/** The product accounting code. */
|
|
35928
36477
|
accountingCode?: string;
|
|
36478
|
+
currency?: reportsComponents["schemas"]["CurrencyCode"];
|
|
35929
36479
|
/** The entry's recognition status. */
|
|
35930
36480
|
status?: "scheduled" | "recognized";
|
|
35931
36481
|
/** Estimated amount which will be recognized unless it is changed before recognition time. */
|
|
@@ -35934,6 +36484,8 @@ export interface reportsComponents {
|
|
|
35934
36484
|
recognizedAmount?: number;
|
|
35935
36485
|
/** Date and time at which the entry was created. */
|
|
35936
36486
|
scheduledTime?: reportsComponents["schemas"]["ServerTimestamp"];
|
|
36487
|
+
/** Date and time at which the related invoice was issued. */
|
|
36488
|
+
issuedTime?: reportsComponents["schemas"]["ServerTimestamp"];
|
|
35937
36489
|
/** Date and time at which the entry was recognized. */
|
|
35938
36490
|
recognizedTime?: reportsComponents["schemas"]["ServerTimestamp"] | null;
|
|
35939
36491
|
};
|
|
@@ -36109,11 +36661,17 @@ export interface reportsComponents {
|
|
|
36109
36661
|
};
|
|
36110
36662
|
};
|
|
36111
36663
|
headers: {
|
|
36112
|
-
/** Total items
|
|
36664
|
+
/** Total number of items. */
|
|
36113
36665
|
"Pagination-Total"?: number;
|
|
36114
|
-
/**
|
|
36666
|
+
/** Maximum number of items per page. */
|
|
36115
36667
|
"Pagination-Limit"?: number;
|
|
36116
|
-
/**
|
|
36668
|
+
/**
|
|
36669
|
+
* Specifies the starting point within the
|
|
36670
|
+
* collection of resource results. For example, a request with
|
|
36671
|
+
* `limit=20` retrieves and displays the first 20 results on a page. A
|
|
36672
|
+
* following request with `limit=20` and `offset=20`, retrieves the next
|
|
36673
|
+
* page of 20 results.
|
|
36674
|
+
*/
|
|
36117
36675
|
"Pagination-Offset"?: number;
|
|
36118
36676
|
/** The location of the related resource. */
|
|
36119
36677
|
Location?: string;
|
|
@@ -36316,14 +36874,20 @@ export interface operations {
|
|
|
36316
36874
|
aggregationPeriod: "hour" | "day" | "month";
|
|
36317
36875
|
/** Report metric. */
|
|
36318
36876
|
metric:
|
|
36319
|
-
| "
|
|
36320
|
-
| "
|
|
36321
|
-
| "
|
|
36322
|
-
| "
|
|
36323
|
-
| "
|
|
36324
|
-
| "
|
|
36325
|
-
| "
|
|
36326
|
-
| "
|
|
36877
|
+
| "approval"
|
|
36878
|
+
| "auth_approval"
|
|
36879
|
+
| "avg_sales"
|
|
36880
|
+
| "refunds"
|
|
36881
|
+
| "refunds_count"
|
|
36882
|
+
| "sales"
|
|
36883
|
+
| "sales_count"
|
|
36884
|
+
| "all_sales_count"
|
|
36885
|
+
| "auth_approval_count"
|
|
36886
|
+
| "disputes_count"
|
|
36887
|
+
| "disputes_rate"
|
|
36888
|
+
| "credits"
|
|
36889
|
+
| "credits_count"
|
|
36890
|
+
| "unapproved_count";
|
|
36327
36891
|
/**
|
|
36328
36892
|
* The collection items filter requires a special format.
|
|
36329
36893
|
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
@@ -36568,7 +37132,7 @@ export interface operations {
|
|
|
36568
37132
|
query: {
|
|
36569
37133
|
/** Report start date. It should be in the future. */
|
|
36570
37134
|
periodStart: string;
|
|
36571
|
-
/** Report end date. */
|
|
37135
|
+
/** Report end date. It should be in the future. */
|
|
36572
37136
|
periodEnd: string;
|
|
36573
37137
|
/** The collection items limit. */
|
|
36574
37138
|
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
@@ -36967,7 +37531,7 @@ export interface operations {
|
|
|
36967
37531
|
403: reportsComponents["responses"]["Forbidden"];
|
|
36968
37532
|
};
|
|
36969
37533
|
};
|
|
36970
|
-
/** Retrieve
|
|
37534
|
+
/** Retrieve a subscription cancellation report. */
|
|
36971
37535
|
GetSubscriptionCancellationReport: {
|
|
36972
37536
|
parameters: {
|
|
36973
37537
|
query: {
|
|
@@ -37077,7 +37641,7 @@ export interface operations {
|
|
|
37077
37641
|
403: reportsComponents["responses"]["Forbidden"];
|
|
37078
37642
|
};
|
|
37079
37643
|
};
|
|
37080
|
-
/** Retrieve a dispute delays in days report, how much time between a
|
|
37644
|
+
/** Retrieve a dispute delays in days report, how much time between a transaction and a dispute. */
|
|
37081
37645
|
GetTransactionTimeDisputeReport: {
|
|
37082
37646
|
parameters: {
|
|
37083
37647
|
query: {
|
|
@@ -37472,7 +38036,7 @@ declare module "resources/applications-resource" {
|
|
|
37472
38036
|
get({ id }: {
|
|
37473
38037
|
id: any;
|
|
37474
38038
|
}): rebilly.GetApplicationResponsePromise;
|
|
37475
|
-
getInstances({ id }: rebilly.GetApplicationInstanceCollectionRequest): rebilly.GetApplicationInstanceCollectionResponsePromise;
|
|
38039
|
+
getInstances({ id, limit, offset }: rebilly.GetApplicationInstanceCollectionRequest): rebilly.GetApplicationInstanceCollectionResponsePromise;
|
|
37476
38040
|
getInstance({ id, organizationId }: {
|
|
37477
38041
|
id: any;
|
|
37478
38042
|
organizationId: any;
|
|
@@ -37879,8 +38443,10 @@ declare module "resources/customers-resource" {
|
|
|
37879
38443
|
id: any;
|
|
37880
38444
|
data: any;
|
|
37881
38445
|
}): any;
|
|
37882
|
-
getAllEddSearchResults({ id }: {
|
|
38446
|
+
getAllEddSearchResults({ id, limit, offset }: {
|
|
37883
38447
|
id: any;
|
|
38448
|
+
limit?: any;
|
|
38449
|
+
offset?: any;
|
|
37884
38450
|
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
37885
38451
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
37886
38452
|
limit?: any;
|
|
@@ -37980,7 +38546,7 @@ declare module "resources/email-notifications-resource" {
|
|
|
37980
38546
|
export default function EmailNotificationsResource({ apiHandler }: {
|
|
37981
38547
|
apiHandler: any;
|
|
37982
38548
|
}): {
|
|
37983
|
-
getAll(): rebilly.GetEmailNotificationCollectionResponsePromise;
|
|
38549
|
+
getAll({ limit, offset }?: rebilly.GetEmailNotificationCollectionRequest): rebilly.GetEmailNotificationCollectionResponsePromise;
|
|
37984
38550
|
};
|
|
37985
38551
|
}
|
|
37986
38552
|
declare module "resources/events-resource" {
|
|
@@ -38147,7 +38713,7 @@ declare module "resources/files-resource" {
|
|
|
38147
38713
|
name?: string;
|
|
38148
38714
|
extension?: string;
|
|
38149
38715
|
description?: string;
|
|
38150
|
-
sourceType?: "camera" | "upload";
|
|
38716
|
+
sourceType?: "camera" | "upload" | "organization-export" | "organization-closure-export";
|
|
38151
38717
|
tags?: string[];
|
|
38152
38718
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
38153
38719
|
size?: number;
|
|
@@ -38278,7 +38844,7 @@ declare module "resources/integrations-resource" {
|
|
|
38278
38844
|
export default function IntegrationsResource({ apiHandler }: {
|
|
38279
38845
|
apiHandler: any;
|
|
38280
38846
|
}): {
|
|
38281
|
-
getAll(): rebilly.GetIntegrationCollectionResponsePromise;
|
|
38847
|
+
getAll({ limit, offset }?: rebilly.GetIntegrationCollectionRequest): rebilly.GetIntegrationCollectionResponsePromise;
|
|
38282
38848
|
get({ label }: {
|
|
38283
38849
|
label: any;
|
|
38284
38850
|
}): rebilly.GetIntegrationResponsePromise;
|
|
@@ -38549,7 +39115,7 @@ declare module "resources/payment-methods-resource" {
|
|
|
38549
39115
|
export default function PaymentMethodsResource({ apiHandler }: {
|
|
38550
39116
|
apiHandler: any;
|
|
38551
39117
|
}): {
|
|
38552
|
-
getAll(): rebilly.GetPaymentMethodCollectionResponsePromise;
|
|
39118
|
+
getAll({ limit, offset }?: rebilly.GetPaymentMethodCollectionRequest): rebilly.GetPaymentMethodCollectionResponsePromise;
|
|
38553
39119
|
get({ apiName }: {
|
|
38554
39120
|
apiName: any;
|
|
38555
39121
|
}): rebilly.GetPaymentMethodResponsePromise;
|
|
@@ -39126,7 +39692,7 @@ declare module "resources/api-instance" {
|
|
|
39126
39692
|
get({ id }: {
|
|
39127
39693
|
id: any;
|
|
39128
39694
|
}): rebilly.GetApplicationResponsePromise;
|
|
39129
|
-
getInstances({ id }: rebilly.GetApplicationInstanceCollectionRequest): rebilly.GetApplicationInstanceCollectionResponsePromise;
|
|
39695
|
+
getInstances({ id, limit, offset }: rebilly.GetApplicationInstanceCollectionRequest): rebilly.GetApplicationInstanceCollectionResponsePromise;
|
|
39130
39696
|
getInstance({ id, organizationId }: {
|
|
39131
39697
|
id: any;
|
|
39132
39698
|
organizationId: any;
|
|
@@ -39577,8 +40143,10 @@ declare module "resources/api-instance" {
|
|
|
39577
40143
|
id: any;
|
|
39578
40144
|
data: any;
|
|
39579
40145
|
}): any;
|
|
39580
|
-
getAllEddSearchResults({ id }: {
|
|
40146
|
+
getAllEddSearchResults({ id, limit, offset }: {
|
|
39581
40147
|
id: any;
|
|
40148
|
+
limit?: any;
|
|
40149
|
+
offset?: any;
|
|
39582
40150
|
}): rebilly.GetEddSearchResultsResponsePromise;
|
|
39583
40151
|
downloadCSV({ limit, offset, sort, expand, filter, q, }?: {
|
|
39584
40152
|
limit?: any;
|
|
@@ -39677,7 +40245,10 @@ declare module "resources/api-instance" {
|
|
|
39677
40245
|
}): any;
|
|
39678
40246
|
};
|
|
39679
40247
|
emailNotifications: {
|
|
39680
|
-
getAll(
|
|
40248
|
+
getAll({ limit, offset }?: {
|
|
40249
|
+
limit?: number;
|
|
40250
|
+
offset?: number;
|
|
40251
|
+
}): rebilly.GetEmailNotificationCollectionResponsePromise;
|
|
39681
40252
|
};
|
|
39682
40253
|
events: {
|
|
39683
40254
|
getAll(): rebilly.GetEventCollectionResponsePromise;
|
|
@@ -39851,7 +40422,7 @@ declare module "resources/api-instance" {
|
|
|
39851
40422
|
name?: string;
|
|
39852
40423
|
extension?: string;
|
|
39853
40424
|
description?: string;
|
|
39854
|
-
sourceType?: "camera" | "upload";
|
|
40425
|
+
sourceType?: "camera" | "upload" | "organization-export" | "organization-closure-export";
|
|
39855
40426
|
tags?: string[];
|
|
39856
40427
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
39857
40428
|
size?: number;
|
|
@@ -39981,7 +40552,10 @@ declare module "resources/api-instance" {
|
|
|
39981
40552
|
}): rebilly.PutGatewayAccountFinancialSettingsResponsePromise;
|
|
39982
40553
|
};
|
|
39983
40554
|
integrations: {
|
|
39984
|
-
getAll(
|
|
40555
|
+
getAll({ limit, offset }?: {
|
|
40556
|
+
limit?: number;
|
|
40557
|
+
offset?: number;
|
|
40558
|
+
}): rebilly.GetIntegrationCollectionResponsePromise;
|
|
39985
40559
|
get({ label }: {
|
|
39986
40560
|
label: any;
|
|
39987
40561
|
}): rebilly.GetIntegrationResponsePromise;
|
|
@@ -40259,7 +40833,10 @@ declare module "resources/api-instance" {
|
|
|
40259
40833
|
}): any;
|
|
40260
40834
|
};
|
|
40261
40835
|
paymentMethods: {
|
|
40262
|
-
getAll(
|
|
40836
|
+
getAll({ limit, offset }?: {
|
|
40837
|
+
limit?: number;
|
|
40838
|
+
offset?: number;
|
|
40839
|
+
}): rebilly.GetPaymentMethodCollectionResponsePromise;
|
|
40263
40840
|
get({ apiName }: {
|
|
40264
40841
|
apiName: any;
|
|
40265
40842
|
}): rebilly.GetPaymentMethodResponsePromise;
|
|
@@ -41341,8 +41918,9 @@ declare module "resources/storefront/invoices-resource" {
|
|
|
41341
41918
|
apiHandler: any;
|
|
41342
41919
|
}): {
|
|
41343
41920
|
getAll({ filter, sort, limit, offset, q, }?: rebilly.StorefrontGetInvoiceCollectionRequest): rebilly.StorefrontGetInvoiceCollectionResponsePromise;
|
|
41344
|
-
get({ id }: {
|
|
41921
|
+
get({ id, expand }: {
|
|
41345
41922
|
id: any;
|
|
41923
|
+
expand?: any;
|
|
41346
41924
|
}): rebilly.StorefrontGetInvoiceResponsePromise;
|
|
41347
41925
|
downloadPDF({ id }: {
|
|
41348
41926
|
id: any;
|
|
@@ -41539,8 +42117,9 @@ declare module "resources/storefront/storefront-api-instance" {
|
|
|
41539
42117
|
offset?: number;
|
|
41540
42118
|
q?: string;
|
|
41541
42119
|
}): rebilly.StorefrontGetInvoiceCollectionResponsePromise;
|
|
41542
|
-
get({ id }: {
|
|
42120
|
+
get({ id, expand }: {
|
|
41543
42121
|
id: any;
|
|
42122
|
+
expand?: any;
|
|
41544
42123
|
}): rebilly.StorefrontGetInvoiceResponsePromise;
|
|
41545
42124
|
downloadPDF({ id }: {
|
|
41546
42125
|
id: any;
|