rebilly-js-sdk 47.14.0 → 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 +963 -474
- package/dist/rebilly-js-sdk.es.js +393 -1443
- 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']
|
|
@@ -1996,8 +1996,11 @@ declare module rebilly {
|
|
|
1996
1996
|
export interface corePaths {
|
|
1997
1997
|
"/aml": {
|
|
1998
1998
|
/**
|
|
1999
|
-
*
|
|
2000
|
-
*
|
|
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.
|
|
2001
2004
|
*/
|
|
2002
2005
|
get: operations["GetAmlEntry"];
|
|
2003
2006
|
};
|
|
@@ -2234,8 +2237,11 @@ export interface corePaths {
|
|
|
2234
2237
|
};
|
|
2235
2238
|
"/customers/{id}/aml": {
|
|
2236
2239
|
/**
|
|
2237
|
-
*
|
|
2238
|
-
*
|
|
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.
|
|
2239
2245
|
*/
|
|
2240
2246
|
get: operations["GetCustomerAmlEntryCollection"];
|
|
2241
2247
|
parameters: {
|
|
@@ -2576,7 +2582,7 @@ export interface corePaths {
|
|
|
2576
2582
|
};
|
|
2577
2583
|
};
|
|
2578
2584
|
"/invoices/{id}/credit-memo-allocations/{creditMemoId}": {
|
|
2579
|
-
/**
|
|
2585
|
+
/** Retrieves the credit amount allocated to the given invoice from a specific credit memo. */
|
|
2580
2586
|
get: operations["GetInvoiceCreditMemoAllocation"];
|
|
2581
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). */
|
|
2582
2588
|
put: operations["PutInvoiceCreditMemoAllocation"];
|
|
@@ -3317,50 +3323,59 @@ export interface corePaths {
|
|
|
3317
3323
|
|
|
3318
3324
|
export interface coreComponents {
|
|
3319
3325
|
schemas: {
|
|
3320
|
-
/**
|
|
3326
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
3321
3327
|
Country: string;
|
|
3322
3328
|
SelfLink: {
|
|
3323
|
-
/**
|
|
3329
|
+
/** Type of link. */
|
|
3324
3330
|
rel: "self";
|
|
3325
|
-
/**
|
|
3331
|
+
/** Link URL. */
|
|
3326
3332
|
href: string;
|
|
3327
3333
|
};
|
|
3328
3334
|
AML: {
|
|
3329
|
-
/** First
|
|
3335
|
+
/** First name of the individual, or name of entity. */
|
|
3330
3336
|
firstName?: string;
|
|
3331
|
-
/**
|
|
3337
|
+
/**
|
|
3338
|
+
* Last name of the individual. Returns a
|
|
3339
|
+
* `null` value for single-named entities.
|
|
3340
|
+
*/
|
|
3332
3341
|
lastName?: string | null;
|
|
3333
|
-
/**
|
|
3342
|
+
/** Describes which list the result is from. */
|
|
3334
3343
|
source?: string;
|
|
3335
|
-
/**
|
|
3344
|
+
/** Describes the type of list the result is from. */
|
|
3336
3345
|
sourceType?: "pep" | "sanctions" | "adverse-media";
|
|
3337
|
-
/**
|
|
3346
|
+
/**
|
|
3347
|
+
* If `type`=`individual`, this field describes the gender of the
|
|
3348
|
+
* individual.
|
|
3349
|
+
*/
|
|
3338
3350
|
gender?: string | null;
|
|
3339
|
-
/** The
|
|
3351
|
+
/** The individual's job title. */
|
|
3340
3352
|
title?: string[] | null;
|
|
3341
|
-
/**
|
|
3353
|
+
/** Describes whether the source is an individual or an entity. */
|
|
3342
3354
|
type?: "individual" | "entity";
|
|
3343
|
-
/** List of references to legal documents if they exist. */
|
|
3355
|
+
/** List of references to legal documents, if they exist. */
|
|
3344
3356
|
legalBasis?: string[];
|
|
3345
|
-
/**
|
|
3357
|
+
/**
|
|
3358
|
+
* Describes the government, administration, or political
|
|
3359
|
+
* entity.
|
|
3360
|
+
*/
|
|
3346
3361
|
regime?: string | null;
|
|
3347
|
-
/**
|
|
3362
|
+
/** Degree of confidence in the source list information. */
|
|
3348
3363
|
confidence?: "weak" | "medium" | "strong" | "very-strong";
|
|
3349
|
-
/**
|
|
3364
|
+
/** Nationality of the individual or entity. */
|
|
3350
3365
|
nationality?: string;
|
|
3351
|
-
/** Addresses
|
|
3366
|
+
/** Addresses associated with the individual or entity. */
|
|
3352
3367
|
address?: {
|
|
3353
|
-
/** Street
|
|
3368
|
+
/** Street address line 1. */
|
|
3354
3369
|
address?: string | null;
|
|
3355
|
-
/** Street
|
|
3370
|
+
/** Street address line 2. */
|
|
3356
3371
|
address2?: string | null;
|
|
3357
3372
|
/** City. */
|
|
3358
3373
|
city?: string | null;
|
|
3359
|
-
/** State
|
|
3374
|
+
/** State, province, or region. */
|
|
3360
3375
|
region?: string | null;
|
|
3361
3376
|
/** Country. */
|
|
3362
3377
|
country?: string | null;
|
|
3363
|
-
/**
|
|
3378
|
+
/** Individual's place of birth. */
|
|
3364
3379
|
birthplace: boolean;
|
|
3365
3380
|
}[];
|
|
3366
3381
|
/** One or more possible dates of birth. */
|
|
@@ -3371,26 +3386,29 @@ export interface coreComponents {
|
|
|
3371
3386
|
firstName?: string;
|
|
3372
3387
|
/** Last name of alias. */
|
|
3373
3388
|
lastName?: string;
|
|
3374
|
-
/**
|
|
3389
|
+
/** Degree of confidence in the alias. */
|
|
3375
3390
|
authenticity?: "strong" | "weak" | "unknown";
|
|
3376
3391
|
}[];
|
|
3377
|
-
/**
|
|
3392
|
+
/** Individual's passport information. */
|
|
3378
3393
|
passport?: {
|
|
3379
3394
|
/** Passport number. */
|
|
3380
3395
|
number?: string;
|
|
3381
3396
|
/** Passport registration date. */
|
|
3382
3397
|
registrationDate?: string;
|
|
3383
3398
|
}[];
|
|
3384
|
-
/**
|
|
3399
|
+
/** Additional information. This content varies per list. */
|
|
3385
3400
|
comments?: string | null;
|
|
3386
|
-
/**
|
|
3401
|
+
/** Related resource links. */
|
|
3387
3402
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3388
3403
|
};
|
|
3389
|
-
/**
|
|
3404
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
3390
3405
|
ResourceId: string;
|
|
3391
|
-
/** Read-only timestamp
|
|
3406
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
3392
3407
|
ServerTimestamp: string;
|
|
3393
|
-
/**
|
|
3408
|
+
/**
|
|
3409
|
+
* Read-only timestamp. This value updates when the resource
|
|
3410
|
+
* is updated.
|
|
3411
|
+
*/
|
|
3394
3412
|
UpdatedTime: string;
|
|
3395
3413
|
Link: {
|
|
3396
3414
|
/** The link URL. */
|
|
@@ -3433,7 +3451,14 @@ export interface coreComponents {
|
|
|
3433
3451
|
/** The File description. */
|
|
3434
3452
|
description?: string;
|
|
3435
3453
|
/** The File source type. */
|
|
3436
|
-
sourceType?:
|
|
3454
|
+
sourceType?:
|
|
3455
|
+
| (
|
|
3456
|
+
| "upload"
|
|
3457
|
+
| "camera"
|
|
3458
|
+
| "organization-export"
|
|
3459
|
+
| "organization-closure-export"
|
|
3460
|
+
)
|
|
3461
|
+
| null;
|
|
3437
3462
|
/** The tags list. */
|
|
3438
3463
|
tags?: string[];
|
|
3439
3464
|
/** The mime type. */
|
|
@@ -3552,7 +3577,7 @@ export interface coreComponents {
|
|
|
3552
3577
|
/** Should OTP be required to exchange token. */
|
|
3553
3578
|
otpRequired?: boolean;
|
|
3554
3579
|
};
|
|
3555
|
-
/**
|
|
3580
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
3556
3581
|
CustomerId: string;
|
|
3557
3582
|
CommonAuthenticationToken: {
|
|
3558
3583
|
/** Authentication token identifier string. */
|
|
@@ -3581,7 +3606,7 @@ export interface coreComponents {
|
|
|
3581
3606
|
* token, requires a secret API key to log in. To obtain an API key, see
|
|
3582
3607
|
* [Manage API keys](https://www.rebilly.com/docs/dev-docs/api-keys/#manage-api-keys).
|
|
3583
3608
|
*/
|
|
3584
|
-
mode:
|
|
3609
|
+
mode: string;
|
|
3585
3610
|
};
|
|
3586
3611
|
password: coreComponents["schemas"]["AuthenticationToken"] &
|
|
3587
3612
|
coreComponents["schemas"]["AuthenticationTokenMetadata"] &
|
|
@@ -3617,7 +3642,7 @@ export interface coreComponents {
|
|
|
3617
3642
|
permissions: coreComponents["schemas"]["AclPermissions"];
|
|
3618
3643
|
}[];
|
|
3619
3644
|
CustomerLink: coreComponents["schemas"]["Link"] & {
|
|
3620
|
-
/**
|
|
3645
|
+
/** Type of link. */
|
|
3621
3646
|
rel: "customer" | "targetCustomer";
|
|
3622
3647
|
};
|
|
3623
3648
|
CustomerJWT: {
|
|
@@ -3700,7 +3725,7 @@ export interface coreComponents {
|
|
|
3700
3725
|
| "restrict-to-products"
|
|
3701
3726
|
| "paid-by-time";
|
|
3702
3727
|
};
|
|
3703
|
-
/** ISO 4217
|
|
3728
|
+
/** ISO 4217 currency code. */
|
|
3704
3729
|
CurrencyCode: string;
|
|
3705
3730
|
/** minimum-order-amount restrictions. */
|
|
3706
3731
|
"minimum-order-amount": coreComponents["schemas"]["CouponRestriction"] &
|
|
@@ -3902,7 +3927,7 @@ export interface coreComponents {
|
|
|
3902
3927
|
/** The links related to resource. */
|
|
3903
3928
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
3904
3929
|
};
|
|
3905
|
-
/**
|
|
3930
|
+
/** Payment method. */
|
|
3906
3931
|
PaymentMethod:
|
|
3907
3932
|
| "payment-card"
|
|
3908
3933
|
| "ach"
|
|
@@ -3941,6 +3966,7 @@ export interface coreComponents {
|
|
|
3941
3966
|
| "CashToCode"
|
|
3942
3967
|
| "CCAvenue"
|
|
3943
3968
|
| "China UnionPay"
|
|
3969
|
+
| "Cleo"
|
|
3944
3970
|
| "CODVoucher"
|
|
3945
3971
|
| "Conekta-oxxo"
|
|
3946
3972
|
| "Conekta-spei"
|
|
@@ -4073,8 +4099,8 @@ export interface coreComponents {
|
|
|
4073
4099
|
/** Vaulted payment instrument. */
|
|
4074
4100
|
VaultedInstrument: {
|
|
4075
4101
|
/**
|
|
4076
|
-
*
|
|
4077
|
-
*
|
|
4102
|
+
* Payment method supported vault. For more information, see
|
|
4103
|
+
* [Payment Instrument](https://api-reference.rebilly.com/tag/Payment-Instruments).
|
|
4078
4104
|
*/
|
|
4079
4105
|
method: "payment-card" | "ach" | "paypal";
|
|
4080
4106
|
/** The payment instrument identifier. */
|
|
@@ -4083,13 +4109,13 @@ export interface coreComponents {
|
|
|
4083
4109
|
/** Alternative payment method instrument. */
|
|
4084
4110
|
AlternativePaymentInstrument: {
|
|
4085
4111
|
method: coreComponents["schemas"]["PaymentMethod"];
|
|
4086
|
-
/**
|
|
4112
|
+
/** Payment instrument ID. */
|
|
4087
4113
|
paymentInstrumentId?: coreComponents["schemas"]["ResourceId"];
|
|
4088
4114
|
};
|
|
4089
4115
|
/** Cash payment instrument object. */
|
|
4090
4116
|
CashInstrument: {
|
|
4091
4117
|
method: "cash";
|
|
4092
|
-
/**
|
|
4118
|
+
/** Individual or entity that received the payment. */
|
|
4093
4119
|
receivedBy?: string;
|
|
4094
4120
|
};
|
|
4095
4121
|
/** Check payment instrument object. */
|
|
@@ -4104,58 +4130,78 @@ export interface coreComponents {
|
|
|
4104
4130
|
Partial<coreComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
4105
4131
|
Partial<coreComponents["schemas"]["CashInstrument"]> &
|
|
4106
4132
|
Partial<coreComponents["schemas"]["CheckInstrument"]>;
|
|
4107
|
-
/**
|
|
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
|
+
*/
|
|
4108
4138
|
ResourceCustomFields: { [key: string]: any };
|
|
4109
|
-
/**
|
|
4139
|
+
/** List of phone numbers associated with the contact. */
|
|
4110
4140
|
ContactPhoneNumbers: {
|
|
4111
|
-
/**
|
|
4141
|
+
/** Phone number label or name. */
|
|
4112
4142
|
label: string;
|
|
4113
|
-
/**
|
|
4143
|
+
/** Phone number value. */
|
|
4114
4144
|
value: string;
|
|
4115
|
-
/**
|
|
4145
|
+
/**
|
|
4146
|
+
* Specifies whether the phone number is the contact's
|
|
4147
|
+
* primary phone number.
|
|
4148
|
+
*/
|
|
4116
4149
|
primary?: boolean;
|
|
4117
4150
|
}[];
|
|
4118
|
-
/**
|
|
4151
|
+
/** List of email addresses associated with the contact. */
|
|
4119
4152
|
ContactEmails: {
|
|
4120
|
-
/**
|
|
4153
|
+
/** Email label or name. */
|
|
4121
4154
|
label: string;
|
|
4122
|
-
/**
|
|
4155
|
+
/** Email address value. */
|
|
4123
4156
|
value: string;
|
|
4124
|
-
/**
|
|
4157
|
+
/**
|
|
4158
|
+
* Specifies whether the email address is the contact's
|
|
4159
|
+
* primary email address.
|
|
4160
|
+
*/
|
|
4125
4161
|
primary?: boolean;
|
|
4126
4162
|
}[];
|
|
4127
4163
|
ContactObject: {
|
|
4128
|
-
/**
|
|
4164
|
+
/** Contact's first name. */
|
|
4129
4165
|
firstName?: string | null;
|
|
4130
|
-
/**
|
|
4166
|
+
/** Contact's last name. */
|
|
4131
4167
|
lastName?: string | null;
|
|
4132
|
-
/** The contact organization. */
|
|
4168
|
+
/** The contact's organization. */
|
|
4133
4169
|
organization?: string | null;
|
|
4134
|
-
/**
|
|
4170
|
+
/** First line of the contact's street address. */
|
|
4135
4171
|
address?: string | null;
|
|
4136
|
-
/**
|
|
4172
|
+
/** Second line of the contact's street address. */
|
|
4137
4173
|
address2?: string | null;
|
|
4138
|
-
/**
|
|
4174
|
+
/** Contact's city of residence. */
|
|
4139
4175
|
city?: string | null;
|
|
4140
|
-
/**
|
|
4176
|
+
/** Contact's region of residence. */
|
|
4141
4177
|
region?: string | null;
|
|
4142
|
-
/**
|
|
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
|
+
*/
|
|
4143
4183
|
country?: string | null;
|
|
4144
|
-
/**
|
|
4184
|
+
/** Contact's postal code. */
|
|
4145
4185
|
postalCode?: string | null;
|
|
4146
4186
|
phoneNumbers?: coreComponents["schemas"]["ContactPhoneNumbers"];
|
|
4147
4187
|
emails?: coreComponents["schemas"]["ContactEmails"];
|
|
4148
|
-
/**
|
|
4188
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
4149
4189
|
dob?: string | null;
|
|
4150
4190
|
/** The contact's job title. */
|
|
4151
4191
|
jobTitle?: string | null;
|
|
4152
|
-
/**
|
|
4192
|
+
/**
|
|
4193
|
+
* Use this value to compare contacts for identical
|
|
4194
|
+
* attribute values.
|
|
4195
|
+
*/
|
|
4153
4196
|
hash?: string;
|
|
4154
4197
|
};
|
|
4155
4198
|
CustomerAverageValue: {
|
|
4156
4199
|
/** Merchant's reporting currency. */
|
|
4157
4200
|
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
4158
|
-
/**
|
|
4201
|
+
/**
|
|
4202
|
+
* Average approved payment amount in merchant's
|
|
4203
|
+
* reporting currency.
|
|
4204
|
+
*/
|
|
4159
4205
|
amount?: number;
|
|
4160
4206
|
/** Average approved payment amount in USD. */
|
|
4161
4207
|
amountUsd?: number;
|
|
@@ -4163,123 +4209,181 @@ export interface coreComponents {
|
|
|
4163
4209
|
CustomerLifetimeRevenue: {
|
|
4164
4210
|
/** Merchant's reporting currency. */
|
|
4165
4211
|
currency?: coreComponents["schemas"]["CurrencyCode"];
|
|
4166
|
-
/** Revenue amount in
|
|
4212
|
+
/** Revenue amount in the merchant's reporting currency. */
|
|
4167
4213
|
amount?: number;
|
|
4168
4214
|
/** Revenue amount in USD. */
|
|
4169
4215
|
amountUsd?: number;
|
|
4170
4216
|
};
|
|
4171
|
-
/**
|
|
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
|
+
*/
|
|
4172
4222
|
Tag: {
|
|
4173
|
-
/**
|
|
4223
|
+
/** Unique tag identifier string. */
|
|
4174
4224
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4175
|
-
/**
|
|
4225
|
+
/** Unique tag name. Tag names are not case-sensitive. */
|
|
4176
4226
|
name: string;
|
|
4177
|
-
/**
|
|
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
|
+
*/
|
|
4178
4231
|
type: "customer" | "kyc-document";
|
|
4179
|
-
/**
|
|
4232
|
+
/** Date and time at which the tag was created. */
|
|
4180
4233
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4181
4234
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
4182
|
-
/**
|
|
4235
|
+
/** Resource related links. */
|
|
4183
4236
|
_links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
|
|
4184
4237
|
};
|
|
4185
4238
|
DefaultPaymentInstrumentLink: coreComponents["schemas"]["Link"] & {
|
|
4186
|
-
/**
|
|
4239
|
+
/** Type of link. */
|
|
4187
4240
|
rel: "defaultPaymentInstrument";
|
|
4188
4241
|
};
|
|
4189
4242
|
LeadSourceLink: coreComponents["schemas"]["Link"] & {
|
|
4190
|
-
/**
|
|
4243
|
+
/** Type of link. */
|
|
4191
4244
|
rel: "leadSource";
|
|
4192
4245
|
};
|
|
4193
4246
|
WebsiteLink: coreComponents["schemas"]["Link"] & {
|
|
4194
|
-
/**
|
|
4247
|
+
/** Type of link. */
|
|
4195
4248
|
rel: "website";
|
|
4196
4249
|
};
|
|
4197
4250
|
LeadSourceData: {
|
|
4198
|
-
/**
|
|
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
|
+
*/
|
|
4199
4255
|
medium?: string;
|
|
4200
|
-
/**
|
|
4256
|
+
/**
|
|
4257
|
+
* Domain, platform, or channel from which the lead
|
|
4258
|
+
* source originates.
|
|
4259
|
+
*/
|
|
4201
4260
|
source?: string;
|
|
4202
|
-
/**
|
|
4261
|
+
/** Campaign name of the lead source. */
|
|
4203
4262
|
campaign?: string;
|
|
4204
|
-
/**
|
|
4263
|
+
/** Term associated with a lead source. */
|
|
4205
4264
|
term?: string;
|
|
4206
|
-
/**
|
|
4265
|
+
/**
|
|
4266
|
+
* Content contained in the lead source content.
|
|
4267
|
+
* For example, content could be graphics, video, and so on.
|
|
4268
|
+
*/
|
|
4207
4269
|
content?: string;
|
|
4208
|
-
/**
|
|
4270
|
+
/**
|
|
4271
|
+
* Individual or entity that is affilated with the lead
|
|
4272
|
+
* source.
|
|
4273
|
+
*/
|
|
4209
4274
|
affiliate?: string;
|
|
4210
|
-
/**
|
|
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
|
+
*/
|
|
4211
4280
|
subAffiliate?: string;
|
|
4212
|
-
/**
|
|
4281
|
+
/** Name of the sales agent associated with the lead source. */
|
|
4213
4282
|
salesAgent?: string;
|
|
4214
|
-
/**
|
|
4283
|
+
/**
|
|
4284
|
+
* Lead source click ID. This value is passed in the ad
|
|
4285
|
+
* click URL for tracking and campaign attribution.
|
|
4286
|
+
*/
|
|
4215
4287
|
clickId?: string;
|
|
4216
|
-
/**
|
|
4288
|
+
/** URL from which the lead source originates. */
|
|
4217
4289
|
path?: string;
|
|
4218
|
-
/**
|
|
4290
|
+
/**
|
|
4291
|
+
* Lead source
|
|
4292
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
4293
|
+
*/
|
|
4219
4294
|
referrer?: string;
|
|
4220
|
-
/**
|
|
4295
|
+
/** Date and time at which the lead source was created. */
|
|
4221
4296
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4222
|
-
/**
|
|
4297
|
+
/** Related resource links. */
|
|
4223
4298
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
4224
4299
|
Partial<coreComponents["schemas"]["CustomerLink"]>)[];
|
|
4225
4300
|
};
|
|
4226
4301
|
LeadSource: coreComponents["schemas"]["LeadSourceData"] & {
|
|
4227
4302
|
original?: coreComponents["schemas"]["LeadSourceData"];
|
|
4228
4303
|
};
|
|
4229
|
-
/**
|
|
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
|
+
*/
|
|
4230
4310
|
LeadSourceEmbed: {
|
|
4231
4311
|
leadSource?: coreComponents["schemas"]["LeadSource"];
|
|
4232
4312
|
};
|
|
4233
4313
|
Customer: {
|
|
4234
|
-
/**
|
|
4314
|
+
/** Unique customer identifier string. */
|
|
4235
4315
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
4236
|
-
/**
|
|
4316
|
+
/** Customer's email address. */
|
|
4237
4317
|
email?: string;
|
|
4238
|
-
/**
|
|
4318
|
+
/** Customer's first name. */
|
|
4239
4319
|
firstName?: string;
|
|
4240
|
-
/**
|
|
4320
|
+
/** Customer's last name. */
|
|
4241
4321
|
lastName?: string;
|
|
4242
|
-
/**
|
|
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
|
+
*/
|
|
4243
4328
|
websiteId?: coreComponents["schemas"]["ResourceId"];
|
|
4244
4329
|
/**
|
|
4245
|
-
*
|
|
4246
|
-
* payment instrument and
|
|
4247
|
-
* value
|
|
4248
|
-
*
|
|
4249
|
-
*
|
|
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.
|
|
4250
4335
|
*/
|
|
4251
4336
|
paymentToken?: string;
|
|
4252
4337
|
defaultPaymentInstrument?: coreComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
4253
|
-
/**
|
|
4338
|
+
/** Date and time at which the was customer created. */
|
|
4254
4339
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4255
4340
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
4256
4341
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
4257
4342
|
primaryAddress?: coreComponents["schemas"]["ContactObject"];
|
|
4258
4343
|
averageValue?: coreComponents["schemas"]["CustomerAverageValue"];
|
|
4259
|
-
/**
|
|
4344
|
+
/** Total number of approved payments made by the customer. */
|
|
4260
4345
|
paymentCount?: number;
|
|
4261
|
-
/**
|
|
4346
|
+
/** Time and date of the customer's last approved payment. */
|
|
4262
4347
|
lastPaymentTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
4263
4348
|
lifetimeRevenue?: coreComponents["schemas"]["CustomerLifetimeRevenue"];
|
|
4264
|
-
/**
|
|
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
|
+
*/
|
|
4265
4356
|
invoiceCount?: number;
|
|
4266
4357
|
/** A list of customer's tags. */
|
|
4267
4358
|
tags?: coreComponents["schemas"]["Tag"][];
|
|
4268
4359
|
/**
|
|
4269
|
-
*
|
|
4270
|
-
*
|
|
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.
|
|
4271
4364
|
*/
|
|
4272
4365
|
revision?: number;
|
|
4273
|
-
/**
|
|
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
|
+
*/
|
|
4274
4371
|
isEddRequired: boolean;
|
|
4275
|
-
/**
|
|
4372
|
+
/**
|
|
4373
|
+
* Specifies whether the customer has accepted and reviewed
|
|
4374
|
+
* identity and address documents, or an accepted credit file
|
|
4375
|
+
* document.
|
|
4376
|
+
*/
|
|
4276
4377
|
hasFulfilledKyc?: boolean;
|
|
4277
|
-
/**
|
|
4378
|
+
/** Related resource links. */
|
|
4278
4379
|
_links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
|
|
4279
4380
|
Partial<coreComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
4280
4381
|
Partial<coreComponents["schemas"]["LeadSourceLink"]> &
|
|
4281
4382
|
Partial<coreComponents["schemas"]["WebsiteLink"]>)[];
|
|
4282
|
-
/**
|
|
4383
|
+
/**
|
|
4384
|
+
* Array of embedded objects that are requested using the `expand`
|
|
4385
|
+
* query string parameter.
|
|
4386
|
+
*/
|
|
4283
4387
|
_embedded?: Partial<coreComponents["schemas"]["LeadSourceEmbed"]>[];
|
|
4284
4388
|
};
|
|
4285
4389
|
CustomerTimelineCustomEvent: {
|
|
@@ -4519,6 +4623,7 @@ export interface coreComponents {
|
|
|
4519
4623
|
| "Circle"
|
|
4520
4624
|
| "Citadel"
|
|
4521
4625
|
| "Clearhaus"
|
|
4626
|
+
| "Cleo"
|
|
4522
4627
|
| "CODVoucher"
|
|
4523
4628
|
| "Coinbase"
|
|
4524
4629
|
| "CoinGate"
|
|
@@ -4583,6 +4688,7 @@ export interface coreComponents {
|
|
|
4583
4688
|
| "Moneris"
|
|
4584
4689
|
| "MtaPay"
|
|
4585
4690
|
| "MuchBetter"
|
|
4691
|
+
| "MuchBetterGateway"
|
|
4586
4692
|
| "MyFatoorah"
|
|
4587
4693
|
| "Neosurf"
|
|
4588
4694
|
| "Netbanking"
|
|
@@ -4792,6 +4898,7 @@ export interface coreComponents {
|
|
|
4792
4898
|
| "Circle"
|
|
4793
4899
|
| "Citadel"
|
|
4794
4900
|
| "Clearhaus"
|
|
4901
|
+
| "Cleo"
|
|
4795
4902
|
| "CODVoucher"
|
|
4796
4903
|
| "Coinbase"
|
|
4797
4904
|
| "CoinGate"
|
|
@@ -4852,6 +4959,7 @@ export interface coreComponents {
|
|
|
4852
4959
|
| "MiFinity"
|
|
4853
4960
|
| "Moneris"
|
|
4854
4961
|
| "MuchBetter"
|
|
4962
|
+
| "MuchBetterGateway"
|
|
4855
4963
|
| "MyFatoorah"
|
|
4856
4964
|
| "NATWEST"
|
|
4857
4965
|
| "Neosurf"
|
|
@@ -5899,6 +6007,14 @@ export interface coreComponents {
|
|
|
5899
6007
|
};
|
|
5900
6008
|
threeDSecureServer?: coreComponents["schemas"]["Clearhaus3dsServers"];
|
|
5901
6009
|
};
|
|
6010
|
+
/** Cleo config. */
|
|
6011
|
+
Cleo: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6012
|
+
/** Cleo credentials object. */
|
|
6013
|
+
credentials: {
|
|
6014
|
+
/** Cleo access token. */
|
|
6015
|
+
accessToken: string;
|
|
6016
|
+
};
|
|
6017
|
+
};
|
|
5902
6018
|
/** Conekta config. */
|
|
5903
6019
|
Conekta: coreComponents["schemas"]["GatewayAccount"] & {
|
|
5904
6020
|
/** Conekta credentials object. */
|
|
@@ -6704,6 +6820,16 @@ export interface coreComponents {
|
|
|
6704
6820
|
hasPhoneNumberRequest: boolean;
|
|
6705
6821
|
};
|
|
6706
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
|
+
};
|
|
6707
6833
|
/** MyFatoorah config. */
|
|
6708
6834
|
MyFatoorah: coreComponents["schemas"]["GatewayAccount"] & {
|
|
6709
6835
|
/** MyFatoorah credentials object. */
|
|
@@ -7351,6 +7477,11 @@ export interface coreComponents {
|
|
|
7351
7477
|
/** Redsys Gateway secret code. */
|
|
7352
7478
|
secretCode: string;
|
|
7353
7479
|
};
|
|
7480
|
+
/** Redsys settings object. */
|
|
7481
|
+
settings?: {
|
|
7482
|
+
/** Redsys terminal. */
|
|
7483
|
+
terminal?: string;
|
|
7484
|
+
};
|
|
7354
7485
|
};
|
|
7355
7486
|
/** Rotessa config. */
|
|
7356
7487
|
Rotessa: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -8430,17 +8561,13 @@ export interface coreComponents {
|
|
|
8430
8561
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
8431
8562
|
};
|
|
8432
8563
|
Product: coreComponents["schemas"]["CommonProduct"] & {
|
|
8433
|
-
/**
|
|
8434
|
-
|
|
8435
|
-
|
|
8436
|
-
|
|
8437
|
-
|
|
8438
|
-
|
|
8439
|
-
|
|
8440
|
-
| "51010"
|
|
8441
|
-
| "31000"
|
|
8442
|
-
| "30070";
|
|
8443
|
-
/** 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. */
|
|
8444
8571
|
accountingCode?: string;
|
|
8445
8572
|
/** The links related to resource. */
|
|
8446
8573
|
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
@@ -8563,23 +8690,15 @@ export interface coreComponents {
|
|
|
8563
8690
|
maxQuantity?: number;
|
|
8564
8691
|
}[];
|
|
8565
8692
|
};
|
|
8566
|
-
PlanPeriod: {
|
|
8567
|
-
/** The unit of time. */
|
|
8568
|
-
unit: "day" | "week" | "month" | "year";
|
|
8569
|
-
/** The length of time. */
|
|
8570
|
-
length: number;
|
|
8571
|
-
};
|
|
8572
|
-
/**
|
|
8573
|
-
* The billing timing in relation to the service period.
|
|
8574
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
8575
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
8576
|
-
*/
|
|
8577
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
8578
8693
|
CommonPlan: {
|
|
8579
8694
|
/** The plan ID. */
|
|
8580
8695
|
id?: coreComponents["schemas"]["ResourceId"];
|
|
8581
8696
|
/** The plan name, displayed on invoices and receipts. */
|
|
8582
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;
|
|
8583
8702
|
/** The related product ID. */
|
|
8584
8703
|
productId: coreComponents["schemas"]["ResourceId"];
|
|
8585
8704
|
/** Name-value pairs to specify the product options. */
|
|
@@ -8588,31 +8707,14 @@ export interface coreComponents {
|
|
|
8588
8707
|
/** Currency sign. */
|
|
8589
8708
|
currencySign?: string;
|
|
8590
8709
|
pricing: coreComponents["schemas"]["PlanPriceFormula"];
|
|
8591
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
8592
|
-
recurringInterval?: coreComponents["schemas"]["PlanPeriod"] & {
|
|
8593
|
-
/**
|
|
8594
|
-
* The number of invoices this subscription order will generate
|
|
8595
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
8596
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
8597
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
8598
|
-
*/
|
|
8599
|
-
limit?: number;
|
|
8600
|
-
billingTiming?: coreComponents["schemas"]["PlanBillingTiming"];
|
|
8601
|
-
};
|
|
8602
|
-
/** The trial. Set `null` if no trial. */
|
|
8603
|
-
trial?: {
|
|
8604
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
8605
|
-
price: number;
|
|
8606
|
-
period: coreComponents["schemas"]["PlanPeriod"];
|
|
8607
|
-
};
|
|
8608
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
8609
|
-
isTrialOnly?: boolean;
|
|
8610
8710
|
/** The setup. Set `null` if no setup. */
|
|
8611
8711
|
setup?: {
|
|
8612
8712
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
8613
8713
|
price: number;
|
|
8614
8714
|
};
|
|
8615
8715
|
customFields?: coreComponents["schemas"]["ResourceCustomFields"];
|
|
8716
|
+
/** Specifies whether a plan is active. */
|
|
8717
|
+
isActive?: boolean;
|
|
8616
8718
|
/**
|
|
8617
8719
|
* Increments when the plan is modified.
|
|
8618
8720
|
* Compare to materialized subscription items revision.
|
|
@@ -8621,7 +8723,24 @@ export interface coreComponents {
|
|
|
8621
8723
|
/** Plan created time. */
|
|
8622
8724
|
createdTime?: coreComponents["schemas"]["ServerTimestamp"];
|
|
8623
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"][];
|
|
8624
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;
|
|
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";
|
|
8625
8744
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
8626
8745
|
TimePluralUnit:
|
|
8627
8746
|
| "seconds"
|
|
@@ -8669,12 +8788,53 @@ export interface coreComponents {
|
|
|
8669
8788
|
issueTimeShift?: coreComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
8670
8789
|
dueTimeShift?: coreComponents["schemas"]["DueTimeShiftInstruction"];
|
|
8671
8790
|
};
|
|
8672
|
-
|
|
8673
|
-
/**
|
|
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
|
+
*/
|
|
8674
8816
|
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
8675
|
-
/** The links related to resource. */
|
|
8676
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
8677
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
|
+
*/
|
|
8832
|
+
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"];
|
|
8833
|
+
};
|
|
8834
|
+
Plan:
|
|
8835
|
+
| coreComponents["schemas"]["OneTimeSalePlan"]
|
|
8836
|
+
| coreComponents["schemas"]["SubscriptionOrderPlan"]
|
|
8837
|
+
| coreComponents["schemas"]["TrialOnlyPlan"];
|
|
8678
8838
|
/** Plan object. */
|
|
8679
8839
|
PlanEmbed: {
|
|
8680
8840
|
plan?: coreComponents["schemas"]["Plan"];
|
|
@@ -9670,24 +9830,32 @@ export interface coreComponents {
|
|
|
9670
9830
|
isIdentityDocument?: boolean;
|
|
9671
9831
|
/** If there is an exact match found online. */
|
|
9672
9832
|
isPublishedOnline?: boolean;
|
|
9833
|
+
/** Contains urls to matching images found online. */
|
|
9834
|
+
matchingImages?: string[];
|
|
9673
9835
|
/** The customer first name if it was matched, null otherwise. */
|
|
9674
9836
|
firstName?: string | null;
|
|
9675
9837
|
/** The customer last name if it was matched, null otherwise. */
|
|
9676
9838
|
lastName?: string | null;
|
|
9677
9839
|
/** The date of birth found on the document, null if not found. */
|
|
9678
9840
|
dateOfBirth?: string | null;
|
|
9679
|
-
/**
|
|
9680
|
-
expiryDate?: string | null;
|
|
9681
|
-
/** 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. */
|
|
9682
9842
|
expirationDate?: string | null;
|
|
9683
9843
|
/** The issued date found on the document, null if not found. */
|
|
9684
9844
|
issueDate?: string | null;
|
|
9685
9845
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
9686
9846
|
hasMinimalAge?: boolean | null;
|
|
9687
|
-
/**
|
|
9847
|
+
/** Nationality detected on a passport or citizenship document. If a nationality is not detected, this value is null. */
|
|
9688
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;
|
|
9689
9855
|
/** The interpreted subtype of the uploaded document. */
|
|
9690
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;
|
|
9691
9859
|
};
|
|
9692
9860
|
KycSettingsIdentity: {
|
|
9693
9861
|
/** The weights of all matched properties. */
|
|
@@ -9878,6 +10046,32 @@ export interface coreComponents {
|
|
|
9878
10046
|
*/
|
|
9879
10047
|
_embedded?: Partial<coreComponents["schemas"]["CustomerEmbed"]>[];
|
|
9880
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
|
+
};
|
|
9881
10075
|
CreditFileMatches: {
|
|
9882
10076
|
/** The credit bureau which is used to get credit file data. */
|
|
9883
10077
|
creditBureau?: "equifax" | "experian" | "transunion" | "test-bureau";
|
|
@@ -9897,7 +10091,24 @@ export interface coreComponents {
|
|
|
9897
10091
|
dateOpened?: string;
|
|
9898
10092
|
}[];
|
|
9899
10093
|
/** Extra data from credit bureau. */
|
|
9900
|
-
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
|
+
};
|
|
9901
10112
|
};
|
|
9902
10113
|
ProofOfCreditFileKycDocument: coreComponents["schemas"]["BaseKycDocument"] &
|
|
9903
10114
|
coreComponents["schemas"]["KycDocument"] & {
|
|
@@ -10048,6 +10259,7 @@ export interface coreComponents {
|
|
|
10048
10259
|
| "CASHlib"
|
|
10049
10260
|
| "CashToCode"
|
|
10050
10261
|
| "China UnionPay"
|
|
10262
|
+
| "Cleo"
|
|
10051
10263
|
| "CODVoucher"
|
|
10052
10264
|
| "Conekta-oxxo"
|
|
10053
10265
|
| "Cupon-de-pagos"
|
|
@@ -10439,25 +10651,9 @@ export interface coreComponents {
|
|
|
10439
10651
|
/** The ID of plan to use. */
|
|
10440
10652
|
id: coreComponents["schemas"]["ResourceId"];
|
|
10441
10653
|
};
|
|
10442
|
-
FlexiblePlan: coreComponents["schemas"]["
|
|
10654
|
+
FlexiblePlan: coreComponents["schemas"]["Plan"] & {
|
|
10443
10655
|
/** ID of a plan you wish to modify. */
|
|
10444
|
-
id
|
|
10445
|
-
/** Specifies whether a plan is active. */
|
|
10446
|
-
isActive?: boolean;
|
|
10447
|
-
/**
|
|
10448
|
-
* Use invoice time shift to adjust the invoice issue and due date
|
|
10449
|
-
* when billing must occur before the service period changes.
|
|
10450
|
-
* For example, rent must be paid in advance, so the invoice must
|
|
10451
|
-
* be in advance of the billing date. For more information, see
|
|
10452
|
-
* [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).
|
|
10453
|
-
*/
|
|
10454
|
-
invoiceTimeShift?: coreComponents["schemas"]["InvoiceTimeShift"] | null;
|
|
10455
|
-
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
10456
|
-
description?: string;
|
|
10457
|
-
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
10458
|
-
richDescription?: string;
|
|
10459
|
-
/** Related resource links. */
|
|
10460
|
-
_links?: coreComponents["schemas"]["SelfLink"][];
|
|
10656
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
10461
10657
|
};
|
|
10462
10658
|
OrderItem: {
|
|
10463
10659
|
/** The plan identifier string. */
|
|
@@ -11423,7 +11619,7 @@ export interface coreComponents {
|
|
|
11423
11619
|
OrderPreview: coreComponents["schemas"]["CommonOrderPreview"] & {
|
|
11424
11620
|
shipping?: coreComponents["schemas"]["Shipping"];
|
|
11425
11621
|
};
|
|
11426
|
-
/** Rebilly
|
|
11622
|
+
/** Rebilly webhook event type. */
|
|
11427
11623
|
GlobalWebhookEventType:
|
|
11428
11624
|
| "aml-list-possibly-matched"
|
|
11429
11625
|
| "application-instance-disabled"
|
|
@@ -11766,7 +11962,10 @@ export interface coreComponents {
|
|
|
11766
11962
|
/** Plan resource. */
|
|
11767
11963
|
Plan: {
|
|
11768
11964
|
content: {
|
|
11769
|
-
"application/json":
|
|
11965
|
+
"application/json":
|
|
11966
|
+
| coreComponents["schemas"]["OneTimeSalePlan"]
|
|
11967
|
+
| coreComponents["schemas"]["SubscriptionOrderPlan"]
|
|
11968
|
+
| coreComponents["schemas"]["TrialOnlyPlan"];
|
|
11770
11969
|
};
|
|
11771
11970
|
};
|
|
11772
11971
|
/** Product resource. */
|
|
@@ -11828,7 +12027,7 @@ export interface coreComponents {
|
|
|
11828
12027
|
_embedded?: {
|
|
11829
12028
|
customer?: coreComponents["schemas"]["Customer"];
|
|
11830
12029
|
};
|
|
11831
|
-
/**
|
|
12030
|
+
/** Related resource links. */
|
|
11832
12031
|
_links?: Partial<coreComponents["schemas"]["CustomerLink"]>[];
|
|
11833
12032
|
};
|
|
11834
12033
|
};
|
|
@@ -12119,11 +12318,17 @@ export interface coreComponents {
|
|
|
12119
12318
|
};
|
|
12120
12319
|
};
|
|
12121
12320
|
headers: {
|
|
12122
|
-
/** Total items
|
|
12321
|
+
/** Total number of items. */
|
|
12123
12322
|
"Pagination-Total"?: number;
|
|
12124
|
-
/**
|
|
12323
|
+
/** Maximum number of items per page. */
|
|
12125
12324
|
"Pagination-Limit"?: number;
|
|
12126
|
-
/**
|
|
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
|
+
*/
|
|
12127
12332
|
"Pagination-Offset"?: number;
|
|
12128
12333
|
/** The location of the related resource. */
|
|
12129
12334
|
Location?: string;
|
|
@@ -12132,24 +12337,35 @@ export interface coreComponents {
|
|
|
12132
12337
|
|
|
12133
12338
|
export interface operations {
|
|
12134
12339
|
/**
|
|
12135
|
-
*
|
|
12136
|
-
*
|
|
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.
|
|
12137
12345
|
*/
|
|
12138
12346
|
GetAmlEntry: {
|
|
12139
12347
|
parameters: {
|
|
12140
12348
|
query: {
|
|
12141
|
-
/** First name of individual to search. */
|
|
12349
|
+
/** First name of the individual to search. */
|
|
12142
12350
|
firstName: string;
|
|
12143
|
-
/** Last name of individual to search. */
|
|
12351
|
+
/** Last name of the individual to search. */
|
|
12144
12352
|
lastName: string;
|
|
12145
|
-
/**
|
|
12353
|
+
/** Individual's date of birth in YYYY-MM-DD format. */
|
|
12146
12354
|
dob?: string;
|
|
12147
|
-
/**
|
|
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
|
+
*/
|
|
12148
12360
|
country?: coreComponents["schemas"]["Country"];
|
|
12149
12361
|
};
|
|
12150
12362
|
};
|
|
12151
12363
|
responses: {
|
|
12152
|
-
/**
|
|
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
|
+
*/
|
|
12153
12369
|
200: {
|
|
12154
12370
|
headers: {};
|
|
12155
12371
|
content: {
|
|
@@ -13167,8 +13383,11 @@ export interface operations {
|
|
|
13167
13383
|
};
|
|
13168
13384
|
};
|
|
13169
13385
|
/**
|
|
13170
|
-
*
|
|
13171
|
-
*
|
|
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.
|
|
13172
13391
|
*/
|
|
13173
13392
|
GetCustomerAmlEntryCollection: {
|
|
13174
13393
|
parameters: {
|
|
@@ -13178,7 +13397,11 @@ export interface operations {
|
|
|
13178
13397
|
};
|
|
13179
13398
|
};
|
|
13180
13399
|
responses: {
|
|
13181
|
-
/**
|
|
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
|
+
*/
|
|
13182
13405
|
200: {
|
|
13183
13406
|
headers: {};
|
|
13184
13407
|
content: {
|
|
@@ -13620,7 +13843,7 @@ export interface operations {
|
|
|
13620
13843
|
"Content-Type"?: string;
|
|
13621
13844
|
};
|
|
13622
13845
|
content: {
|
|
13623
|
-
"application/json": string;
|
|
13846
|
+
"application/json, application/pdf, image/jpg, image/png, image/gif, audio/mpeg": string;
|
|
13624
13847
|
};
|
|
13625
13848
|
};
|
|
13626
13849
|
302: coreComponents["responses"]["Found"];
|
|
@@ -14451,7 +14674,7 @@ export interface operations {
|
|
|
14451
14674
|
404: coreComponents["responses"]["NotFound"];
|
|
14452
14675
|
};
|
|
14453
14676
|
};
|
|
14454
|
-
/**
|
|
14677
|
+
/** Retrieves the credit amount allocated to the given invoice from a specific credit memo. */
|
|
14455
14678
|
GetInvoiceCreditMemoAllocation: {
|
|
14456
14679
|
parameters: {
|
|
14457
14680
|
path: {
|
|
@@ -14460,12 +14683,6 @@ export interface operations {
|
|
|
14460
14683
|
/** Credit memo ID. */
|
|
14461
14684
|
creditMemoId: string;
|
|
14462
14685
|
};
|
|
14463
|
-
query: {
|
|
14464
|
-
/** The collection items limit. */
|
|
14465
|
-
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
14466
|
-
/** The collection items offset. */
|
|
14467
|
-
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
14468
|
-
};
|
|
14469
14686
|
};
|
|
14470
14687
|
responses: {
|
|
14471
14688
|
/** The allocation was retrieved successfully. */
|
|
@@ -18481,19 +18698,22 @@ export interface usersPaths {
|
|
|
18481
18698
|
|
|
18482
18699
|
export interface usersComponents {
|
|
18483
18700
|
schemas: {
|
|
18484
|
-
/**
|
|
18701
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
18485
18702
|
Country: string;
|
|
18486
18703
|
SelfLink: {
|
|
18487
|
-
/**
|
|
18704
|
+
/** Type of link. */
|
|
18488
18705
|
rel: "self";
|
|
18489
|
-
/**
|
|
18706
|
+
/** Link URL. */
|
|
18490
18707
|
href: string;
|
|
18491
18708
|
};
|
|
18492
|
-
/**
|
|
18709
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
18493
18710
|
ResourceId: string;
|
|
18494
|
-
/** Read-only timestamp
|
|
18711
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
18495
18712
|
ServerTimestamp: string;
|
|
18496
|
-
/**
|
|
18713
|
+
/**
|
|
18714
|
+
* Read-only timestamp. This value updates when the resource
|
|
18715
|
+
* is updated.
|
|
18716
|
+
*/
|
|
18497
18717
|
UpdatedTime: string;
|
|
18498
18718
|
Link: {
|
|
18499
18719
|
/** The link URL. */
|
|
@@ -18536,7 +18756,7 @@ export interface usersComponents {
|
|
|
18536
18756
|
/** The HTTP status code. */
|
|
18537
18757
|
status?: number;
|
|
18538
18758
|
} & usersComponents["schemas"]["BaseProblem"];
|
|
18539
|
-
/**
|
|
18759
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
18540
18760
|
CustomerId: string;
|
|
18541
18761
|
ApiKeyScope: {
|
|
18542
18762
|
/** The array of account identifier strings. */
|
|
@@ -18556,10 +18776,10 @@ export interface usersComponents {
|
|
|
18556
18776
|
permissions: usersComponents["schemas"]["AclPermissions"];
|
|
18557
18777
|
}[];
|
|
18558
18778
|
CustomerLink: usersComponents["schemas"]["Link"] & {
|
|
18559
|
-
/**
|
|
18779
|
+
/** Type of link. */
|
|
18560
18780
|
rel: "customer" | "targetCustomer";
|
|
18561
18781
|
};
|
|
18562
|
-
/** ISO 4217
|
|
18782
|
+
/** ISO 4217 currency code. */
|
|
18563
18783
|
CurrencyCode: string;
|
|
18564
18784
|
/** The context in which the discount applies. */
|
|
18565
18785
|
DiscountContext: "items" | "shipping" | "items-and-shipping";
|
|
@@ -18583,7 +18803,7 @@ export interface usersComponents {
|
|
|
18583
18803
|
Error: usersComponents["schemas"]["Problem"] & {
|
|
18584
18804
|
error?: string;
|
|
18585
18805
|
};
|
|
18586
|
-
/**
|
|
18806
|
+
/** Payment method. */
|
|
18587
18807
|
PaymentMethod:
|
|
18588
18808
|
| "payment-card"
|
|
18589
18809
|
| "ach"
|
|
@@ -18622,6 +18842,7 @@ export interface usersComponents {
|
|
|
18622
18842
|
| "CashToCode"
|
|
18623
18843
|
| "CCAvenue"
|
|
18624
18844
|
| "China UnionPay"
|
|
18845
|
+
| "Cleo"
|
|
18625
18846
|
| "CODVoucher"
|
|
18626
18847
|
| "Conekta-oxxo"
|
|
18627
18848
|
| "Conekta-spei"
|
|
@@ -18754,8 +18975,8 @@ export interface usersComponents {
|
|
|
18754
18975
|
/** Vaulted payment instrument. */
|
|
18755
18976
|
VaultedInstrument: {
|
|
18756
18977
|
/**
|
|
18757
|
-
*
|
|
18758
|
-
*
|
|
18978
|
+
* Payment method supported vault. For more information, see
|
|
18979
|
+
* [Payment Instrument](https://api-reference.rebilly.com/tag/Payment-Instruments).
|
|
18759
18980
|
*/
|
|
18760
18981
|
method: "payment-card" | "ach" | "paypal";
|
|
18761
18982
|
/** The payment instrument identifier. */
|
|
@@ -18764,13 +18985,13 @@ export interface usersComponents {
|
|
|
18764
18985
|
/** Alternative payment method instrument. */
|
|
18765
18986
|
AlternativePaymentInstrument: {
|
|
18766
18987
|
method: usersComponents["schemas"]["PaymentMethod"];
|
|
18767
|
-
/**
|
|
18988
|
+
/** Payment instrument ID. */
|
|
18768
18989
|
paymentInstrumentId?: usersComponents["schemas"]["ResourceId"];
|
|
18769
18990
|
};
|
|
18770
18991
|
/** Cash payment instrument object. */
|
|
18771
18992
|
CashInstrument: {
|
|
18772
18993
|
method: "cash";
|
|
18773
|
-
/**
|
|
18994
|
+
/** Individual or entity that received the payment. */
|
|
18774
18995
|
receivedBy?: string;
|
|
18775
18996
|
};
|
|
18776
18997
|
/** Check payment instrument object. */
|
|
@@ -18785,58 +19006,78 @@ export interface usersComponents {
|
|
|
18785
19006
|
Partial<usersComponents["schemas"]["AlternativePaymentInstrument"]> &
|
|
18786
19007
|
Partial<usersComponents["schemas"]["CashInstrument"]> &
|
|
18787
19008
|
Partial<usersComponents["schemas"]["CheckInstrument"]>;
|
|
18788
|
-
/**
|
|
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
|
+
*/
|
|
18789
19014
|
ResourceCustomFields: { [key: string]: any };
|
|
18790
|
-
/**
|
|
19015
|
+
/** List of phone numbers associated with the contact. */
|
|
18791
19016
|
ContactPhoneNumbers: {
|
|
18792
|
-
/**
|
|
19017
|
+
/** Phone number label or name. */
|
|
18793
19018
|
label: string;
|
|
18794
|
-
/**
|
|
19019
|
+
/** Phone number value. */
|
|
18795
19020
|
value: string;
|
|
18796
|
-
/**
|
|
19021
|
+
/**
|
|
19022
|
+
* Specifies whether the phone number is the contact's
|
|
19023
|
+
* primary phone number.
|
|
19024
|
+
*/
|
|
18797
19025
|
primary?: boolean;
|
|
18798
19026
|
}[];
|
|
18799
|
-
/**
|
|
19027
|
+
/** List of email addresses associated with the contact. */
|
|
18800
19028
|
ContactEmails: {
|
|
18801
|
-
/**
|
|
19029
|
+
/** Email label or name. */
|
|
18802
19030
|
label: string;
|
|
18803
|
-
/**
|
|
19031
|
+
/** Email address value. */
|
|
18804
19032
|
value: string;
|
|
18805
|
-
/**
|
|
19033
|
+
/**
|
|
19034
|
+
* Specifies whether the email address is the contact's
|
|
19035
|
+
* primary email address.
|
|
19036
|
+
*/
|
|
18806
19037
|
primary?: boolean;
|
|
18807
19038
|
}[];
|
|
18808
19039
|
ContactObject: {
|
|
18809
|
-
/**
|
|
19040
|
+
/** Contact's first name. */
|
|
18810
19041
|
firstName?: string | null;
|
|
18811
|
-
/**
|
|
19042
|
+
/** Contact's last name. */
|
|
18812
19043
|
lastName?: string | null;
|
|
18813
|
-
/** The contact organization. */
|
|
19044
|
+
/** The contact's organization. */
|
|
18814
19045
|
organization?: string | null;
|
|
18815
|
-
/**
|
|
19046
|
+
/** First line of the contact's street address. */
|
|
18816
19047
|
address?: string | null;
|
|
18817
|
-
/**
|
|
19048
|
+
/** Second line of the contact's street address. */
|
|
18818
19049
|
address2?: string | null;
|
|
18819
|
-
/**
|
|
19050
|
+
/** Contact's city of residence. */
|
|
18820
19051
|
city?: string | null;
|
|
18821
|
-
/**
|
|
19052
|
+
/** Contact's region of residence. */
|
|
18822
19053
|
region?: string | null;
|
|
18823
|
-
/**
|
|
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
|
+
*/
|
|
18824
19059
|
country?: string | null;
|
|
18825
|
-
/**
|
|
19060
|
+
/** Contact's postal code. */
|
|
18826
19061
|
postalCode?: string | null;
|
|
18827
19062
|
phoneNumbers?: usersComponents["schemas"]["ContactPhoneNumbers"];
|
|
18828
19063
|
emails?: usersComponents["schemas"]["ContactEmails"];
|
|
18829
|
-
/**
|
|
19064
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
18830
19065
|
dob?: string | null;
|
|
18831
19066
|
/** The contact's job title. */
|
|
18832
19067
|
jobTitle?: string | null;
|
|
18833
|
-
/**
|
|
19068
|
+
/**
|
|
19069
|
+
* Use this value to compare contacts for identical
|
|
19070
|
+
* attribute values.
|
|
19071
|
+
*/
|
|
18834
19072
|
hash?: string;
|
|
18835
19073
|
};
|
|
18836
19074
|
CustomerAverageValue: {
|
|
18837
19075
|
/** Merchant's reporting currency. */
|
|
18838
19076
|
currency?: usersComponents["schemas"]["CurrencyCode"];
|
|
18839
|
-
/**
|
|
19077
|
+
/**
|
|
19078
|
+
* Average approved payment amount in merchant's
|
|
19079
|
+
* reporting currency.
|
|
19080
|
+
*/
|
|
18840
19081
|
amount?: number;
|
|
18841
19082
|
/** Average approved payment amount in USD. */
|
|
18842
19083
|
amountUsd?: number;
|
|
@@ -18844,123 +19085,181 @@ export interface usersComponents {
|
|
|
18844
19085
|
CustomerLifetimeRevenue: {
|
|
18845
19086
|
/** Merchant's reporting currency. */
|
|
18846
19087
|
currency?: usersComponents["schemas"]["CurrencyCode"];
|
|
18847
|
-
/** Revenue amount in
|
|
19088
|
+
/** Revenue amount in the merchant's reporting currency. */
|
|
18848
19089
|
amount?: number;
|
|
18849
19090
|
/** Revenue amount in USD. */
|
|
18850
19091
|
amountUsd?: number;
|
|
18851
19092
|
};
|
|
18852
|
-
/**
|
|
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
|
+
*/
|
|
18853
19098
|
Tag: {
|
|
18854
|
-
/**
|
|
19099
|
+
/** Unique tag identifier string. */
|
|
18855
19100
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
18856
|
-
/**
|
|
19101
|
+
/** Unique tag name. Tag names are not case-sensitive. */
|
|
18857
19102
|
name: string;
|
|
18858
|
-
/**
|
|
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
|
+
*/
|
|
18859
19107
|
type: "customer" | "kyc-document";
|
|
18860
|
-
/**
|
|
19108
|
+
/** Date and time at which the tag was created. */
|
|
18861
19109
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18862
19110
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
18863
|
-
/**
|
|
19111
|
+
/** Resource related links. */
|
|
18864
19112
|
_links?: Partial<usersComponents["schemas"]["SelfLink"]>[];
|
|
18865
19113
|
};
|
|
18866
19114
|
DefaultPaymentInstrumentLink: usersComponents["schemas"]["Link"] & {
|
|
18867
|
-
/**
|
|
19115
|
+
/** Type of link. */
|
|
18868
19116
|
rel: "defaultPaymentInstrument";
|
|
18869
19117
|
};
|
|
18870
19118
|
LeadSourceLink: usersComponents["schemas"]["Link"] & {
|
|
18871
|
-
/**
|
|
19119
|
+
/** Type of link. */
|
|
18872
19120
|
rel: "leadSource";
|
|
18873
19121
|
};
|
|
18874
19122
|
WebsiteLink: usersComponents["schemas"]["Link"] & {
|
|
18875
|
-
/**
|
|
19123
|
+
/** Type of link. */
|
|
18876
19124
|
rel: "website";
|
|
18877
19125
|
};
|
|
18878
19126
|
LeadSourceData: {
|
|
18879
|
-
/**
|
|
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
|
+
*/
|
|
18880
19131
|
medium?: string;
|
|
18881
|
-
/**
|
|
19132
|
+
/**
|
|
19133
|
+
* Domain, platform, or channel from which the lead
|
|
19134
|
+
* source originates.
|
|
19135
|
+
*/
|
|
18882
19136
|
source?: string;
|
|
18883
|
-
/**
|
|
19137
|
+
/** Campaign name of the lead source. */
|
|
18884
19138
|
campaign?: string;
|
|
18885
|
-
/**
|
|
19139
|
+
/** Term associated with a lead source. */
|
|
18886
19140
|
term?: string;
|
|
18887
|
-
/**
|
|
19141
|
+
/**
|
|
19142
|
+
* Content contained in the lead source content.
|
|
19143
|
+
* For example, content could be graphics, video, and so on.
|
|
19144
|
+
*/
|
|
18888
19145
|
content?: string;
|
|
18889
|
-
/**
|
|
19146
|
+
/**
|
|
19147
|
+
* Individual or entity that is affilated with the lead
|
|
19148
|
+
* source.
|
|
19149
|
+
*/
|
|
18890
19150
|
affiliate?: string;
|
|
18891
|
-
/**
|
|
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
|
+
*/
|
|
18892
19156
|
subAffiliate?: string;
|
|
18893
|
-
/**
|
|
19157
|
+
/** Name of the sales agent associated with the lead source. */
|
|
18894
19158
|
salesAgent?: string;
|
|
18895
|
-
/**
|
|
19159
|
+
/**
|
|
19160
|
+
* Lead source click ID. This value is passed in the ad
|
|
19161
|
+
* click URL for tracking and campaign attribution.
|
|
19162
|
+
*/
|
|
18896
19163
|
clickId?: string;
|
|
18897
|
-
/**
|
|
19164
|
+
/** URL from which the lead source originates. */
|
|
18898
19165
|
path?: string;
|
|
18899
|
-
/**
|
|
19166
|
+
/**
|
|
19167
|
+
* Lead source
|
|
19168
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
19169
|
+
*/
|
|
18900
19170
|
referrer?: string;
|
|
18901
|
-
/**
|
|
19171
|
+
/** Date and time at which the lead source was created. */
|
|
18902
19172
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18903
|
-
/**
|
|
19173
|
+
/** Related resource links. */
|
|
18904
19174
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
18905
19175
|
Partial<usersComponents["schemas"]["CustomerLink"]>)[];
|
|
18906
19176
|
};
|
|
18907
19177
|
LeadSource: usersComponents["schemas"]["LeadSourceData"] & {
|
|
18908
19178
|
original?: usersComponents["schemas"]["LeadSourceData"];
|
|
18909
19179
|
};
|
|
18910
|
-
/**
|
|
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
|
+
*/
|
|
18911
19186
|
LeadSourceEmbed: {
|
|
18912
19187
|
leadSource?: usersComponents["schemas"]["LeadSource"];
|
|
18913
19188
|
};
|
|
18914
19189
|
Customer: {
|
|
18915
|
-
/**
|
|
19190
|
+
/** Unique customer identifier string. */
|
|
18916
19191
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
18917
|
-
/**
|
|
19192
|
+
/** Customer's email address. */
|
|
18918
19193
|
email?: string;
|
|
18919
|
-
/**
|
|
19194
|
+
/** Customer's first name. */
|
|
18920
19195
|
firstName?: string;
|
|
18921
|
-
/**
|
|
19196
|
+
/** Customer's last name. */
|
|
18922
19197
|
lastName?: string;
|
|
18923
|
-
/**
|
|
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
|
+
*/
|
|
18924
19204
|
websiteId?: usersComponents["schemas"]["ResourceId"];
|
|
18925
19205
|
/**
|
|
18926
|
-
*
|
|
18927
|
-
* payment instrument and
|
|
18928
|
-
* value
|
|
18929
|
-
*
|
|
18930
|
-
*
|
|
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.
|
|
18931
19211
|
*/
|
|
18932
19212
|
paymentToken?: string;
|
|
18933
19213
|
defaultPaymentInstrument?: usersComponents["schemas"]["PaymentInstrumentValueObject"];
|
|
18934
|
-
/**
|
|
19214
|
+
/** Date and time at which the was customer created. */
|
|
18935
19215
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18936
19216
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
18937
19217
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
18938
19218
|
primaryAddress?: usersComponents["schemas"]["ContactObject"];
|
|
18939
19219
|
averageValue?: usersComponents["schemas"]["CustomerAverageValue"];
|
|
18940
|
-
/**
|
|
19220
|
+
/** Total number of approved payments made by the customer. */
|
|
18941
19221
|
paymentCount?: number;
|
|
18942
|
-
/**
|
|
19222
|
+
/** Time and date of the customer's last approved payment. */
|
|
18943
19223
|
lastPaymentTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
18944
19224
|
lifetimeRevenue?: usersComponents["schemas"]["CustomerLifetimeRevenue"];
|
|
18945
|
-
/**
|
|
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
|
+
*/
|
|
18946
19232
|
invoiceCount?: number;
|
|
18947
19233
|
/** A list of customer's tags. */
|
|
18948
19234
|
tags?: usersComponents["schemas"]["Tag"][];
|
|
18949
19235
|
/**
|
|
18950
|
-
*
|
|
18951
|
-
*
|
|
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.
|
|
18952
19240
|
*/
|
|
18953
19241
|
revision?: number;
|
|
18954
|
-
/**
|
|
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
|
+
*/
|
|
18955
19247
|
isEddRequired: boolean;
|
|
18956
|
-
/**
|
|
19248
|
+
/**
|
|
19249
|
+
* Specifies whether the customer has accepted and reviewed
|
|
19250
|
+
* identity and address documents, or an accepted credit file
|
|
19251
|
+
* document.
|
|
19252
|
+
*/
|
|
18957
19253
|
hasFulfilledKyc?: boolean;
|
|
18958
|
-
/**
|
|
19254
|
+
/** Related resource links. */
|
|
18959
19255
|
_links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
|
|
18960
19256
|
Partial<usersComponents["schemas"]["DefaultPaymentInstrumentLink"]> &
|
|
18961
19257
|
Partial<usersComponents["schemas"]["LeadSourceLink"]> &
|
|
18962
19258
|
Partial<usersComponents["schemas"]["WebsiteLink"]>)[];
|
|
18963
|
-
/**
|
|
19259
|
+
/**
|
|
19260
|
+
* Array of embedded objects that are requested using the `expand`
|
|
19261
|
+
* query string parameter.
|
|
19262
|
+
*/
|
|
18964
19263
|
_embedded?: Partial<usersComponents["schemas"]["LeadSourceEmbed"]>[];
|
|
18965
19264
|
};
|
|
18966
19265
|
TimelineAction: {
|
|
@@ -19098,6 +19397,7 @@ export interface usersComponents {
|
|
|
19098
19397
|
| "Circle"
|
|
19099
19398
|
| "Citadel"
|
|
19100
19399
|
| "Clearhaus"
|
|
19400
|
+
| "Cleo"
|
|
19101
19401
|
| "CODVoucher"
|
|
19102
19402
|
| "Coinbase"
|
|
19103
19403
|
| "CoinGate"
|
|
@@ -19162,6 +19462,7 @@ export interface usersComponents {
|
|
|
19162
19462
|
| "Moneris"
|
|
19163
19463
|
| "MtaPay"
|
|
19164
19464
|
| "MuchBetter"
|
|
19465
|
+
| "MuchBetterGateway"
|
|
19165
19466
|
| "MyFatoorah"
|
|
19166
19467
|
| "Neosurf"
|
|
19167
19468
|
| "Netbanking"
|
|
@@ -19371,6 +19672,7 @@ export interface usersComponents {
|
|
|
19371
19672
|
| "Circle"
|
|
19372
19673
|
| "Citadel"
|
|
19373
19674
|
| "Clearhaus"
|
|
19675
|
+
| "Cleo"
|
|
19374
19676
|
| "CODVoucher"
|
|
19375
19677
|
| "Coinbase"
|
|
19376
19678
|
| "CoinGate"
|
|
@@ -19431,6 +19733,7 @@ export interface usersComponents {
|
|
|
19431
19733
|
| "MiFinity"
|
|
19432
19734
|
| "Moneris"
|
|
19433
19735
|
| "MuchBetter"
|
|
19736
|
+
| "MuchBetterGateway"
|
|
19434
19737
|
| "MyFatoorah"
|
|
19435
19738
|
| "NATWEST"
|
|
19436
19739
|
| "Neosurf"
|
|
@@ -20478,6 +20781,14 @@ export interface usersComponents {
|
|
|
20478
20781
|
};
|
|
20479
20782
|
threeDSecureServer?: usersComponents["schemas"]["Clearhaus3dsServers"];
|
|
20480
20783
|
};
|
|
20784
|
+
/** Cleo config. */
|
|
20785
|
+
Cleo: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20786
|
+
/** Cleo credentials object. */
|
|
20787
|
+
credentials: {
|
|
20788
|
+
/** Cleo access token. */
|
|
20789
|
+
accessToken: string;
|
|
20790
|
+
};
|
|
20791
|
+
};
|
|
20481
20792
|
/** Conekta config. */
|
|
20482
20793
|
Conekta: usersComponents["schemas"]["GatewayAccount"] & {
|
|
20483
20794
|
/** Conekta credentials object. */
|
|
@@ -21283,6 +21594,16 @@ export interface usersComponents {
|
|
|
21283
21594
|
hasPhoneNumberRequest: boolean;
|
|
21284
21595
|
};
|
|
21285
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
|
+
};
|
|
21286
21607
|
/** MyFatoorah config. */
|
|
21287
21608
|
MyFatoorah: usersComponents["schemas"]["GatewayAccount"] & {
|
|
21288
21609
|
/** MyFatoorah credentials object. */
|
|
@@ -21930,6 +22251,11 @@ export interface usersComponents {
|
|
|
21930
22251
|
/** Redsys Gateway secret code. */
|
|
21931
22252
|
secretCode: string;
|
|
21932
22253
|
};
|
|
22254
|
+
/** Redsys settings object. */
|
|
22255
|
+
settings?: {
|
|
22256
|
+
/** Redsys terminal. */
|
|
22257
|
+
terminal?: string;
|
|
22258
|
+
};
|
|
21933
22259
|
};
|
|
21934
22260
|
/** Rotessa config. */
|
|
21935
22261
|
Rotessa: usersComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -23009,17 +23335,13 @@ export interface usersComponents {
|
|
|
23009
23335
|
updatedTime?: usersComponents["schemas"]["UpdatedTime"];
|
|
23010
23336
|
};
|
|
23011
23337
|
Product: usersComponents["schemas"]["CommonProduct"] & {
|
|
23012
|
-
/**
|
|
23013
|
-
|
|
23014
|
-
|
|
23015
|
-
|
|
23016
|
-
|
|
23017
|
-
|
|
23018
|
-
|
|
23019
|
-
| "51010"
|
|
23020
|
-
| "31000"
|
|
23021
|
-
| "30070";
|
|
23022
|
-
/** 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. */
|
|
23023
23345
|
accountingCode?: string;
|
|
23024
23346
|
/** The links related to resource. */
|
|
23025
23347
|
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
@@ -23142,23 +23464,15 @@ export interface usersComponents {
|
|
|
23142
23464
|
maxQuantity?: number;
|
|
23143
23465
|
}[];
|
|
23144
23466
|
};
|
|
23145
|
-
PlanPeriod: {
|
|
23146
|
-
/** The unit of time. */
|
|
23147
|
-
unit: "day" | "week" | "month" | "year";
|
|
23148
|
-
/** The length of time. */
|
|
23149
|
-
length: number;
|
|
23150
|
-
};
|
|
23151
|
-
/**
|
|
23152
|
-
* The billing timing in relation to the service period.
|
|
23153
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
23154
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
23155
|
-
*/
|
|
23156
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
23157
23467
|
CommonPlan: {
|
|
23158
23468
|
/** The plan ID. */
|
|
23159
23469
|
id?: usersComponents["schemas"]["ResourceId"];
|
|
23160
23470
|
/** The plan name, displayed on invoices and receipts. */
|
|
23161
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;
|
|
23162
23476
|
/** The related product ID. */
|
|
23163
23477
|
productId: usersComponents["schemas"]["ResourceId"];
|
|
23164
23478
|
/** Name-value pairs to specify the product options. */
|
|
@@ -23167,31 +23481,14 @@ export interface usersComponents {
|
|
|
23167
23481
|
/** Currency sign. */
|
|
23168
23482
|
currencySign?: string;
|
|
23169
23483
|
pricing: usersComponents["schemas"]["PlanPriceFormula"];
|
|
23170
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
23171
|
-
recurringInterval?: usersComponents["schemas"]["PlanPeriod"] & {
|
|
23172
|
-
/**
|
|
23173
|
-
* The number of invoices this subscription order will generate
|
|
23174
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
23175
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
23176
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
23177
|
-
*/
|
|
23178
|
-
limit?: number;
|
|
23179
|
-
billingTiming?: usersComponents["schemas"]["PlanBillingTiming"];
|
|
23180
|
-
};
|
|
23181
|
-
/** The trial. Set `null` if no trial. */
|
|
23182
|
-
trial?: {
|
|
23183
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
23184
|
-
price: number;
|
|
23185
|
-
period: usersComponents["schemas"]["PlanPeriod"];
|
|
23186
|
-
};
|
|
23187
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
23188
|
-
isTrialOnly?: boolean;
|
|
23189
23484
|
/** The setup. Set `null` if no setup. */
|
|
23190
23485
|
setup?: {
|
|
23191
23486
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
23192
23487
|
price: number;
|
|
23193
23488
|
};
|
|
23194
23489
|
customFields?: usersComponents["schemas"]["ResourceCustomFields"];
|
|
23490
|
+
/** Specifies whether a plan is active. */
|
|
23491
|
+
isActive?: boolean;
|
|
23195
23492
|
/**
|
|
23196
23493
|
* Increments when the plan is modified.
|
|
23197
23494
|
* Compare to materialized subscription items revision.
|
|
@@ -23200,7 +23497,24 @@ export interface usersComponents {
|
|
|
23200
23497
|
/** Plan created time. */
|
|
23201
23498
|
createdTime?: usersComponents["schemas"]["ServerTimestamp"];
|
|
23202
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"][];
|
|
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;
|
|
23203
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";
|
|
23204
23518
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
23205
23519
|
TimePluralUnit:
|
|
23206
23520
|
| "seconds"
|
|
@@ -23248,12 +23562,53 @@ export interface usersComponents {
|
|
|
23248
23562
|
issueTimeShift?: usersComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
23249
23563
|
dueTimeShift?: usersComponents["schemas"]["DueTimeShiftInstruction"];
|
|
23250
23564
|
};
|
|
23251
|
-
|
|
23252
|
-
/**
|
|
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
|
+
*/
|
|
23253
23590
|
invoiceTimeShift?: usersComponents["schemas"]["InvoiceTimeShift"];
|
|
23254
|
-
/** The links related to resource. */
|
|
23255
|
-
_links?: usersComponents["schemas"]["SelfLink"][];
|
|
23256
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
|
+
*/
|
|
23606
|
+
invoiceTimeShift?: usersComponents["schemas"]["InvoiceTimeShift"];
|
|
23607
|
+
};
|
|
23608
|
+
Plan:
|
|
23609
|
+
| usersComponents["schemas"]["OneTimeSalePlan"]
|
|
23610
|
+
| usersComponents["schemas"]["SubscriptionOrderPlan"]
|
|
23611
|
+
| usersComponents["schemas"]["TrialOnlyPlan"];
|
|
23257
23612
|
/** Plan object. */
|
|
23258
23613
|
PlanEmbed: {
|
|
23259
23614
|
plan?: usersComponents["schemas"]["Plan"];
|
|
@@ -23822,6 +24177,7 @@ export interface usersComponents {
|
|
|
23822
24177
|
| "CASHlib"
|
|
23823
24178
|
| "CashToCode"
|
|
23824
24179
|
| "China UnionPay"
|
|
24180
|
+
| "Cleo"
|
|
23825
24181
|
| "CODVoucher"
|
|
23826
24182
|
| "Conekta-oxxo"
|
|
23827
24183
|
| "Cupon-de-pagos"
|
|
@@ -25586,7 +25942,7 @@ export interface usersComponents {
|
|
|
25586
25942
|
SendTestEmail: usersComponents["schemas"]["RulesEmailNotification"];
|
|
25587
25943
|
/** Trigger a test webhook. */
|
|
25588
25944
|
SendPreviewWebhook: usersComponents["schemas"]["Webhook"];
|
|
25589
|
-
/** Rebilly
|
|
25945
|
+
/** Rebilly webhook event type. */
|
|
25590
25946
|
GlobalWebhookEventType:
|
|
25591
25947
|
| "aml-list-possibly-matched"
|
|
25592
25948
|
| "application-instance-disabled"
|
|
@@ -25828,9 +26184,9 @@ export interface usersComponents {
|
|
|
25828
26184
|
description?: string;
|
|
25829
26185
|
acl: usersComponents["schemas"]["Acl"];
|
|
25830
26186
|
allowedIps?: usersComponents["schemas"]["AllowedIps"];
|
|
25831
|
-
/** The list of senior roles
|
|
26187
|
+
/** The list of senior roles identifiers. */
|
|
25832
26188
|
seniorIds?: string[];
|
|
25833
|
-
/** The list of junior roles
|
|
26189
|
+
/** The list of junior roles identifiers. */
|
|
25834
26190
|
juniorIds?: string[];
|
|
25835
26191
|
/** The number of users with this role assigned. */
|
|
25836
26192
|
usersCount?: number;
|
|
@@ -26288,11 +26644,17 @@ export interface usersComponents {
|
|
|
26288
26644
|
};
|
|
26289
26645
|
};
|
|
26290
26646
|
headers: {
|
|
26291
|
-
/** Total items
|
|
26647
|
+
/** Total number of items. */
|
|
26292
26648
|
"Pagination-Total"?: number;
|
|
26293
|
-
/**
|
|
26649
|
+
/** Maximum number of items per page. */
|
|
26294
26650
|
"Pagination-Limit"?: number;
|
|
26295
|
-
/**
|
|
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
|
+
*/
|
|
26296
26658
|
"Pagination-Offset"?: number;
|
|
26297
26659
|
/** The location of the related resource. */
|
|
26298
26660
|
Location?: string;
|
|
@@ -31366,19 +31728,22 @@ export interface storefrontPaths {
|
|
|
31366
31728
|
|
|
31367
31729
|
export interface storefrontComponents {
|
|
31368
31730
|
schemas: {
|
|
31369
|
-
/**
|
|
31731
|
+
/** ISO 3166 alpha-2 country code. For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/). */
|
|
31370
31732
|
Country: string;
|
|
31371
31733
|
SelfLink: {
|
|
31372
|
-
/**
|
|
31734
|
+
/** Type of link. */
|
|
31373
31735
|
rel: "self";
|
|
31374
|
-
/**
|
|
31736
|
+
/** Link URL. */
|
|
31375
31737
|
href: string;
|
|
31376
31738
|
};
|
|
31377
|
-
/**
|
|
31739
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
31378
31740
|
ResourceId: string;
|
|
31379
|
-
/** Read-only timestamp
|
|
31741
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
31380
31742
|
ServerTimestamp: string;
|
|
31381
|
-
/**
|
|
31743
|
+
/**
|
|
31744
|
+
* Read-only timestamp. This value updates when the resource
|
|
31745
|
+
* is updated.
|
|
31746
|
+
*/
|
|
31382
31747
|
UpdatedTime: string;
|
|
31383
31748
|
Link: {
|
|
31384
31749
|
/** The link URL. */
|
|
@@ -31421,17 +31786,17 @@ export interface storefrontComponents {
|
|
|
31421
31786
|
/** The HTTP status code. */
|
|
31422
31787
|
status?: number;
|
|
31423
31788
|
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
31424
|
-
/**
|
|
31789
|
+
/** Customer resource ID. Defaults to UUID v4. */
|
|
31425
31790
|
CustomerId: string;
|
|
31426
31791
|
CustomerLink: storefrontComponents["schemas"]["Link"] & {
|
|
31427
|
-
/**
|
|
31792
|
+
/** Type of link. */
|
|
31428
31793
|
rel: "customer" | "targetCustomer";
|
|
31429
31794
|
};
|
|
31430
|
-
/** ISO 4217
|
|
31795
|
+
/** ISO 4217 currency code. */
|
|
31431
31796
|
CurrencyCode: string;
|
|
31432
31797
|
/** The context in which the discount applies. */
|
|
31433
31798
|
DiscountContext: "items" | "shipping" | "items-and-shipping";
|
|
31434
|
-
/**
|
|
31799
|
+
/** Payment method. */
|
|
31435
31800
|
PaymentMethod:
|
|
31436
31801
|
| "payment-card"
|
|
31437
31802
|
| "ach"
|
|
@@ -31470,6 +31835,7 @@ export interface storefrontComponents {
|
|
|
31470
31835
|
| "CashToCode"
|
|
31471
31836
|
| "CCAvenue"
|
|
31472
31837
|
| "China UnionPay"
|
|
31838
|
+
| "Cleo"
|
|
31473
31839
|
| "CODVoucher"
|
|
31474
31840
|
| "Conekta-oxxo"
|
|
31475
31841
|
| "Conekta-spei"
|
|
@@ -31599,80 +31965,119 @@ export interface storefrontComponents {
|
|
|
31599
31965
|
| "Yandex-money"
|
|
31600
31966
|
| "Zotapay"
|
|
31601
31967
|
| "Zimpler";
|
|
31602
|
-
/**
|
|
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
|
+
*/
|
|
31603
31973
|
ResourceCustomFields: { [key: string]: any };
|
|
31604
|
-
/**
|
|
31974
|
+
/** List of phone numbers associated with the contact. */
|
|
31605
31975
|
ContactPhoneNumbers: {
|
|
31606
|
-
/**
|
|
31976
|
+
/** Phone number label or name. */
|
|
31607
31977
|
label: string;
|
|
31608
|
-
/**
|
|
31978
|
+
/** Phone number value. */
|
|
31609
31979
|
value: string;
|
|
31610
|
-
/**
|
|
31980
|
+
/**
|
|
31981
|
+
* Specifies whether the phone number is the contact's
|
|
31982
|
+
* primary phone number.
|
|
31983
|
+
*/
|
|
31611
31984
|
primary?: boolean;
|
|
31612
31985
|
}[];
|
|
31613
|
-
/**
|
|
31986
|
+
/** List of email addresses associated with the contact. */
|
|
31614
31987
|
ContactEmails: {
|
|
31615
|
-
/**
|
|
31988
|
+
/** Email label or name. */
|
|
31616
31989
|
label: string;
|
|
31617
|
-
/**
|
|
31990
|
+
/** Email address value. */
|
|
31618
31991
|
value: string;
|
|
31619
|
-
/**
|
|
31992
|
+
/**
|
|
31993
|
+
* Specifies whether the email address is the contact's
|
|
31994
|
+
* primary email address.
|
|
31995
|
+
*/
|
|
31620
31996
|
primary?: boolean;
|
|
31621
31997
|
}[];
|
|
31622
31998
|
ContactObject: {
|
|
31623
|
-
/**
|
|
31999
|
+
/** Contact's first name. */
|
|
31624
32000
|
firstName?: string | null;
|
|
31625
|
-
/**
|
|
32001
|
+
/** Contact's last name. */
|
|
31626
32002
|
lastName?: string | null;
|
|
31627
|
-
/** The contact organization. */
|
|
32003
|
+
/** The contact's organization. */
|
|
31628
32004
|
organization?: string | null;
|
|
31629
|
-
/**
|
|
32005
|
+
/** First line of the contact's street address. */
|
|
31630
32006
|
address?: string | null;
|
|
31631
|
-
/**
|
|
32007
|
+
/** Second line of the contact's street address. */
|
|
31632
32008
|
address2?: string | null;
|
|
31633
|
-
/**
|
|
32009
|
+
/** Contact's city of residence. */
|
|
31634
32010
|
city?: string | null;
|
|
31635
|
-
/**
|
|
32011
|
+
/** Contact's region of residence. */
|
|
31636
32012
|
region?: string | null;
|
|
31637
|
-
/**
|
|
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
|
+
*/
|
|
31638
32018
|
country?: string | null;
|
|
31639
|
-
/**
|
|
32019
|
+
/** Contact's postal code. */
|
|
31640
32020
|
postalCode?: string | null;
|
|
31641
32021
|
phoneNumbers?: storefrontComponents["schemas"]["ContactPhoneNumbers"];
|
|
31642
32022
|
emails?: storefrontComponents["schemas"]["ContactEmails"];
|
|
31643
|
-
/**
|
|
32023
|
+
/** Contact's date of birth in ISO-8601 `YYYY-MM-DD` format. */
|
|
31644
32024
|
dob?: string | null;
|
|
31645
32025
|
/** The contact's job title. */
|
|
31646
32026
|
jobTitle?: string | null;
|
|
31647
|
-
/**
|
|
32027
|
+
/**
|
|
32028
|
+
* Use this value to compare contacts for identical
|
|
32029
|
+
* attribute values.
|
|
32030
|
+
*/
|
|
31648
32031
|
hash?: string;
|
|
31649
32032
|
};
|
|
31650
32033
|
LeadSourceData: {
|
|
31651
|
-
/**
|
|
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
|
+
*/
|
|
31652
32038
|
medium?: string;
|
|
31653
|
-
/**
|
|
32039
|
+
/**
|
|
32040
|
+
* Domain, platform, or channel from which the lead
|
|
32041
|
+
* source originates.
|
|
32042
|
+
*/
|
|
31654
32043
|
source?: string;
|
|
31655
|
-
/**
|
|
32044
|
+
/** Campaign name of the lead source. */
|
|
31656
32045
|
campaign?: string;
|
|
31657
|
-
/**
|
|
32046
|
+
/** Term associated with a lead source. */
|
|
31658
32047
|
term?: string;
|
|
31659
|
-
/**
|
|
32048
|
+
/**
|
|
32049
|
+
* Content contained in the lead source content.
|
|
32050
|
+
* For example, content could be graphics, video, and so on.
|
|
32051
|
+
*/
|
|
31660
32052
|
content?: string;
|
|
31661
|
-
/**
|
|
32053
|
+
/**
|
|
32054
|
+
* Individual or entity that is affilated with the lead
|
|
32055
|
+
* source.
|
|
32056
|
+
*/
|
|
31662
32057
|
affiliate?: string;
|
|
31663
|
-
/**
|
|
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
|
+
*/
|
|
31664
32063
|
subAffiliate?: string;
|
|
31665
|
-
/**
|
|
32064
|
+
/** Name of the sales agent associated with the lead source. */
|
|
31666
32065
|
salesAgent?: string;
|
|
31667
|
-
/**
|
|
32066
|
+
/**
|
|
32067
|
+
* Lead source click ID. This value is passed in the ad
|
|
32068
|
+
* click URL for tracking and campaign attribution.
|
|
32069
|
+
*/
|
|
31668
32070
|
clickId?: string;
|
|
31669
|
-
/**
|
|
32071
|
+
/** URL from which the lead source originates. */
|
|
31670
32072
|
path?: string;
|
|
31671
|
-
/**
|
|
32073
|
+
/**
|
|
32074
|
+
* Lead source
|
|
32075
|
+
* [`referrer` URL](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referer).
|
|
32076
|
+
*/
|
|
31672
32077
|
referrer?: string;
|
|
31673
|
-
/**
|
|
32078
|
+
/** Date and time at which the lead source was created. */
|
|
31674
32079
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
31675
|
-
/**
|
|
32080
|
+
/** Related resource links. */
|
|
31676
32081
|
_links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
|
|
31677
32082
|
Partial<storefrontComponents["schemas"]["CustomerLink"]>)[];
|
|
31678
32083
|
};
|
|
@@ -31722,6 +32127,7 @@ export interface storefrontComponents {
|
|
|
31722
32127
|
| "Circle"
|
|
31723
32128
|
| "Citadel"
|
|
31724
32129
|
| "Clearhaus"
|
|
32130
|
+
| "Cleo"
|
|
31725
32131
|
| "CODVoucher"
|
|
31726
32132
|
| "Coinbase"
|
|
31727
32133
|
| "CoinGate"
|
|
@@ -31786,6 +32192,7 @@ export interface storefrontComponents {
|
|
|
31786
32192
|
| "Moneris"
|
|
31787
32193
|
| "MtaPay"
|
|
31788
32194
|
| "MuchBetter"
|
|
32195
|
+
| "MuchBetterGateway"
|
|
31789
32196
|
| "MyFatoorah"
|
|
31790
32197
|
| "Neosurf"
|
|
31791
32198
|
| "Netbanking"
|
|
@@ -32289,17 +32696,13 @@ export interface storefrontComponents {
|
|
|
32289
32696
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
32290
32697
|
};
|
|
32291
32698
|
Product: storefrontComponents["schemas"]["CommonProduct"] & {
|
|
32292
|
-
/**
|
|
32293
|
-
|
|
32294
|
-
|
|
32295
|
-
|
|
32296
|
-
|
|
32297
|
-
|
|
32298
|
-
|
|
32299
|
-
| "51010"
|
|
32300
|
-
| "31000"
|
|
32301
|
-
| "30070";
|
|
32302
|
-
/** 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. */
|
|
32303
32706
|
accountingCode?: string;
|
|
32304
32707
|
/** The links related to resource. */
|
|
32305
32708
|
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
@@ -32422,23 +32825,15 @@ export interface storefrontComponents {
|
|
|
32422
32825
|
maxQuantity?: number;
|
|
32423
32826
|
}[];
|
|
32424
32827
|
};
|
|
32425
|
-
PlanPeriod: {
|
|
32426
|
-
/** The unit of time. */
|
|
32427
|
-
unit: "day" | "week" | "month" | "year";
|
|
32428
|
-
/** The length of time. */
|
|
32429
|
-
length: number;
|
|
32430
|
-
};
|
|
32431
|
-
/**
|
|
32432
|
-
* The billing timing in relation to the service period.
|
|
32433
|
-
* For `prepaid` plans the customer pays when the service period starts,
|
|
32434
|
-
* whereas, for `postpaid` plans, the customer pays when the service period ends.
|
|
32435
|
-
*/
|
|
32436
|
-
PlanBillingTiming: "prepaid" | "postpaid";
|
|
32437
32828
|
CommonPlan: {
|
|
32438
32829
|
/** The plan ID. */
|
|
32439
32830
|
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
32440
32831
|
/** The plan name, displayed on invoices and receipts. */
|
|
32441
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;
|
|
32442
32837
|
/** The related product ID. */
|
|
32443
32838
|
productId: storefrontComponents["schemas"]["ResourceId"];
|
|
32444
32839
|
/** Name-value pairs to specify the product options. */
|
|
@@ -32447,31 +32842,14 @@ export interface storefrontComponents {
|
|
|
32447
32842
|
/** Currency sign. */
|
|
32448
32843
|
currencySign?: string;
|
|
32449
32844
|
pricing: storefrontComponents["schemas"]["PlanPriceFormula"];
|
|
32450
|
-
/** The service interval. For a one-time item, use `null`. */
|
|
32451
|
-
recurringInterval?: storefrontComponents["schemas"]["PlanPeriod"] & {
|
|
32452
|
-
/**
|
|
32453
|
-
* The number of invoices this subscription order will generate
|
|
32454
|
-
* (if 1, it will not generate any beyond the initial order creation).
|
|
32455
|
-
* For example, set this property to `12`, when the `periodUnit` is month and the
|
|
32456
|
-
* `periodDuration` is 1, for a 1 year contract billed monthly.
|
|
32457
|
-
*/
|
|
32458
|
-
limit?: number;
|
|
32459
|
-
billingTiming?: storefrontComponents["schemas"]["PlanBillingTiming"];
|
|
32460
|
-
};
|
|
32461
|
-
/** The trial. Set `null` if no trial. */
|
|
32462
|
-
trial?: {
|
|
32463
|
-
/** The price of the trial. For a free trial, use `0`. */
|
|
32464
|
-
price: number;
|
|
32465
|
-
period: storefrontComponents["schemas"]["PlanPeriod"];
|
|
32466
|
-
};
|
|
32467
|
-
/** Whether a plan has a trial without recurring instructions. */
|
|
32468
|
-
isTrialOnly?: boolean;
|
|
32469
32845
|
/** The setup. Set `null` if no setup. */
|
|
32470
32846
|
setup?: {
|
|
32471
32847
|
/** The price of a setup - 0 is a valid value (for free). */
|
|
32472
32848
|
price: number;
|
|
32473
32849
|
};
|
|
32474
32850
|
customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
|
|
32851
|
+
/** Specifies whether a plan is active. */
|
|
32852
|
+
isActive?: boolean;
|
|
32475
32853
|
/**
|
|
32476
32854
|
* Increments when the plan is modified.
|
|
32477
32855
|
* Compare to materialized subscription items revision.
|
|
@@ -32480,7 +32858,24 @@ export interface storefrontComponents {
|
|
|
32480
32858
|
/** Plan created time. */
|
|
32481
32859
|
createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
|
|
32482
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;
|
|
32483
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";
|
|
32484
32879
|
TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
|
|
32485
32880
|
TimePluralUnit:
|
|
32486
32881
|
| "seconds"
|
|
@@ -32528,12 +32923,53 @@ export interface storefrontComponents {
|
|
|
32528
32923
|
issueTimeShift?: storefrontComponents["schemas"]["IssueTimeShiftInstruction"];
|
|
32529
32924
|
dueTimeShift?: storefrontComponents["schemas"]["DueTimeShiftInstruction"];
|
|
32530
32925
|
};
|
|
32531
|
-
|
|
32532
|
-
/**
|
|
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
|
+
*/
|
|
32951
|
+
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
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
|
+
*/
|
|
32533
32967
|
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"];
|
|
32534
|
-
/** The links related to resource. */
|
|
32535
|
-
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
32536
32968
|
};
|
|
32969
|
+
Plan:
|
|
32970
|
+
| storefrontComponents["schemas"]["OneTimeSalePlan"]
|
|
32971
|
+
| storefrontComponents["schemas"]["SubscriptionOrderPlan"]
|
|
32972
|
+
| storefrontComponents["schemas"]["TrialOnlyPlan"];
|
|
32537
32973
|
/** Plan object. */
|
|
32538
32974
|
PlanEmbed: {
|
|
32539
32975
|
plan?: storefrontComponents["schemas"]["Plan"];
|
|
@@ -32879,24 +33315,32 @@ export interface storefrontComponents {
|
|
|
32879
33315
|
isIdentityDocument?: boolean;
|
|
32880
33316
|
/** If there is an exact match found online. */
|
|
32881
33317
|
isPublishedOnline?: boolean;
|
|
33318
|
+
/** Contains urls to matching images found online. */
|
|
33319
|
+
matchingImages?: string[];
|
|
32882
33320
|
/** The customer first name if it was matched, null otherwise. */
|
|
32883
33321
|
firstName?: string | null;
|
|
32884
33322
|
/** The customer last name if it was matched, null otherwise. */
|
|
32885
33323
|
lastName?: string | null;
|
|
32886
33324
|
/** The date of birth found on the document, null if not found. */
|
|
32887
33325
|
dateOfBirth?: string | null;
|
|
32888
|
-
/**
|
|
32889
|
-
expiryDate?: string | null;
|
|
32890
|
-
/** 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. */
|
|
32891
33327
|
expirationDate?: string | null;
|
|
32892
33328
|
/** The issued date found on the document, null if not found. */
|
|
32893
33329
|
issueDate?: string | null;
|
|
32894
33330
|
/** Checks the minimal age, 21+ for USA and 18+ for all other countries. Null if dateOfBirth could not be determined. */
|
|
32895
33331
|
hasMinimalAge?: boolean | null;
|
|
32896
|
-
/**
|
|
33332
|
+
/** Nationality detected on a passport or citizenship document. If a nationality is not detected, this value is null. */
|
|
32897
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;
|
|
32898
33340
|
/** The interpreted subtype of the uploaded document. */
|
|
32899
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;
|
|
32900
33344
|
};
|
|
32901
33345
|
AddressMatches: {
|
|
32902
33346
|
/** The customer first name if it was matched, null otherwise. */
|
|
@@ -32932,6 +33376,32 @@ export interface storefrontComponents {
|
|
|
32932
33376
|
/** The interpreted subtype of the uploaded document. */
|
|
32933
33377
|
documentSubtype?: string | null;
|
|
32934
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
|
+
};
|
|
32935
33405
|
CreditFileMatches: {
|
|
32936
33406
|
/** The credit bureau which is used to get credit file data. */
|
|
32937
33407
|
creditBureau?: "equifax" | "experian" | "transunion" | "test-bureau";
|
|
@@ -32951,7 +33421,24 @@ export interface storefrontComponents {
|
|
|
32951
33421
|
dateOpened?: string;
|
|
32952
33422
|
}[];
|
|
32953
33423
|
/** Extra data from credit bureau. */
|
|
32954
|
-
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
|
+
};
|
|
32955
33442
|
};
|
|
32956
33443
|
CommonPayPalAccount: {
|
|
32957
33444
|
/** ID of the payment instrument. */
|
|
@@ -33026,6 +33513,7 @@ export interface storefrontComponents {
|
|
|
33026
33513
|
| "CASHlib"
|
|
33027
33514
|
| "CashToCode"
|
|
33028
33515
|
| "China UnionPay"
|
|
33516
|
+
| "Cleo"
|
|
33029
33517
|
| "CODVoucher"
|
|
33030
33518
|
| "Conekta-oxxo"
|
|
33031
33519
|
| "Cupon-de-pagos"
|
|
@@ -33346,25 +33834,9 @@ export interface storefrontComponents {
|
|
|
33346
33834
|
/** The ID of plan to use. */
|
|
33347
33835
|
id: storefrontComponents["schemas"]["ResourceId"];
|
|
33348
33836
|
};
|
|
33349
|
-
FlexiblePlan: storefrontComponents["schemas"]["
|
|
33837
|
+
FlexiblePlan: storefrontComponents["schemas"]["Plan"] & {
|
|
33350
33838
|
/** ID of a plan you wish to modify. */
|
|
33351
|
-
id
|
|
33352
|
-
/** Specifies whether a plan is active. */
|
|
33353
|
-
isActive?: boolean;
|
|
33354
|
-
/**
|
|
33355
|
-
* Use invoice time shift to adjust the invoice issue and due date
|
|
33356
|
-
* when billing must occur before the service period changes.
|
|
33357
|
-
* For example, rent must be paid in advance, so the invoice must
|
|
33358
|
-
* be in advance of the billing date. For more information, see
|
|
33359
|
-
* [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).
|
|
33360
|
-
*/
|
|
33361
|
-
invoiceTimeShift?: storefrontComponents["schemas"]["InvoiceTimeShift"] | null;
|
|
33362
|
-
/** Plain-text description of the plan. This field accepts plain-text only. */
|
|
33363
|
-
description?: string;
|
|
33364
|
-
/** Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks. */
|
|
33365
|
-
richDescription?: string;
|
|
33366
|
-
/** Related resource links. */
|
|
33367
|
-
_links?: storefrontComponents["schemas"]["SelfLink"][];
|
|
33839
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
33368
33840
|
};
|
|
33369
33841
|
OrderItem: {
|
|
33370
33842
|
/** The plan identifier string. */
|
|
@@ -34209,11 +34681,17 @@ export interface storefrontComponents {
|
|
|
34209
34681
|
};
|
|
34210
34682
|
};
|
|
34211
34683
|
headers: {
|
|
34212
|
-
/** Total items
|
|
34684
|
+
/** Total number of items. */
|
|
34213
34685
|
"Pagination-Total"?: number;
|
|
34214
|
-
/**
|
|
34686
|
+
/** Maximum number of items per page. */
|
|
34215
34687
|
"Pagination-Limit"?: number;
|
|
34216
|
-
/**
|
|
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
|
+
*/
|
|
34217
34695
|
"Pagination-Offset"?: number;
|
|
34218
34696
|
/** The location of the related resource. */
|
|
34219
34697
|
Location?: string;
|
|
@@ -35326,7 +35804,7 @@ export interface reportsPaths {
|
|
|
35326
35804
|
get: operations["GetRevenueAuditReport"];
|
|
35327
35805
|
};
|
|
35328
35806
|
"/reports/subscription-cancellation": {
|
|
35329
|
-
/** Retrieve
|
|
35807
|
+
/** Retrieve a subscription cancellation report. */
|
|
35330
35808
|
get: operations["GetSubscriptionCancellationReport"];
|
|
35331
35809
|
};
|
|
35332
35810
|
"/reports/subscription-renewal": {
|
|
@@ -35338,7 +35816,7 @@ export interface reportsPaths {
|
|
|
35338
35816
|
get: operations["GetTimeSeriesTransactionReport"];
|
|
35339
35817
|
};
|
|
35340
35818
|
"/reports/transactions-time-dispute": {
|
|
35341
|
-
/** 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. */
|
|
35342
35820
|
get: operations["GetTransactionTimeDisputeReport"];
|
|
35343
35821
|
};
|
|
35344
35822
|
"/reports/transactions": {
|
|
@@ -35359,11 +35837,14 @@ export interface reportsPaths {
|
|
|
35359
35837
|
|
|
35360
35838
|
export interface reportsComponents {
|
|
35361
35839
|
schemas: {
|
|
35362
|
-
/**
|
|
35840
|
+
/** Unique resource ID. Defaults to UUID v4. */
|
|
35363
35841
|
ResourceId: string;
|
|
35364
|
-
/** Read-only timestamp
|
|
35842
|
+
/** Read-only timestamp. This value is automatically assigned on back-end. */
|
|
35365
35843
|
ServerTimestamp: string;
|
|
35366
|
-
/**
|
|
35844
|
+
/**
|
|
35845
|
+
* Read-only timestamp. This value updates when the resource
|
|
35846
|
+
* is updated.
|
|
35847
|
+
*/
|
|
35367
35848
|
UpdatedTime: string;
|
|
35368
35849
|
Link: {
|
|
35369
35850
|
/** The link URL. */
|
|
@@ -35402,7 +35883,7 @@ export interface reportsComponents {
|
|
|
35402
35883
|
/** The HTTP status code. */
|
|
35403
35884
|
status?: number;
|
|
35404
35885
|
} & reportsComponents["schemas"]["BaseProblem"];
|
|
35405
|
-
/** ISO 4217
|
|
35886
|
+
/** ISO 4217 currency code. */
|
|
35406
35887
|
CurrencyCode: string;
|
|
35407
35888
|
KycDocumentTypes:
|
|
35408
35889
|
| "identity-proof"
|
|
@@ -36180,11 +36661,17 @@ export interface reportsComponents {
|
|
|
36180
36661
|
};
|
|
36181
36662
|
};
|
|
36182
36663
|
headers: {
|
|
36183
|
-
/** Total items
|
|
36664
|
+
/** Total number of items. */
|
|
36184
36665
|
"Pagination-Total"?: number;
|
|
36185
|
-
/**
|
|
36666
|
+
/** Maximum number of items per page. */
|
|
36186
36667
|
"Pagination-Limit"?: number;
|
|
36187
|
-
/**
|
|
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
|
+
*/
|
|
36188
36675
|
"Pagination-Offset"?: number;
|
|
36189
36676
|
/** The location of the related resource. */
|
|
36190
36677
|
Location?: string;
|
|
@@ -36387,14 +36874,20 @@ export interface operations {
|
|
|
36387
36874
|
aggregationPeriod: "hour" | "day" | "month";
|
|
36388
36875
|
/** Report metric. */
|
|
36389
36876
|
metric:
|
|
36390
|
-
| "
|
|
36391
|
-
| "
|
|
36392
|
-
| "
|
|
36393
|
-
| "
|
|
36394
|
-
| "
|
|
36395
|
-
| "
|
|
36396
|
-
| "
|
|
36397
|
-
| "
|
|
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";
|
|
36398
36891
|
/**
|
|
36399
36892
|
* The collection items filter requires a special format.
|
|
36400
36893
|
* Use "," for multiple allowed values. Use ";" for multiple fields.
|
|
@@ -36639,7 +37132,7 @@ export interface operations {
|
|
|
36639
37132
|
query: {
|
|
36640
37133
|
/** Report start date. It should be in the future. */
|
|
36641
37134
|
periodStart: string;
|
|
36642
|
-
/** Report end date. */
|
|
37135
|
+
/** Report end date. It should be in the future. */
|
|
36643
37136
|
periodEnd: string;
|
|
36644
37137
|
/** The collection items limit. */
|
|
36645
37138
|
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
@@ -37038,7 +37531,7 @@ export interface operations {
|
|
|
37038
37531
|
403: reportsComponents["responses"]["Forbidden"];
|
|
37039
37532
|
};
|
|
37040
37533
|
};
|
|
37041
|
-
/** Retrieve
|
|
37534
|
+
/** Retrieve a subscription cancellation report. */
|
|
37042
37535
|
GetSubscriptionCancellationReport: {
|
|
37043
37536
|
parameters: {
|
|
37044
37537
|
query: {
|
|
@@ -37148,7 +37641,7 @@ export interface operations {
|
|
|
37148
37641
|
403: reportsComponents["responses"]["Forbidden"];
|
|
37149
37642
|
};
|
|
37150
37643
|
};
|
|
37151
|
-
/** 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. */
|
|
37152
37645
|
GetTransactionTimeDisputeReport: {
|
|
37153
37646
|
parameters: {
|
|
37154
37647
|
query: {
|
|
@@ -37266,10 +37759,6 @@ export interface operations {
|
|
|
37266
37759
|
|
|
37267
37760
|
}
|
|
37268
37761
|
|
|
37269
|
-
declare module "universal-axios" {
|
|
37270
|
-
export default axios;
|
|
37271
|
-
import axios from "axios";
|
|
37272
|
-
}
|
|
37273
37762
|
declare module "deep-freeze" {
|
|
37274
37763
|
export default function deepFreeze(obj: any, { exclude }?: {
|
|
37275
37764
|
exclude: any[];
|
|
@@ -38224,7 +38713,7 @@ declare module "resources/files-resource" {
|
|
|
38224
38713
|
name?: string;
|
|
38225
38714
|
extension?: string;
|
|
38226
38715
|
description?: string;
|
|
38227
|
-
sourceType?: "camera" | "upload";
|
|
38716
|
+
sourceType?: "camera" | "upload" | "organization-export" | "organization-closure-export";
|
|
38228
38717
|
tags?: string[];
|
|
38229
38718
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
38230
38719
|
size?: number;
|
|
@@ -39933,7 +40422,7 @@ declare module "resources/api-instance" {
|
|
|
39933
40422
|
name?: string;
|
|
39934
40423
|
extension?: string;
|
|
39935
40424
|
description?: string;
|
|
39936
|
-
sourceType?: "camera" | "upload";
|
|
40425
|
+
sourceType?: "camera" | "upload" | "organization-export" | "organization-closure-export";
|
|
39937
40426
|
tags?: string[];
|
|
39938
40427
|
mime?: "image/png" | "image/jpeg" | "image/gif" | "application/pdf" | "audio/mpeg";
|
|
39939
40428
|
size?: number;
|