rebilly-js-sdk 62.110.2 → 62.112.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -2,7 +2,26 @@ declare namespace rebilly {
|
|
|
2
2
|
type Expandable<T> = Partial<T> & { expand?: string };
|
|
3
3
|
|
|
4
4
|
//**JS-SDK types generated with Rebilly custom scripts (from-schema-to-sdk-types)**
|
|
5
|
-
type
|
|
5
|
+
type GetAccountRegistrationSettingsCollectionRequest = operations['GetAccountRegistrationSettingsCollection']['parameters']["query"] & (operations['GetAccountRegistrationSettingsCollection']['parameters'] extends {path: {}} ? operations['GetAccountRegistrationSettingsCollection']['parameters']["path"] : {})
|
|
6
|
+
|
|
7
|
+
type GetAccountRegistrationSettingsCollectionResponse = operations['GetAccountRegistrationSettingsCollection']['responses']['200']['content']['application/json'][0]
|
|
8
|
+
type GetAccountRegistrationSettingsCollectionResponsePromise = Promise<{ items: {fields: GetAccountRegistrationSettingsCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
9
|
+
type PostAccountRegistrationSettingsRequest = operations['PostAccountRegistrationSettings']['requestBody']['content']['application/json']
|
|
10
|
+
type CreateAccountRegistrationSettingsRequest = { id?: string, data: PostAccountRegistrationSettingsRequest, expand?: string }
|
|
11
|
+
type PostAccountRegistrationSettingsResponse = operations['PostAccountRegistrationSettings']['responses']['201']['content']['application/json']
|
|
12
|
+
type PostAccountRegistrationSettingsResponsePromise = Promise<{fields: PostAccountRegistrationSettingsResponse}>
|
|
13
|
+
|
|
14
|
+
type GetAccountRegistrationSettingsRequest = { id: string }
|
|
15
|
+
|
|
16
|
+
type GetAccountRegistrationSettingsResponse = operations['GetAccountRegistrationSettings']['responses']['200']['content']['application/json']
|
|
17
|
+
type GetAccountRegistrationSettingsResponsePromise = Promise<{fields: GetAccountRegistrationSettingsResponse}>
|
|
18
|
+
type PutAccountRegistrationSettingsRequest = operations['PutAccountRegistrationSettings']['requestBody']['content']['application/json']
|
|
19
|
+
type PutAccountRegistrationSettingsResponse = operations['PutAccountRegistrationSettings']['responses']['201']['content']['application/json']
|
|
20
|
+
type PutAccountRegistrationSettingsResponsePromise = Promise<{fields: PutAccountRegistrationSettingsResponse}>
|
|
21
|
+
type DeleteAccountRegistrationSettingsResponse = operations['DeleteAccountRegistrationSettings']['responses']['204']
|
|
22
|
+
type DeleteAccountRegistrationSettingsResponsePromise = Promise<{fields: DeleteAccountRegistrationSettingsResponse}>
|
|
23
|
+
|
|
24
|
+
type GetAmlCheckCollectionRequest = operations['GetAmlCheckCollection']['parameters']["query"] & (operations['GetAmlCheckCollection']['parameters'] extends {path: {}} ? operations['GetAmlCheckCollection']['parameters']["path"] : {})
|
|
6
25
|
|
|
7
26
|
type GetAmlCheckCollectionResponse = operations['GetAmlCheckCollection']['responses']['200']['content']['application/json'][0]
|
|
8
27
|
type GetAmlCheckCollectionResponsePromise = Promise<{ items: {fields: GetAmlCheckCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
@@ -2484,6 +2503,29 @@ declare namespace rebilly {
|
|
|
2484
2503
|
*/
|
|
2485
2504
|
|
|
2486
2505
|
export interface corePaths {
|
|
2506
|
+
"/account-registration-settings": {
|
|
2507
|
+
/** Retrieves a list of all account registration settings. */
|
|
2508
|
+
get: operations["GetAccountRegistrationSettingsCollection"];
|
|
2509
|
+
/** Creates a new account registration settings resource. */
|
|
2510
|
+
post: operations["PostAccountRegistrationSettings"];
|
|
2511
|
+
};
|
|
2512
|
+
"/account-registration-settings/{id}": {
|
|
2513
|
+
/** Retrieves account registration settings with a specified ID. */
|
|
2514
|
+
get: operations["GetAccountRegistrationSettings"];
|
|
2515
|
+
/** Creates or updates account registration settings with a specified ID. */
|
|
2516
|
+
put: operations["PutAccountRegistrationSettings"];
|
|
2517
|
+
/**
|
|
2518
|
+
* Deletes account registration settings with a specified ID.
|
|
2519
|
+
* Default account registration settings cannot be deleted.
|
|
2520
|
+
*/
|
|
2521
|
+
delete: operations["DeleteAccountRegistrationSettings"];
|
|
2522
|
+
parameters: {
|
|
2523
|
+
path: {
|
|
2524
|
+
/** ID of the resource. */
|
|
2525
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
2526
|
+
};
|
|
2527
|
+
};
|
|
2528
|
+
};
|
|
2487
2529
|
"/aml-checks": {
|
|
2488
2530
|
/**
|
|
2489
2531
|
* Retrieves a list of AML checks.
|
|
@@ -5817,6 +5859,74 @@ export interface corePaths {
|
|
|
5817
5859
|
|
|
5818
5860
|
export interface coreComponents {
|
|
5819
5861
|
schemas: {
|
|
5862
|
+
RegistrationFieldStep: {
|
|
5863
|
+
/**
|
|
5864
|
+
* ID of the registration step.
|
|
5865
|
+
* This value must start with `step-` followed by lowercase alphanumeric characters or hyphens.
|
|
5866
|
+
*/
|
|
5867
|
+
id: string;
|
|
5868
|
+
/** Display header of the registration step. */
|
|
5869
|
+
displayHeader: string;
|
|
5870
|
+
};
|
|
5871
|
+
RegistrationField: {
|
|
5872
|
+
/**
|
|
5873
|
+
* Attribute of the Keycloak user profile.
|
|
5874
|
+
* This value determines which user attribute the field maps to.
|
|
5875
|
+
*/
|
|
5876
|
+
attribute:
|
|
5877
|
+
| "username"
|
|
5878
|
+
| "firstName"
|
|
5879
|
+
| "lastName"
|
|
5880
|
+
| "email"
|
|
5881
|
+
| "gender"
|
|
5882
|
+
| "dateOfBirth"
|
|
5883
|
+
| "addressLine1"
|
|
5884
|
+
| "addressLine2"
|
|
5885
|
+
| "city"
|
|
5886
|
+
| "postalCode"
|
|
5887
|
+
| "country"
|
|
5888
|
+
| "province"
|
|
5889
|
+
| "currency"
|
|
5890
|
+
| "mobileNumber"
|
|
5891
|
+
| "industry"
|
|
5892
|
+
| "occupation"
|
|
5893
|
+
| "marketingOptIn"
|
|
5894
|
+
| "termsAccepted"
|
|
5895
|
+
| "passwordStep";
|
|
5896
|
+
/** Display name of the registration field. */
|
|
5897
|
+
displayName: string;
|
|
5898
|
+
/**
|
|
5899
|
+
* Requirement level of the field.
|
|
5900
|
+
* This value determines whether the field is required, optional, or hidden during registration.
|
|
5901
|
+
*/
|
|
5902
|
+
requirementLevel: "required" | "optional" | "hidden";
|
|
5903
|
+
/** Type of validation applied to the field input. */
|
|
5904
|
+
validationType:
|
|
5905
|
+
| "none"
|
|
5906
|
+
| "email"
|
|
5907
|
+
| "phone"
|
|
5908
|
+
| "alphanumeric"
|
|
5909
|
+
| "numeric"
|
|
5910
|
+
| "date"
|
|
5911
|
+
| "url"
|
|
5912
|
+
| "regex"
|
|
5913
|
+
| "password";
|
|
5914
|
+
/**
|
|
5915
|
+
* Custom validation regex pattern for the field.
|
|
5916
|
+
* Only applicable when `validationType` is `regex`.
|
|
5917
|
+
*/
|
|
5918
|
+
validationPattern?: string | null;
|
|
5919
|
+
/** Minimum length of the field value. */
|
|
5920
|
+
minLength?: number | null;
|
|
5921
|
+
/** Maximum length of the field value. */
|
|
5922
|
+
maxLength?: number | null;
|
|
5923
|
+
/** Help text displayed to the user for the field. */
|
|
5924
|
+
helpText?: string | null;
|
|
5925
|
+
/** Display order of the field within a registration step. */
|
|
5926
|
+
order: number;
|
|
5927
|
+
/** Registration step associated with the field. */
|
|
5928
|
+
step: coreComponents["schemas"]["RegistrationFieldStep"];
|
|
5929
|
+
};
|
|
5820
5930
|
/**
|
|
5821
5931
|
* Date and time when the resource is created.
|
|
5822
5932
|
* This value is set automatically when the resource is created.
|
|
@@ -5827,8 +5937,6 @@ export interface coreComponents {
|
|
|
5827
5937
|
* This value is set automatically when the resource is updated.
|
|
5828
5938
|
*/
|
|
5829
5939
|
UpdatedTime: string;
|
|
5830
|
-
/** Unique resource ID. */
|
|
5831
|
-
ResourceId: string;
|
|
5832
5940
|
/** Related links. */
|
|
5833
5941
|
SelfLink: {
|
|
5834
5942
|
/** Link URL. */
|
|
@@ -5836,6 +5944,126 @@ export interface coreComponents {
|
|
|
5836
5944
|
/** Type of link. */
|
|
5837
5945
|
rel?: "self";
|
|
5838
5946
|
}[];
|
|
5947
|
+
/**
|
|
5948
|
+
* Account registration settings define the fields, steps, and validation rules
|
|
5949
|
+
* for a customer registration flow.
|
|
5950
|
+
* Each account registration settings resource is scoped to a set of locations
|
|
5951
|
+
* and is synchronized with a Keycloak realm.
|
|
5952
|
+
*/
|
|
5953
|
+
AccountRegistrationSettings: {
|
|
5954
|
+
/**
|
|
5955
|
+
* ID of the account registration settings.
|
|
5956
|
+
* If not provided, the ID is generated from the name.
|
|
5957
|
+
*/
|
|
5958
|
+
id?: string;
|
|
5959
|
+
/** Name of the account registration settings. */
|
|
5960
|
+
name: string;
|
|
5961
|
+
/** Description of the account registration settings. */
|
|
5962
|
+
description?: string | null;
|
|
5963
|
+
/** Specifies if the account registration settings are active. */
|
|
5964
|
+
isEnabled?: boolean;
|
|
5965
|
+
/**
|
|
5966
|
+
* List of locations that the account registration settings apply to.
|
|
5967
|
+
* Each location consists of a country and an optional region.
|
|
5968
|
+
*/
|
|
5969
|
+
locations?: {
|
|
5970
|
+
/**
|
|
5971
|
+
* Country code of the location.
|
|
5972
|
+
* Use ISO 3166-1 alpha-2 country codes.
|
|
5973
|
+
*/
|
|
5974
|
+
country: string;
|
|
5975
|
+
/**
|
|
5976
|
+
* Region code of the location within the country.
|
|
5977
|
+
* Use ISO 3166-2 subdivision codes without the country prefix.
|
|
5978
|
+
*/
|
|
5979
|
+
region?: string;
|
|
5980
|
+
}[];
|
|
5981
|
+
/** List of registration fields that define the registration form. */
|
|
5982
|
+
fields?: coreComponents["schemas"]["RegistrationField"][];
|
|
5983
|
+
/** Keycloak realm associated with the account registration settings. */
|
|
5984
|
+
realm?: string | null;
|
|
5985
|
+
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
5986
|
+
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
5987
|
+
_links?: coreComponents["schemas"]["SelfLink"];
|
|
5988
|
+
};
|
|
5989
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
5990
|
+
BaseProblem: {
|
|
5991
|
+
/**
|
|
5992
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
5993
|
+
* It should provide human-readable documentation for the problem type.
|
|
5994
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
5995
|
+
*/
|
|
5996
|
+
type?: string;
|
|
5997
|
+
/**
|
|
5998
|
+
* Short, human-readable summary of the problem type.
|
|
5999
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
6000
|
+
*/
|
|
6001
|
+
title?: string;
|
|
6002
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
6003
|
+
detail?: string;
|
|
6004
|
+
/**
|
|
6005
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
6006
|
+
* It may or may not yield further information if dereferenced.
|
|
6007
|
+
*/
|
|
6008
|
+
instance?: string;
|
|
6009
|
+
} & { [key: string]: any };
|
|
6010
|
+
Unauthorized: { [key: string]: any } & {
|
|
6011
|
+
/** HTTP status code. */
|
|
6012
|
+
status?: number;
|
|
6013
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
6014
|
+
Forbidden: { [key: string]: any } & {
|
|
6015
|
+
/** HTTP status code. */
|
|
6016
|
+
status?: number;
|
|
6017
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
6018
|
+
Conflict: { [key: string]: any } & {
|
|
6019
|
+
/** HTTP status code. */
|
|
6020
|
+
status?: number;
|
|
6021
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
6022
|
+
/** Invalid field details. */
|
|
6023
|
+
InvalidFields: {
|
|
6024
|
+
/**
|
|
6025
|
+
* Name of the field.
|
|
6026
|
+
* Dot notation is used for nested object field names.
|
|
6027
|
+
*/
|
|
6028
|
+
field?: string;
|
|
6029
|
+
/** Message field. */
|
|
6030
|
+
message?: string;
|
|
6031
|
+
}[];
|
|
6032
|
+
ValidationError: { [key: string]: any } & {
|
|
6033
|
+
/** HTTP status code. */
|
|
6034
|
+
status?: number;
|
|
6035
|
+
} & coreComponents["schemas"]["BaseProblem"] & {
|
|
6036
|
+
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
6037
|
+
};
|
|
6038
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
6039
|
+
TooManyRequests: {
|
|
6040
|
+
/**
|
|
6041
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
6042
|
+
* It should provide human-readable documentation for the problem type.
|
|
6043
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
6044
|
+
*/
|
|
6045
|
+
type?: string;
|
|
6046
|
+
/**
|
|
6047
|
+
* Short, human-readable summary of the problem type.
|
|
6048
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
6049
|
+
*/
|
|
6050
|
+
title?: string;
|
|
6051
|
+
/** HTTP status code. */
|
|
6052
|
+
status?: number;
|
|
6053
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
6054
|
+
detail?: string;
|
|
6055
|
+
/**
|
|
6056
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
6057
|
+
* It may or may not yield further information if dereferenced.
|
|
6058
|
+
*/
|
|
6059
|
+
instance?: string;
|
|
6060
|
+
} & { [key: string]: any };
|
|
6061
|
+
NotFound: {
|
|
6062
|
+
/** HTTP status code. */
|
|
6063
|
+
status?: number;
|
|
6064
|
+
} & coreComponents["schemas"]["BaseProblem"];
|
|
6065
|
+
/** Unique resource ID. */
|
|
6066
|
+
ResourceId: string;
|
|
5839
6067
|
AML: {
|
|
5840
6068
|
/** First name of the individual, or name of entity. */
|
|
5841
6069
|
firstName?: string;
|
|
@@ -5906,6 +6134,11 @@ export interface coreComponents {
|
|
|
5906
6134
|
* This content varies per list.
|
|
5907
6135
|
*/
|
|
5908
6136
|
comments?: string | null;
|
|
6137
|
+
/** Additional metadata on AML sources, when available. */
|
|
6138
|
+
metadata?: {
|
|
6139
|
+
/** Direct lookup identifier for the LexisNexis WorldCompliance Online Search Tool. */
|
|
6140
|
+
lookupId?: string;
|
|
6141
|
+
} | null;
|
|
5909
6142
|
/** Details of the matching logic and confidence scoring. */
|
|
5910
6143
|
matchDetails?: {
|
|
5911
6144
|
/** List of factors that contributed to the confidence score calculation. */
|
|
@@ -6052,6 +6285,8 @@ export interface coreComponents {
|
|
|
6052
6285
|
| "internal_system_error"
|
|
6053
6286
|
)
|
|
6054
6287
|
| null;
|
|
6288
|
+
/** List of codes that explain the no-match result. */
|
|
6289
|
+
noMatchDetails?: string[];
|
|
6055
6290
|
/** Related links. */
|
|
6056
6291
|
_links?: {
|
|
6057
6292
|
/** Link URL. */
|
|
@@ -6060,78 +6295,6 @@ export interface coreComponents {
|
|
|
6060
6295
|
rel?: "self" | "customer";
|
|
6061
6296
|
}[];
|
|
6062
6297
|
};
|
|
6063
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
6064
|
-
BaseProblem: {
|
|
6065
|
-
/**
|
|
6066
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
6067
|
-
* It should provide human-readable documentation for the problem type.
|
|
6068
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
6069
|
-
*/
|
|
6070
|
-
type?: string;
|
|
6071
|
-
/**
|
|
6072
|
-
* Short, human-readable summary of the problem type.
|
|
6073
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
6074
|
-
*/
|
|
6075
|
-
title?: string;
|
|
6076
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
6077
|
-
detail?: string;
|
|
6078
|
-
/**
|
|
6079
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
6080
|
-
* It may or may not yield further information if dereferenced.
|
|
6081
|
-
*/
|
|
6082
|
-
instance?: string;
|
|
6083
|
-
} & { [key: string]: any };
|
|
6084
|
-
Unauthorized: { [key: string]: any } & {
|
|
6085
|
-
/** HTTP status code. */
|
|
6086
|
-
status?: number;
|
|
6087
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
6088
|
-
Forbidden: { [key: string]: any } & {
|
|
6089
|
-
/** HTTP status code. */
|
|
6090
|
-
status?: number;
|
|
6091
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
6092
|
-
NotFound: {
|
|
6093
|
-
/** HTTP status code. */
|
|
6094
|
-
status?: number;
|
|
6095
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
6096
|
-
/** Invalid field details. */
|
|
6097
|
-
InvalidFields: {
|
|
6098
|
-
/**
|
|
6099
|
-
* Name of the field.
|
|
6100
|
-
* Dot notation is used for nested object field names.
|
|
6101
|
-
*/
|
|
6102
|
-
field?: string;
|
|
6103
|
-
/** Message field. */
|
|
6104
|
-
message?: string;
|
|
6105
|
-
}[];
|
|
6106
|
-
ValidationError: { [key: string]: any } & {
|
|
6107
|
-
/** HTTP status code. */
|
|
6108
|
-
status?: number;
|
|
6109
|
-
} & coreComponents["schemas"]["BaseProblem"] & {
|
|
6110
|
-
invalidFields?: coreComponents["schemas"]["InvalidFields"];
|
|
6111
|
-
};
|
|
6112
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
6113
|
-
TooManyRequests: {
|
|
6114
|
-
/**
|
|
6115
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
6116
|
-
* It should provide human-readable documentation for the problem type.
|
|
6117
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
6118
|
-
*/
|
|
6119
|
-
type?: string;
|
|
6120
|
-
/**
|
|
6121
|
-
* Short, human-readable summary of the problem type.
|
|
6122
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
6123
|
-
*/
|
|
6124
|
-
title?: string;
|
|
6125
|
-
/** HTTP status code. */
|
|
6126
|
-
status?: number;
|
|
6127
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
6128
|
-
detail?: string;
|
|
6129
|
-
/**
|
|
6130
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
6131
|
-
* It may or may not yield further information if dereferenced.
|
|
6132
|
-
*/
|
|
6133
|
-
instance?: string;
|
|
6134
|
-
} & { [key: string]: any };
|
|
6135
6298
|
/** AML check review. */
|
|
6136
6299
|
AmlCheckReview: {
|
|
6137
6300
|
/** Status of the AML check. */
|
|
@@ -6279,10 +6442,6 @@ export interface coreComponents {
|
|
|
6279
6442
|
file?: { [key: string]: any };
|
|
6280
6443
|
};
|
|
6281
6444
|
};
|
|
6282
|
-
Conflict: { [key: string]: any } & {
|
|
6283
|
-
/** HTTP status code. */
|
|
6284
|
-
status?: number;
|
|
6285
|
-
} & coreComponents["schemas"]["BaseProblem"];
|
|
6286
6445
|
AuthenticationOptions: {
|
|
6287
6446
|
/** Allowed password pattern. */
|
|
6288
6447
|
passwordPattern?: string | null;
|
|
@@ -10215,9 +10374,16 @@ export interface coreComponents {
|
|
|
10215
10374
|
* This value may contain alphanumeric characters.
|
|
10216
10375
|
*/
|
|
10217
10376
|
documentNumber?: string | null;
|
|
10218
|
-
/**
|
|
10377
|
+
/**
|
|
10378
|
+
* MRZ sex code (ICAO 9303).
|
|
10379
|
+
* `M`, `F`, or `X`.
|
|
10380
|
+
* Null if not extracted.
|
|
10381
|
+
*/
|
|
10219
10382
|
sex?: string | null;
|
|
10220
|
-
/**
|
|
10383
|
+
/**
|
|
10384
|
+
* MRZ check digits validation.
|
|
10385
|
+
* Null if there is no MRZ, no check data, or a non-standard layout.
|
|
10386
|
+
*/
|
|
10221
10387
|
mrzChecksumValid?: boolean | null;
|
|
10222
10388
|
/** Interpreted subtype of the uploaded document. */
|
|
10223
10389
|
documentSubtype?: coreComponents["schemas"]["KycDocumentSubtypes"];
|
|
@@ -11827,8 +11993,6 @@ export interface coreComponents {
|
|
|
11827
11993
|
* Use this plan for non-recurring, one-time, sales.
|
|
11828
11994
|
*/
|
|
11829
11995
|
OneTimeSalePlan: {
|
|
11830
|
-
/** ID of the plan. */
|
|
11831
|
-
id: string;
|
|
11832
11996
|
/**
|
|
11833
11997
|
* Name of the plan.
|
|
11834
11998
|
* This name is displayed on invoices and receipts.
|
|
@@ -11967,8 +12131,6 @@ export interface coreComponents {
|
|
|
11967
12131
|
* Use this plan for subscriptions or sales that reoccur over a period of time.
|
|
11968
12132
|
*/
|
|
11969
12133
|
SubscriptionPlan: {
|
|
11970
|
-
/** ID of the plan. */
|
|
11971
|
-
id: string;
|
|
11972
12134
|
/**
|
|
11973
12135
|
* Name of the plan.
|
|
11974
12136
|
* This name is displayed on invoices and receipts.
|
|
@@ -12063,8 +12225,6 @@ export interface coreComponents {
|
|
|
12063
12225
|
* Trials may have a reduced fee, or may be free.
|
|
12064
12226
|
*/
|
|
12065
12227
|
TrialOnlyPlan: {
|
|
12066
|
-
/** ID of the plan. */
|
|
12067
|
-
id: string;
|
|
12068
12228
|
/**
|
|
12069
12229
|
* Name of the plan.
|
|
12070
12230
|
* This name is displayed on invoices and receipts.
|
|
@@ -12117,9 +12277,24 @@ export interface coreComponents {
|
|
|
12117
12277
|
rel?: "self" | "attachments";
|
|
12118
12278
|
}[];
|
|
12119
12279
|
};
|
|
12120
|
-
Plan: Partial<
|
|
12121
|
-
|
|
12122
|
-
|
|
12280
|
+
Plan: Partial<
|
|
12281
|
+
{
|
|
12282
|
+
/** ID of the plan. */
|
|
12283
|
+
id: string;
|
|
12284
|
+
} & coreComponents["schemas"]["OneTimeSalePlan"]
|
|
12285
|
+
> &
|
|
12286
|
+
Partial<
|
|
12287
|
+
{
|
|
12288
|
+
/** ID of the plan. */
|
|
12289
|
+
id: string;
|
|
12290
|
+
} & coreComponents["schemas"]["SubscriptionPlan"]
|
|
12291
|
+
> &
|
|
12292
|
+
Partial<
|
|
12293
|
+
{
|
|
12294
|
+
/** ID of the plan. */
|
|
12295
|
+
id: string;
|
|
12296
|
+
} & coreComponents["schemas"]["TrialOnlyPlan"]
|
|
12297
|
+
>;
|
|
12123
12298
|
/**
|
|
12124
12299
|
* Products are the items that your business sells.
|
|
12125
12300
|
* Products include digital goods, services, and physical goods.
|
|
@@ -12177,14 +12352,24 @@ export interface coreComponents {
|
|
|
12177
12352
|
/** ID of the plan. */
|
|
12178
12353
|
id: coreComponents["schemas"]["ResourceId"];
|
|
12179
12354
|
};
|
|
12180
|
-
FlexiblePlan:
|
|
12181
|
-
|
|
12182
|
-
|
|
12183
|
-
|
|
12184
|
-
|
|
12185
|
-
|
|
12186
|
-
|
|
12187
|
-
|
|
12355
|
+
FlexiblePlan: Partial<
|
|
12356
|
+
{
|
|
12357
|
+
/** ID of the plan. */
|
|
12358
|
+
id: string;
|
|
12359
|
+
} & coreComponents["schemas"]["OneTimeSalePlan"]
|
|
12360
|
+
> &
|
|
12361
|
+
Partial<
|
|
12362
|
+
{
|
|
12363
|
+
/** ID of the plan. */
|
|
12364
|
+
id: string;
|
|
12365
|
+
} & coreComponents["schemas"]["SubscriptionPlan"]
|
|
12366
|
+
> &
|
|
12367
|
+
Partial<
|
|
12368
|
+
{
|
|
12369
|
+
/** ID of the plan. */
|
|
12370
|
+
id: string;
|
|
12371
|
+
} & coreComponents["schemas"]["TrialOnlyPlan"]
|
|
12372
|
+
>;
|
|
12188
12373
|
/**
|
|
12189
12374
|
* Specifies the soft and hard usage limit thresholds for an item with a metered billing plan.
|
|
12190
12375
|
* This value is ignored when the plan is not metered.
|
|
@@ -15753,7 +15938,10 @@ export interface coreComponents {
|
|
|
15753
15938
|
* > **Important**: Do not URL encode the filter value.
|
|
15754
15939
|
*/
|
|
15755
15940
|
filter?: string | null;
|
|
15756
|
-
/**
|
|
15941
|
+
/**
|
|
15942
|
+
* Title of the message.
|
|
15943
|
+
* This title displays in reports.
|
|
15944
|
+
*/
|
|
15757
15945
|
title?: string;
|
|
15758
15946
|
/** List of messages. */
|
|
15759
15947
|
messages?: {
|
|
@@ -15815,7 +16003,10 @@ export interface coreComponents {
|
|
|
15815
16003
|
}[];
|
|
15816
16004
|
/** Date and time when the message is scheduled to send. */
|
|
15817
16005
|
startSendingTime?: string;
|
|
15818
|
-
/**
|
|
16006
|
+
/**
|
|
16007
|
+
* Status of the broadcast message.
|
|
16008
|
+
* Setting it to `archived` archives the message, but only if it has already been sent.
|
|
16009
|
+
*/
|
|
15819
16010
|
status?: "draft" | "archived";
|
|
15820
16011
|
};
|
|
15821
16012
|
DepositRequest: {
|
|
@@ -20996,6 +21187,8 @@ export interface coreComponents {
|
|
|
20996
21187
|
destinationTagCustomField?: string;
|
|
20997
21188
|
/** Cryptocurrency of the payout. */
|
|
20998
21189
|
payoutCurrency?: string;
|
|
21190
|
+
/** Cryptocurrency of the merchant account. */
|
|
21191
|
+
accountCurrency?: string;
|
|
20999
21192
|
/** Blockchain network to use for the payout. */
|
|
21000
21193
|
payoutNetwork?: "btc" | "usdt" | "eth" | "xrp";
|
|
21001
21194
|
};
|
|
@@ -22037,6 +22230,10 @@ export interface coreComponents {
|
|
|
22037
22230
|
gatewayAccountId: string;
|
|
22038
22231
|
/** Name of the gateway account to use for processing this allocation. */
|
|
22039
22232
|
gatewayName?: string;
|
|
22233
|
+
/** Payout configuration of the gateway account that processes this allocation. */
|
|
22234
|
+
gatewayPayoutInstruction?:
|
|
22235
|
+
| ("all" | "covered-payout" | "approved-payment" | "none")
|
|
22236
|
+
| null;
|
|
22040
22237
|
/** Amount allocated to this payment instrument. */
|
|
22041
22238
|
amount: number;
|
|
22042
22239
|
/** Currency of the payout request allocation. */
|
|
@@ -22904,7 +23101,7 @@ export interface coreComponents {
|
|
|
22904
23101
|
/** Type of resource to export. */
|
|
22905
23102
|
resource: "customers";
|
|
22906
23103
|
/** Output format of the export. */
|
|
22907
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
23104
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
22908
23105
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
22909
23106
|
/** List of email addresses to notify when an export is completed. */
|
|
22910
23107
|
emailNotification?: string[];
|
|
@@ -22951,7 +23148,7 @@ export interface coreComponents {
|
|
|
22951
23148
|
/** Type of resource to export. */
|
|
22952
23149
|
resource: "subscriptions";
|
|
22953
23150
|
/** Output format of the export. */
|
|
22954
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
23151
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
22955
23152
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
22956
23153
|
/** List of email addresses to notify when an export is completed. */
|
|
22957
23154
|
emailNotification?: string[];
|
|
@@ -22998,7 +23195,7 @@ export interface coreComponents {
|
|
|
22998
23195
|
/** Type of resource to export. */
|
|
22999
23196
|
resource: "transactions";
|
|
23000
23197
|
/** Output format of the export. */
|
|
23001
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
23198
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
23002
23199
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
23003
23200
|
/** List of email addresses to notify when an export is completed. */
|
|
23004
23201
|
emailNotification?: string[];
|
|
@@ -23045,7 +23242,7 @@ export interface coreComponents {
|
|
|
23045
23242
|
/** Type of resource to export. */
|
|
23046
23243
|
resource: "invoices";
|
|
23047
23244
|
/** Output format of the export. */
|
|
23048
|
-
format: "csv" | "json" | "json-api" | "xml" | "pdf";
|
|
23245
|
+
format: "csv" | "json" | "json-api" | "xml" | "pdf" | "detailed-csv";
|
|
23049
23246
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
23050
23247
|
/** List of email addresses to notify when an export is completed. */
|
|
23051
23248
|
emailNotification?: string[];
|
|
@@ -23092,7 +23289,7 @@ export interface coreComponents {
|
|
|
23092
23289
|
/** Type of resource to export. */
|
|
23093
23290
|
resource: "invoiceItems";
|
|
23094
23291
|
/** Output format of the export. */
|
|
23095
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
23292
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
23096
23293
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
23097
23294
|
/** List of email addresses to notify when an export is completed. */
|
|
23098
23295
|
emailNotification?: string[];
|
|
@@ -23139,7 +23336,7 @@ export interface coreComponents {
|
|
|
23139
23336
|
/** Type of resource to export. */
|
|
23140
23337
|
resource: "amlChecks";
|
|
23141
23338
|
/** Output format of the export. */
|
|
23142
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
23339
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
23143
23340
|
arguments?: coreComponents["schemas"]["DataExportArguments"];
|
|
23144
23341
|
/** List of email addresses to notify when an export is completed. */
|
|
23145
23342
|
emailNotification?: string[];
|
|
@@ -26082,7 +26279,10 @@ export interface coreComponents {
|
|
|
26082
26279
|
* Contains only fields that are safe to expose on the Storefront.
|
|
26083
26280
|
*/
|
|
26084
26281
|
referenceData?: {
|
|
26085
|
-
/**
|
|
26282
|
+
/**
|
|
26283
|
+
* Name of the cryptocurrency wallet associated with the payment instrument.
|
|
26284
|
+
* This field is only applicable for cryptocurrency payment instruments.
|
|
26285
|
+
*/
|
|
26086
26286
|
walletName?: string | null;
|
|
26087
26287
|
};
|
|
26088
26288
|
/**
|
|
@@ -26896,10 +27096,10 @@ export interface coreComponents {
|
|
|
26896
27096
|
"application/json": coreComponents["schemas"]["Forbidden"];
|
|
26897
27097
|
};
|
|
26898
27098
|
};
|
|
26899
|
-
/**
|
|
26900
|
-
|
|
27099
|
+
/** Conflict. */
|
|
27100
|
+
Conflict: {
|
|
26901
27101
|
content: {
|
|
26902
|
-
"application/json": coreComponents["schemas"]["
|
|
27102
|
+
"application/json": coreComponents["schemas"]["Conflict"];
|
|
26903
27103
|
};
|
|
26904
27104
|
};
|
|
26905
27105
|
/** Invalid data sent. */
|
|
@@ -26915,10 +27115,10 @@ export interface coreComponents {
|
|
|
26915
27115
|
"application/json": coreComponents["schemas"]["TooManyRequests"];
|
|
26916
27116
|
};
|
|
26917
27117
|
};
|
|
26918
|
-
/**
|
|
26919
|
-
|
|
27118
|
+
/** Resource not found. */
|
|
27119
|
+
NotFound: {
|
|
26920
27120
|
content: {
|
|
26921
|
-
"application/json": coreComponents["schemas"]["
|
|
27121
|
+
"application/json": coreComponents["schemas"]["NotFound"];
|
|
26922
27122
|
};
|
|
26923
27123
|
};
|
|
26924
27124
|
/** Customer. */
|
|
@@ -26946,6 +27146,8 @@ export interface coreComponents {
|
|
|
26946
27146
|
collectionLimit: number;
|
|
26947
27147
|
/** Specifies the starting point within the collection of items to be returned. */
|
|
26948
27148
|
collectionOffset: number;
|
|
27149
|
+
/** ID of the resource. */
|
|
27150
|
+
resourceId: string;
|
|
26949
27151
|
/**
|
|
26950
27152
|
* Sorts and orders the collection of items. To sort in descending
|
|
26951
27153
|
* order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
|
|
@@ -26962,8 +27164,6 @@ export interface coreComponents {
|
|
|
26962
27164
|
collectionFilter: string;
|
|
26963
27165
|
/** Use this field to perform a partial search of text fields. */
|
|
26964
27166
|
collectionQuery: string;
|
|
26965
|
-
/** ID of the resource. */
|
|
26966
|
-
resourceId: string;
|
|
26967
27167
|
/**
|
|
26968
27168
|
* Expands a request to include embedded objects within the `_embedded`
|
|
26969
27169
|
* property of the response. This field accepts a comma-separated list of objects.
|
|
@@ -27098,6 +27298,12 @@ export interface coreComponents {
|
|
|
27098
27298
|
| "transactions";
|
|
27099
27299
|
};
|
|
27100
27300
|
requestBodies: {
|
|
27301
|
+
/** Account registration settings resource. */
|
|
27302
|
+
AccountRegistrationSettings: {
|
|
27303
|
+
content: {
|
|
27304
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"];
|
|
27305
|
+
};
|
|
27306
|
+
};
|
|
27101
27307
|
/** Attachment resource. */
|
|
27102
27308
|
Attachment: {
|
|
27103
27309
|
content: {
|
|
@@ -29136,6 +29342,118 @@ export interface coreComponents {
|
|
|
29136
29342
|
}
|
|
29137
29343
|
|
|
29138
29344
|
export interface operations {
|
|
29345
|
+
/** Retrieves a list of all account registration settings. */
|
|
29346
|
+
GetAccountRegistrationSettingsCollection: {
|
|
29347
|
+
parameters: {
|
|
29348
|
+
query: {
|
|
29349
|
+
/** Limits the number of collection items to be returned. */
|
|
29350
|
+
limit?: coreComponents["parameters"]["collectionLimit"];
|
|
29351
|
+
/** Specifies the starting point within the collection of items to be returned. */
|
|
29352
|
+
offset?: coreComponents["parameters"]["collectionOffset"];
|
|
29353
|
+
};
|
|
29354
|
+
};
|
|
29355
|
+
responses: {
|
|
29356
|
+
/** List of account registration settings retrieved. */
|
|
29357
|
+
200: {
|
|
29358
|
+
headers: {};
|
|
29359
|
+
content: {
|
|
29360
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"][];
|
|
29361
|
+
};
|
|
29362
|
+
};
|
|
29363
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
29364
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
29365
|
+
};
|
|
29366
|
+
};
|
|
29367
|
+
/** Creates a new account registration settings resource. */
|
|
29368
|
+
PostAccountRegistrationSettings: {
|
|
29369
|
+
responses: {
|
|
29370
|
+
/** Account registration settings created. */
|
|
29371
|
+
201: {
|
|
29372
|
+
headers: {};
|
|
29373
|
+
content: {
|
|
29374
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"];
|
|
29375
|
+
};
|
|
29376
|
+
};
|
|
29377
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
29378
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
29379
|
+
409: coreComponents["responses"]["Conflict"];
|
|
29380
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
29381
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
29382
|
+
};
|
|
29383
|
+
requestBody: coreComponents["requestBodies"]["AccountRegistrationSettings"];
|
|
29384
|
+
};
|
|
29385
|
+
/** Retrieves account registration settings with a specified ID. */
|
|
29386
|
+
GetAccountRegistrationSettings: {
|
|
29387
|
+
parameters: {
|
|
29388
|
+
path: {
|
|
29389
|
+
/** ID of the resource. */
|
|
29390
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
29391
|
+
};
|
|
29392
|
+
};
|
|
29393
|
+
responses: {
|
|
29394
|
+
/** Account registration settings retrieved. */
|
|
29395
|
+
200: {
|
|
29396
|
+
content: {
|
|
29397
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"];
|
|
29398
|
+
};
|
|
29399
|
+
};
|
|
29400
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
29401
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
29402
|
+
404: coreComponents["responses"]["NotFound"];
|
|
29403
|
+
};
|
|
29404
|
+
};
|
|
29405
|
+
/** Creates or updates account registration settings with a specified ID. */
|
|
29406
|
+
PutAccountRegistrationSettings: {
|
|
29407
|
+
parameters: {
|
|
29408
|
+
path: {
|
|
29409
|
+
/** ID of the resource. */
|
|
29410
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
29411
|
+
};
|
|
29412
|
+
};
|
|
29413
|
+
responses: {
|
|
29414
|
+
/** Account registration settings updated. */
|
|
29415
|
+
200: {
|
|
29416
|
+
headers: {};
|
|
29417
|
+
content: {
|
|
29418
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"];
|
|
29419
|
+
};
|
|
29420
|
+
};
|
|
29421
|
+
/** Account registration settings created. */
|
|
29422
|
+
201: {
|
|
29423
|
+
headers: {};
|
|
29424
|
+
content: {
|
|
29425
|
+
"application/json": coreComponents["schemas"]["AccountRegistrationSettings"];
|
|
29426
|
+
};
|
|
29427
|
+
};
|
|
29428
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
29429
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
29430
|
+
409: coreComponents["responses"]["Conflict"];
|
|
29431
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
29432
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
29433
|
+
};
|
|
29434
|
+
requestBody: coreComponents["requestBodies"]["AccountRegistrationSettings"];
|
|
29435
|
+
};
|
|
29436
|
+
/**
|
|
29437
|
+
* Deletes account registration settings with a specified ID.
|
|
29438
|
+
* Default account registration settings cannot be deleted.
|
|
29439
|
+
*/
|
|
29440
|
+
DeleteAccountRegistrationSettings: {
|
|
29441
|
+
parameters: {
|
|
29442
|
+
path: {
|
|
29443
|
+
/** ID of the resource. */
|
|
29444
|
+
id: coreComponents["parameters"]["resourceId"];
|
|
29445
|
+
};
|
|
29446
|
+
};
|
|
29447
|
+
responses: {
|
|
29448
|
+
/** Account registration settings deleted. */
|
|
29449
|
+
204: never;
|
|
29450
|
+
401: coreComponents["responses"]["Unauthorized"];
|
|
29451
|
+
403: coreComponents["responses"]["Forbidden"];
|
|
29452
|
+
404: coreComponents["responses"]["NotFound"];
|
|
29453
|
+
409: coreComponents["responses"]["Conflict"];
|
|
29454
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
29455
|
+
};
|
|
29456
|
+
};
|
|
29139
29457
|
/**
|
|
29140
29458
|
* Retrieves a list of AML checks.
|
|
29141
29459
|
* These checks are records of customer data and potentially matching data in AML lists.
|
|
@@ -41088,7 +41406,10 @@ export interface operations {
|
|
|
41088
41406
|
200: {
|
|
41089
41407
|
headers: {};
|
|
41090
41408
|
content: {
|
|
41091
|
-
"application/json": coreComponents["schemas"]["PayoutRequestAllocation"]
|
|
41409
|
+
"application/json": (coreComponents["schemas"]["PayoutRequestAllocation"] & {
|
|
41410
|
+
/** Total approved sales and captures minus approved payouts for the customer, gateway account, and payment instrument, in the allocation currency. */
|
|
41411
|
+
exposureAmount?: number;
|
|
41412
|
+
})[];
|
|
41092
41413
|
};
|
|
41093
41414
|
};
|
|
41094
41415
|
401: coreComponents["responses"]["Unauthorized"];
|
|
@@ -43498,6 +43819,74 @@ export interface storefrontPaths {
|
|
|
43498
43819
|
|
|
43499
43820
|
export interface storefrontComponents {
|
|
43500
43821
|
schemas: {
|
|
43822
|
+
RegistrationFieldStep: {
|
|
43823
|
+
/**
|
|
43824
|
+
* ID of the registration step.
|
|
43825
|
+
* This value must start with `step-` followed by lowercase alphanumeric characters or hyphens.
|
|
43826
|
+
*/
|
|
43827
|
+
id: string;
|
|
43828
|
+
/** Display header of the registration step. */
|
|
43829
|
+
displayHeader: string;
|
|
43830
|
+
};
|
|
43831
|
+
RegistrationField: {
|
|
43832
|
+
/**
|
|
43833
|
+
* Attribute of the Keycloak user profile.
|
|
43834
|
+
* This value determines which user attribute the field maps to.
|
|
43835
|
+
*/
|
|
43836
|
+
attribute:
|
|
43837
|
+
| "username"
|
|
43838
|
+
| "firstName"
|
|
43839
|
+
| "lastName"
|
|
43840
|
+
| "email"
|
|
43841
|
+
| "gender"
|
|
43842
|
+
| "dateOfBirth"
|
|
43843
|
+
| "addressLine1"
|
|
43844
|
+
| "addressLine2"
|
|
43845
|
+
| "city"
|
|
43846
|
+
| "postalCode"
|
|
43847
|
+
| "country"
|
|
43848
|
+
| "province"
|
|
43849
|
+
| "currency"
|
|
43850
|
+
| "mobileNumber"
|
|
43851
|
+
| "industry"
|
|
43852
|
+
| "occupation"
|
|
43853
|
+
| "marketingOptIn"
|
|
43854
|
+
| "termsAccepted"
|
|
43855
|
+
| "passwordStep";
|
|
43856
|
+
/** Display name of the registration field. */
|
|
43857
|
+
displayName: string;
|
|
43858
|
+
/**
|
|
43859
|
+
* Requirement level of the field.
|
|
43860
|
+
* This value determines whether the field is required, optional, or hidden during registration.
|
|
43861
|
+
*/
|
|
43862
|
+
requirementLevel: "required" | "optional" | "hidden";
|
|
43863
|
+
/** Type of validation applied to the field input. */
|
|
43864
|
+
validationType:
|
|
43865
|
+
| "none"
|
|
43866
|
+
| "email"
|
|
43867
|
+
| "phone"
|
|
43868
|
+
| "alphanumeric"
|
|
43869
|
+
| "numeric"
|
|
43870
|
+
| "date"
|
|
43871
|
+
| "url"
|
|
43872
|
+
| "regex"
|
|
43873
|
+
| "password";
|
|
43874
|
+
/**
|
|
43875
|
+
* Custom validation regex pattern for the field.
|
|
43876
|
+
* Only applicable when `validationType` is `regex`.
|
|
43877
|
+
*/
|
|
43878
|
+
validationPattern?: string | null;
|
|
43879
|
+
/** Minimum length of the field value. */
|
|
43880
|
+
minLength?: number | null;
|
|
43881
|
+
/** Maximum length of the field value. */
|
|
43882
|
+
maxLength?: number | null;
|
|
43883
|
+
/** Help text displayed to the user for the field. */
|
|
43884
|
+
helpText?: string | null;
|
|
43885
|
+
/** Display order of the field within a registration step. */
|
|
43886
|
+
order: number;
|
|
43887
|
+
/** Registration step associated with the field. */
|
|
43888
|
+
step: storefrontComponents["schemas"]["RegistrationFieldStep"];
|
|
43889
|
+
};
|
|
43501
43890
|
/**
|
|
43502
43891
|
* Date and time when the resource is created.
|
|
43503
43892
|
* This value is set automatically when the resource is created.
|
|
@@ -43508,8 +43897,6 @@ export interface storefrontComponents {
|
|
|
43508
43897
|
* This value is set automatically when the resource is updated.
|
|
43509
43898
|
*/
|
|
43510
43899
|
UpdatedTime: string;
|
|
43511
|
-
/** Unique resource ID. */
|
|
43512
|
-
ResourceId: string;
|
|
43513
43900
|
/** Related links. */
|
|
43514
43901
|
SelfLink: {
|
|
43515
43902
|
/** Link URL. */
|
|
@@ -43517,6 +43904,126 @@ export interface storefrontComponents {
|
|
|
43517
43904
|
/** Type of link. */
|
|
43518
43905
|
rel?: "self";
|
|
43519
43906
|
}[];
|
|
43907
|
+
/**
|
|
43908
|
+
* Account registration settings define the fields, steps, and validation rules
|
|
43909
|
+
* for a customer registration flow.
|
|
43910
|
+
* Each account registration settings resource is scoped to a set of locations
|
|
43911
|
+
* and is synchronized with a Keycloak realm.
|
|
43912
|
+
*/
|
|
43913
|
+
AccountRegistrationSettings: {
|
|
43914
|
+
/**
|
|
43915
|
+
* ID of the account registration settings.
|
|
43916
|
+
* If not provided, the ID is generated from the name.
|
|
43917
|
+
*/
|
|
43918
|
+
id?: string;
|
|
43919
|
+
/** Name of the account registration settings. */
|
|
43920
|
+
name: string;
|
|
43921
|
+
/** Description of the account registration settings. */
|
|
43922
|
+
description?: string | null;
|
|
43923
|
+
/** Specifies if the account registration settings are active. */
|
|
43924
|
+
isEnabled?: boolean;
|
|
43925
|
+
/**
|
|
43926
|
+
* List of locations that the account registration settings apply to.
|
|
43927
|
+
* Each location consists of a country and an optional region.
|
|
43928
|
+
*/
|
|
43929
|
+
locations?: {
|
|
43930
|
+
/**
|
|
43931
|
+
* Country code of the location.
|
|
43932
|
+
* Use ISO 3166-1 alpha-2 country codes.
|
|
43933
|
+
*/
|
|
43934
|
+
country: string;
|
|
43935
|
+
/**
|
|
43936
|
+
* Region code of the location within the country.
|
|
43937
|
+
* Use ISO 3166-2 subdivision codes without the country prefix.
|
|
43938
|
+
*/
|
|
43939
|
+
region?: string;
|
|
43940
|
+
}[];
|
|
43941
|
+
/** List of registration fields that define the registration form. */
|
|
43942
|
+
fields?: storefrontComponents["schemas"]["RegistrationField"][];
|
|
43943
|
+
/** Keycloak realm associated with the account registration settings. */
|
|
43944
|
+
realm?: string | null;
|
|
43945
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
43946
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
43947
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
43948
|
+
};
|
|
43949
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
43950
|
+
BaseProblem: {
|
|
43951
|
+
/**
|
|
43952
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
43953
|
+
* It should provide human-readable documentation for the problem type.
|
|
43954
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
43955
|
+
*/
|
|
43956
|
+
type?: string;
|
|
43957
|
+
/**
|
|
43958
|
+
* Short, human-readable summary of the problem type.
|
|
43959
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
43960
|
+
*/
|
|
43961
|
+
title?: string;
|
|
43962
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
43963
|
+
detail?: string;
|
|
43964
|
+
/**
|
|
43965
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
43966
|
+
* It may or may not yield further information if dereferenced.
|
|
43967
|
+
*/
|
|
43968
|
+
instance?: string;
|
|
43969
|
+
} & { [key: string]: any };
|
|
43970
|
+
Unauthorized: { [key: string]: any } & {
|
|
43971
|
+
/** HTTP status code. */
|
|
43972
|
+
status?: number;
|
|
43973
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43974
|
+
Forbidden: { [key: string]: any } & {
|
|
43975
|
+
/** HTTP status code. */
|
|
43976
|
+
status?: number;
|
|
43977
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43978
|
+
Conflict: { [key: string]: any } & {
|
|
43979
|
+
/** HTTP status code. */
|
|
43980
|
+
status?: number;
|
|
43981
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43982
|
+
/** Invalid field details. */
|
|
43983
|
+
InvalidFields: {
|
|
43984
|
+
/**
|
|
43985
|
+
* Name of the field.
|
|
43986
|
+
* Dot notation is used for nested object field names.
|
|
43987
|
+
*/
|
|
43988
|
+
field?: string;
|
|
43989
|
+
/** Message field. */
|
|
43990
|
+
message?: string;
|
|
43991
|
+
}[];
|
|
43992
|
+
ValidationError: { [key: string]: any } & {
|
|
43993
|
+
/** HTTP status code. */
|
|
43994
|
+
status?: number;
|
|
43995
|
+
} & storefrontComponents["schemas"]["BaseProblem"] & {
|
|
43996
|
+
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
43997
|
+
};
|
|
43998
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
43999
|
+
TooManyRequests: {
|
|
44000
|
+
/**
|
|
44001
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
44002
|
+
* It should provide human-readable documentation for the problem type.
|
|
44003
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
44004
|
+
*/
|
|
44005
|
+
type?: string;
|
|
44006
|
+
/**
|
|
44007
|
+
* Short, human-readable summary of the problem type.
|
|
44008
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
44009
|
+
*/
|
|
44010
|
+
title?: string;
|
|
44011
|
+
/** HTTP status code. */
|
|
44012
|
+
status?: number;
|
|
44013
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
44014
|
+
detail?: string;
|
|
44015
|
+
/**
|
|
44016
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
44017
|
+
* It may or may not yield further information if dereferenced.
|
|
44018
|
+
*/
|
|
44019
|
+
instance?: string;
|
|
44020
|
+
} & { [key: string]: any };
|
|
44021
|
+
NotFound: {
|
|
44022
|
+
/** HTTP status code. */
|
|
44023
|
+
status?: number;
|
|
44024
|
+
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
44025
|
+
/** Unique resource ID. */
|
|
44026
|
+
ResourceId: string;
|
|
43520
44027
|
AML: {
|
|
43521
44028
|
/** First name of the individual, or name of entity. */
|
|
43522
44029
|
firstName?: string;
|
|
@@ -43587,6 +44094,11 @@ export interface storefrontComponents {
|
|
|
43587
44094
|
* This content varies per list.
|
|
43588
44095
|
*/
|
|
43589
44096
|
comments?: string | null;
|
|
44097
|
+
/** Additional metadata on AML sources, when available. */
|
|
44098
|
+
metadata?: {
|
|
44099
|
+
/** Direct lookup identifier for the LexisNexis WorldCompliance Online Search Tool. */
|
|
44100
|
+
lookupId?: string;
|
|
44101
|
+
} | null;
|
|
43590
44102
|
/** Details of the matching logic and confidence scoring. */
|
|
43591
44103
|
matchDetails?: {
|
|
43592
44104
|
/** List of factors that contributed to the confidence score calculation. */
|
|
@@ -43733,6 +44245,8 @@ export interface storefrontComponents {
|
|
|
43733
44245
|
| "internal_system_error"
|
|
43734
44246
|
)
|
|
43735
44247
|
| null;
|
|
44248
|
+
/** List of codes that explain the no-match result. */
|
|
44249
|
+
noMatchDetails?: string[];
|
|
43736
44250
|
/** Related links. */
|
|
43737
44251
|
_links?: {
|
|
43738
44252
|
/** Link URL. */
|
|
@@ -43741,78 +44255,6 @@ export interface storefrontComponents {
|
|
|
43741
44255
|
rel?: "self" | "customer";
|
|
43742
44256
|
}[];
|
|
43743
44257
|
};
|
|
43744
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
43745
|
-
BaseProblem: {
|
|
43746
|
-
/**
|
|
43747
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
43748
|
-
* It should provide human-readable documentation for the problem type.
|
|
43749
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
43750
|
-
*/
|
|
43751
|
-
type?: string;
|
|
43752
|
-
/**
|
|
43753
|
-
* Short, human-readable summary of the problem type.
|
|
43754
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
43755
|
-
*/
|
|
43756
|
-
title?: string;
|
|
43757
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
43758
|
-
detail?: string;
|
|
43759
|
-
/**
|
|
43760
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
43761
|
-
* It may or may not yield further information if dereferenced.
|
|
43762
|
-
*/
|
|
43763
|
-
instance?: string;
|
|
43764
|
-
} & { [key: string]: any };
|
|
43765
|
-
Unauthorized: { [key: string]: any } & {
|
|
43766
|
-
/** HTTP status code. */
|
|
43767
|
-
status?: number;
|
|
43768
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43769
|
-
Forbidden: { [key: string]: any } & {
|
|
43770
|
-
/** HTTP status code. */
|
|
43771
|
-
status?: number;
|
|
43772
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43773
|
-
NotFound: {
|
|
43774
|
-
/** HTTP status code. */
|
|
43775
|
-
status?: number;
|
|
43776
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43777
|
-
/** Invalid field details. */
|
|
43778
|
-
InvalidFields: {
|
|
43779
|
-
/**
|
|
43780
|
-
* Name of the field.
|
|
43781
|
-
* Dot notation is used for nested object field names.
|
|
43782
|
-
*/
|
|
43783
|
-
field?: string;
|
|
43784
|
-
/** Message field. */
|
|
43785
|
-
message?: string;
|
|
43786
|
-
}[];
|
|
43787
|
-
ValidationError: { [key: string]: any } & {
|
|
43788
|
-
/** HTTP status code. */
|
|
43789
|
-
status?: number;
|
|
43790
|
-
} & storefrontComponents["schemas"]["BaseProblem"] & {
|
|
43791
|
-
invalidFields?: storefrontComponents["schemas"]["InvalidFields"];
|
|
43792
|
-
};
|
|
43793
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
43794
|
-
TooManyRequests: {
|
|
43795
|
-
/**
|
|
43796
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
43797
|
-
* It should provide human-readable documentation for the problem type.
|
|
43798
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
43799
|
-
*/
|
|
43800
|
-
type?: string;
|
|
43801
|
-
/**
|
|
43802
|
-
* Short, human-readable summary of the problem type.
|
|
43803
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
43804
|
-
*/
|
|
43805
|
-
title?: string;
|
|
43806
|
-
/** HTTP status code. */
|
|
43807
|
-
status?: number;
|
|
43808
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
43809
|
-
detail?: string;
|
|
43810
|
-
/**
|
|
43811
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
43812
|
-
* It may or may not yield further information if dereferenced.
|
|
43813
|
-
*/
|
|
43814
|
-
instance?: string;
|
|
43815
|
-
} & { [key: string]: any };
|
|
43816
44258
|
/** AML check review. */
|
|
43817
44259
|
AmlCheckReview: {
|
|
43818
44260
|
/** Status of the AML check. */
|
|
@@ -43960,10 +44402,6 @@ export interface storefrontComponents {
|
|
|
43960
44402
|
file?: { [key: string]: any };
|
|
43961
44403
|
};
|
|
43962
44404
|
};
|
|
43963
|
-
Conflict: { [key: string]: any } & {
|
|
43964
|
-
/** HTTP status code. */
|
|
43965
|
-
status?: number;
|
|
43966
|
-
} & storefrontComponents["schemas"]["BaseProblem"];
|
|
43967
44405
|
AuthenticationOptions: {
|
|
43968
44406
|
/** Allowed password pattern. */
|
|
43969
44407
|
passwordPattern?: string | null;
|
|
@@ -47896,9 +48334,16 @@ export interface storefrontComponents {
|
|
|
47896
48334
|
* This value may contain alphanumeric characters.
|
|
47897
48335
|
*/
|
|
47898
48336
|
documentNumber?: string | null;
|
|
47899
|
-
/**
|
|
48337
|
+
/**
|
|
48338
|
+
* MRZ sex code (ICAO 9303).
|
|
48339
|
+
* `M`, `F`, or `X`.
|
|
48340
|
+
* Null if not extracted.
|
|
48341
|
+
*/
|
|
47900
48342
|
sex?: string | null;
|
|
47901
|
-
/**
|
|
48343
|
+
/**
|
|
48344
|
+
* MRZ check digits validation.
|
|
48345
|
+
* Null if there is no MRZ, no check data, or a non-standard layout.
|
|
48346
|
+
*/
|
|
47902
48347
|
mrzChecksumValid?: boolean | null;
|
|
47903
48348
|
/** Interpreted subtype of the uploaded document. */
|
|
47904
48349
|
documentSubtype?: storefrontComponents["schemas"]["KycDocumentSubtypes"];
|
|
@@ -49508,8 +49953,6 @@ export interface storefrontComponents {
|
|
|
49508
49953
|
* Use this plan for non-recurring, one-time, sales.
|
|
49509
49954
|
*/
|
|
49510
49955
|
OneTimeSalePlan: {
|
|
49511
|
-
/** ID of the plan. */
|
|
49512
|
-
id: string;
|
|
49513
49956
|
/**
|
|
49514
49957
|
* Name of the plan.
|
|
49515
49958
|
* This name is displayed on invoices and receipts.
|
|
@@ -49648,8 +50091,6 @@ export interface storefrontComponents {
|
|
|
49648
50091
|
* Use this plan for subscriptions or sales that reoccur over a period of time.
|
|
49649
50092
|
*/
|
|
49650
50093
|
SubscriptionPlan: {
|
|
49651
|
-
/** ID of the plan. */
|
|
49652
|
-
id: string;
|
|
49653
50094
|
/**
|
|
49654
50095
|
* Name of the plan.
|
|
49655
50096
|
* This name is displayed on invoices and receipts.
|
|
@@ -49744,8 +50185,6 @@ export interface storefrontComponents {
|
|
|
49744
50185
|
* Trials may have a reduced fee, or may be free.
|
|
49745
50186
|
*/
|
|
49746
50187
|
TrialOnlyPlan: {
|
|
49747
|
-
/** ID of the plan. */
|
|
49748
|
-
id: string;
|
|
49749
50188
|
/**
|
|
49750
50189
|
* Name of the plan.
|
|
49751
50190
|
* This name is displayed on invoices and receipts.
|
|
@@ -49798,9 +50237,24 @@ export interface storefrontComponents {
|
|
|
49798
50237
|
rel?: "self" | "attachments";
|
|
49799
50238
|
}[];
|
|
49800
50239
|
};
|
|
49801
|
-
Plan: Partial<
|
|
49802
|
-
|
|
49803
|
-
|
|
50240
|
+
Plan: Partial<
|
|
50241
|
+
{
|
|
50242
|
+
/** ID of the plan. */
|
|
50243
|
+
id: string;
|
|
50244
|
+
} & storefrontComponents["schemas"]["OneTimeSalePlan"]
|
|
50245
|
+
> &
|
|
50246
|
+
Partial<
|
|
50247
|
+
{
|
|
50248
|
+
/** ID of the plan. */
|
|
50249
|
+
id: string;
|
|
50250
|
+
} & storefrontComponents["schemas"]["SubscriptionPlan"]
|
|
50251
|
+
> &
|
|
50252
|
+
Partial<
|
|
50253
|
+
{
|
|
50254
|
+
/** ID of the plan. */
|
|
50255
|
+
id: string;
|
|
50256
|
+
} & storefrontComponents["schemas"]["TrialOnlyPlan"]
|
|
50257
|
+
>;
|
|
49804
50258
|
/**
|
|
49805
50259
|
* Products are the items that your business sells.
|
|
49806
50260
|
* Products include digital goods, services, and physical goods.
|
|
@@ -49858,14 +50312,24 @@ export interface storefrontComponents {
|
|
|
49858
50312
|
/** ID of the plan. */
|
|
49859
50313
|
id: storefrontComponents["schemas"]["ResourceId"];
|
|
49860
50314
|
};
|
|
49861
|
-
FlexiblePlan:
|
|
49862
|
-
|
|
49863
|
-
|
|
49864
|
-
|
|
49865
|
-
|
|
49866
|
-
|
|
49867
|
-
|
|
49868
|
-
|
|
50315
|
+
FlexiblePlan: Partial<
|
|
50316
|
+
{
|
|
50317
|
+
/** ID of the plan. */
|
|
50318
|
+
id: string;
|
|
50319
|
+
} & storefrontComponents["schemas"]["OneTimeSalePlan"]
|
|
50320
|
+
> &
|
|
50321
|
+
Partial<
|
|
50322
|
+
{
|
|
50323
|
+
/** ID of the plan. */
|
|
50324
|
+
id: string;
|
|
50325
|
+
} & storefrontComponents["schemas"]["SubscriptionPlan"]
|
|
50326
|
+
> &
|
|
50327
|
+
Partial<
|
|
50328
|
+
{
|
|
50329
|
+
/** ID of the plan. */
|
|
50330
|
+
id: string;
|
|
50331
|
+
} & storefrontComponents["schemas"]["TrialOnlyPlan"]
|
|
50332
|
+
>;
|
|
49869
50333
|
/**
|
|
49870
50334
|
* Specifies the soft and hard usage limit thresholds for an item with a metered billing plan.
|
|
49871
50335
|
* This value is ignored when the plan is not metered.
|
|
@@ -53434,7 +53898,10 @@ export interface storefrontComponents {
|
|
|
53434
53898
|
* > **Important**: Do not URL encode the filter value.
|
|
53435
53899
|
*/
|
|
53436
53900
|
filter?: string | null;
|
|
53437
|
-
/**
|
|
53901
|
+
/**
|
|
53902
|
+
* Title of the message.
|
|
53903
|
+
* This title displays in reports.
|
|
53904
|
+
*/
|
|
53438
53905
|
title?: string;
|
|
53439
53906
|
/** List of messages. */
|
|
53440
53907
|
messages?: {
|
|
@@ -53496,7 +53963,10 @@ export interface storefrontComponents {
|
|
|
53496
53963
|
}[];
|
|
53497
53964
|
/** Date and time when the message is scheduled to send. */
|
|
53498
53965
|
startSendingTime?: string;
|
|
53499
|
-
/**
|
|
53966
|
+
/**
|
|
53967
|
+
* Status of the broadcast message.
|
|
53968
|
+
* Setting it to `archived` archives the message, but only if it has already been sent.
|
|
53969
|
+
*/
|
|
53500
53970
|
status?: "draft" | "archived";
|
|
53501
53971
|
};
|
|
53502
53972
|
DepositRequest: {
|
|
@@ -58677,6 +59147,8 @@ export interface storefrontComponents {
|
|
|
58677
59147
|
destinationTagCustomField?: string;
|
|
58678
59148
|
/** Cryptocurrency of the payout. */
|
|
58679
59149
|
payoutCurrency?: string;
|
|
59150
|
+
/** Cryptocurrency of the merchant account. */
|
|
59151
|
+
accountCurrency?: string;
|
|
58680
59152
|
/** Blockchain network to use for the payout. */
|
|
58681
59153
|
payoutNetwork?: "btc" | "usdt" | "eth" | "xrp";
|
|
58682
59154
|
};
|
|
@@ -59718,6 +60190,10 @@ export interface storefrontComponents {
|
|
|
59718
60190
|
gatewayAccountId: string;
|
|
59719
60191
|
/** Name of the gateway account to use for processing this allocation. */
|
|
59720
60192
|
gatewayName?: string;
|
|
60193
|
+
/** Payout configuration of the gateway account that processes this allocation. */
|
|
60194
|
+
gatewayPayoutInstruction?:
|
|
60195
|
+
| ("all" | "covered-payout" | "approved-payment" | "none")
|
|
60196
|
+
| null;
|
|
59721
60197
|
/** Amount allocated to this payment instrument. */
|
|
59722
60198
|
amount: number;
|
|
59723
60199
|
/** Currency of the payout request allocation. */
|
|
@@ -60585,7 +61061,7 @@ export interface storefrontComponents {
|
|
|
60585
61061
|
/** Type of resource to export. */
|
|
60586
61062
|
resource: "customers";
|
|
60587
61063
|
/** Output format of the export. */
|
|
60588
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
61064
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
60589
61065
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60590
61066
|
/** List of email addresses to notify when an export is completed. */
|
|
60591
61067
|
emailNotification?: string[];
|
|
@@ -60632,7 +61108,7 @@ export interface storefrontComponents {
|
|
|
60632
61108
|
/** Type of resource to export. */
|
|
60633
61109
|
resource: "subscriptions";
|
|
60634
61110
|
/** Output format of the export. */
|
|
60635
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
61111
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
60636
61112
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60637
61113
|
/** List of email addresses to notify when an export is completed. */
|
|
60638
61114
|
emailNotification?: string[];
|
|
@@ -60679,7 +61155,7 @@ export interface storefrontComponents {
|
|
|
60679
61155
|
/** Type of resource to export. */
|
|
60680
61156
|
resource: "transactions";
|
|
60681
61157
|
/** Output format of the export. */
|
|
60682
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
61158
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
60683
61159
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60684
61160
|
/** List of email addresses to notify when an export is completed. */
|
|
60685
61161
|
emailNotification?: string[];
|
|
@@ -60726,7 +61202,7 @@ export interface storefrontComponents {
|
|
|
60726
61202
|
/** Type of resource to export. */
|
|
60727
61203
|
resource: "invoices";
|
|
60728
61204
|
/** Output format of the export. */
|
|
60729
|
-
format: "csv" | "json" | "json-api" | "xml" | "pdf";
|
|
61205
|
+
format: "csv" | "json" | "json-api" | "xml" | "pdf" | "detailed-csv";
|
|
60730
61206
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60731
61207
|
/** List of email addresses to notify when an export is completed. */
|
|
60732
61208
|
emailNotification?: string[];
|
|
@@ -60773,7 +61249,7 @@ export interface storefrontComponents {
|
|
|
60773
61249
|
/** Type of resource to export. */
|
|
60774
61250
|
resource: "invoiceItems";
|
|
60775
61251
|
/** Output format of the export. */
|
|
60776
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
61252
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
60777
61253
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60778
61254
|
/** List of email addresses to notify when an export is completed. */
|
|
60779
61255
|
emailNotification?: string[];
|
|
@@ -60820,7 +61296,7 @@ export interface storefrontComponents {
|
|
|
60820
61296
|
/** Type of resource to export. */
|
|
60821
61297
|
resource: "amlChecks";
|
|
60822
61298
|
/** Output format of the export. */
|
|
60823
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
61299
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
60824
61300
|
arguments?: storefrontComponents["schemas"]["DataExportArguments"];
|
|
60825
61301
|
/** List of email addresses to notify when an export is completed. */
|
|
60826
61302
|
emailNotification?: string[];
|
|
@@ -63763,7 +64239,10 @@ export interface storefrontComponents {
|
|
|
63763
64239
|
* Contains only fields that are safe to expose on the Storefront.
|
|
63764
64240
|
*/
|
|
63765
64241
|
referenceData?: {
|
|
63766
|
-
/**
|
|
64242
|
+
/**
|
|
64243
|
+
* Name of the cryptocurrency wallet associated with the payment instrument.
|
|
64244
|
+
* This field is only applicable for cryptocurrency payment instruments.
|
|
64245
|
+
*/
|
|
63767
64246
|
walletName?: string | null;
|
|
63768
64247
|
};
|
|
63769
64248
|
/**
|
|
@@ -64577,10 +65056,10 @@ export interface storefrontComponents {
|
|
|
64577
65056
|
"application/json": storefrontComponents["schemas"]["Forbidden"];
|
|
64578
65057
|
};
|
|
64579
65058
|
};
|
|
64580
|
-
/**
|
|
64581
|
-
|
|
65059
|
+
/** Conflict. */
|
|
65060
|
+
Conflict: {
|
|
64582
65061
|
content: {
|
|
64583
|
-
"application/json": storefrontComponents["schemas"]["
|
|
65062
|
+
"application/json": storefrontComponents["schemas"]["Conflict"];
|
|
64584
65063
|
};
|
|
64585
65064
|
};
|
|
64586
65065
|
/** Invalid data sent. */
|
|
@@ -64596,10 +65075,10 @@ export interface storefrontComponents {
|
|
|
64596
65075
|
"application/json": storefrontComponents["schemas"]["TooManyRequests"];
|
|
64597
65076
|
};
|
|
64598
65077
|
};
|
|
64599
|
-
/**
|
|
64600
|
-
|
|
65078
|
+
/** Resource not found. */
|
|
65079
|
+
NotFound: {
|
|
64601
65080
|
content: {
|
|
64602
|
-
"application/json": storefrontComponents["schemas"]["
|
|
65081
|
+
"application/json": storefrontComponents["schemas"]["NotFound"];
|
|
64603
65082
|
};
|
|
64604
65083
|
};
|
|
64605
65084
|
/** Customer. */
|
|
@@ -64627,6 +65106,8 @@ export interface storefrontComponents {
|
|
|
64627
65106
|
collectionLimit: number;
|
|
64628
65107
|
/** Specifies the starting point within the collection of items to be returned. */
|
|
64629
65108
|
collectionOffset: number;
|
|
65109
|
+
/** ID of the resource. */
|
|
65110
|
+
resourceId: string;
|
|
64630
65111
|
/**
|
|
64631
65112
|
* Sorts and orders the collection of items. To sort in descending
|
|
64632
65113
|
* order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
|
|
@@ -64643,8 +65124,6 @@ export interface storefrontComponents {
|
|
|
64643
65124
|
collectionFilter: string;
|
|
64644
65125
|
/** Use this field to perform a partial search of text fields. */
|
|
64645
65126
|
collectionQuery: string;
|
|
64646
|
-
/** ID of the resource. */
|
|
64647
|
-
resourceId: string;
|
|
64648
65127
|
/**
|
|
64649
65128
|
* Expands a request to include embedded objects within the `_embedded`
|
|
64650
65129
|
* property of the response. This field accepts a comma-separated list of objects.
|
|
@@ -64779,6 +65258,12 @@ export interface storefrontComponents {
|
|
|
64779
65258
|
| "transactions";
|
|
64780
65259
|
};
|
|
64781
65260
|
requestBodies: {
|
|
65261
|
+
/** Account registration settings resource. */
|
|
65262
|
+
AccountRegistrationSettings: {
|
|
65263
|
+
content: {
|
|
65264
|
+
"application/json": storefrontComponents["schemas"]["AccountRegistrationSettings"];
|
|
65265
|
+
};
|
|
65266
|
+
};
|
|
64782
65267
|
/** Attachment resource. */
|
|
64783
65268
|
Attachment: {
|
|
64784
65269
|
content: {
|
|
@@ -68840,6 +69325,74 @@ export interface reportsPaths {
|
|
|
68840
69325
|
|
|
68841
69326
|
export interface reportsComponents {
|
|
68842
69327
|
schemas: {
|
|
69328
|
+
RegistrationFieldStep: {
|
|
69329
|
+
/**
|
|
69330
|
+
* ID of the registration step.
|
|
69331
|
+
* This value must start with `step-` followed by lowercase alphanumeric characters or hyphens.
|
|
69332
|
+
*/
|
|
69333
|
+
id: string;
|
|
69334
|
+
/** Display header of the registration step. */
|
|
69335
|
+
displayHeader: string;
|
|
69336
|
+
};
|
|
69337
|
+
RegistrationField: {
|
|
69338
|
+
/**
|
|
69339
|
+
* Attribute of the Keycloak user profile.
|
|
69340
|
+
* This value determines which user attribute the field maps to.
|
|
69341
|
+
*/
|
|
69342
|
+
attribute:
|
|
69343
|
+
| "username"
|
|
69344
|
+
| "firstName"
|
|
69345
|
+
| "lastName"
|
|
69346
|
+
| "email"
|
|
69347
|
+
| "gender"
|
|
69348
|
+
| "dateOfBirth"
|
|
69349
|
+
| "addressLine1"
|
|
69350
|
+
| "addressLine2"
|
|
69351
|
+
| "city"
|
|
69352
|
+
| "postalCode"
|
|
69353
|
+
| "country"
|
|
69354
|
+
| "province"
|
|
69355
|
+
| "currency"
|
|
69356
|
+
| "mobileNumber"
|
|
69357
|
+
| "industry"
|
|
69358
|
+
| "occupation"
|
|
69359
|
+
| "marketingOptIn"
|
|
69360
|
+
| "termsAccepted"
|
|
69361
|
+
| "passwordStep";
|
|
69362
|
+
/** Display name of the registration field. */
|
|
69363
|
+
displayName: string;
|
|
69364
|
+
/**
|
|
69365
|
+
* Requirement level of the field.
|
|
69366
|
+
* This value determines whether the field is required, optional, or hidden during registration.
|
|
69367
|
+
*/
|
|
69368
|
+
requirementLevel: "required" | "optional" | "hidden";
|
|
69369
|
+
/** Type of validation applied to the field input. */
|
|
69370
|
+
validationType:
|
|
69371
|
+
| "none"
|
|
69372
|
+
| "email"
|
|
69373
|
+
| "phone"
|
|
69374
|
+
| "alphanumeric"
|
|
69375
|
+
| "numeric"
|
|
69376
|
+
| "date"
|
|
69377
|
+
| "url"
|
|
69378
|
+
| "regex"
|
|
69379
|
+
| "password";
|
|
69380
|
+
/**
|
|
69381
|
+
* Custom validation regex pattern for the field.
|
|
69382
|
+
* Only applicable when `validationType` is `regex`.
|
|
69383
|
+
*/
|
|
69384
|
+
validationPattern?: string | null;
|
|
69385
|
+
/** Minimum length of the field value. */
|
|
69386
|
+
minLength?: number | null;
|
|
69387
|
+
/** Maximum length of the field value. */
|
|
69388
|
+
maxLength?: number | null;
|
|
69389
|
+
/** Help text displayed to the user for the field. */
|
|
69390
|
+
helpText?: string | null;
|
|
69391
|
+
/** Display order of the field within a registration step. */
|
|
69392
|
+
order: number;
|
|
69393
|
+
/** Registration step associated with the field. */
|
|
69394
|
+
step: reportsComponents["schemas"]["RegistrationFieldStep"];
|
|
69395
|
+
};
|
|
68843
69396
|
/**
|
|
68844
69397
|
* Date and time when the resource is created.
|
|
68845
69398
|
* This value is set automatically when the resource is created.
|
|
@@ -68850,8 +69403,6 @@ export interface reportsComponents {
|
|
|
68850
69403
|
* This value is set automatically when the resource is updated.
|
|
68851
69404
|
*/
|
|
68852
69405
|
UpdatedTime: string;
|
|
68853
|
-
/** Unique resource ID. */
|
|
68854
|
-
ResourceId: string;
|
|
68855
69406
|
/** Related links. */
|
|
68856
69407
|
SelfLink: {
|
|
68857
69408
|
/** Link URL. */
|
|
@@ -68859,6 +69410,126 @@ export interface reportsComponents {
|
|
|
68859
69410
|
/** Type of link. */
|
|
68860
69411
|
rel?: "self";
|
|
68861
69412
|
}[];
|
|
69413
|
+
/**
|
|
69414
|
+
* Account registration settings define the fields, steps, and validation rules
|
|
69415
|
+
* for a customer registration flow.
|
|
69416
|
+
* Each account registration settings resource is scoped to a set of locations
|
|
69417
|
+
* and is synchronized with a Keycloak realm.
|
|
69418
|
+
*/
|
|
69419
|
+
AccountRegistrationSettings: {
|
|
69420
|
+
/**
|
|
69421
|
+
* ID of the account registration settings.
|
|
69422
|
+
* If not provided, the ID is generated from the name.
|
|
69423
|
+
*/
|
|
69424
|
+
id?: string;
|
|
69425
|
+
/** Name of the account registration settings. */
|
|
69426
|
+
name: string;
|
|
69427
|
+
/** Description of the account registration settings. */
|
|
69428
|
+
description?: string | null;
|
|
69429
|
+
/** Specifies if the account registration settings are active. */
|
|
69430
|
+
isEnabled?: boolean;
|
|
69431
|
+
/**
|
|
69432
|
+
* List of locations that the account registration settings apply to.
|
|
69433
|
+
* Each location consists of a country and an optional region.
|
|
69434
|
+
*/
|
|
69435
|
+
locations?: {
|
|
69436
|
+
/**
|
|
69437
|
+
* Country code of the location.
|
|
69438
|
+
* Use ISO 3166-1 alpha-2 country codes.
|
|
69439
|
+
*/
|
|
69440
|
+
country: string;
|
|
69441
|
+
/**
|
|
69442
|
+
* Region code of the location within the country.
|
|
69443
|
+
* Use ISO 3166-2 subdivision codes without the country prefix.
|
|
69444
|
+
*/
|
|
69445
|
+
region?: string;
|
|
69446
|
+
}[];
|
|
69447
|
+
/** List of registration fields that define the registration form. */
|
|
69448
|
+
fields?: reportsComponents["schemas"]["RegistrationField"][];
|
|
69449
|
+
/** Keycloak realm associated with the account registration settings. */
|
|
69450
|
+
realm?: string | null;
|
|
69451
|
+
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
69452
|
+
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
69453
|
+
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
69454
|
+
};
|
|
69455
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
69456
|
+
BaseProblem: {
|
|
69457
|
+
/**
|
|
69458
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
69459
|
+
* It should provide human-readable documentation for the problem type.
|
|
69460
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
69461
|
+
*/
|
|
69462
|
+
type?: string;
|
|
69463
|
+
/**
|
|
69464
|
+
* Short, human-readable summary of the problem type.
|
|
69465
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
69466
|
+
*/
|
|
69467
|
+
title?: string;
|
|
69468
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
69469
|
+
detail?: string;
|
|
69470
|
+
/**
|
|
69471
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
69472
|
+
* It may or may not yield further information if dereferenced.
|
|
69473
|
+
*/
|
|
69474
|
+
instance?: string;
|
|
69475
|
+
} & { [key: string]: any };
|
|
69476
|
+
Unauthorized: { [key: string]: any } & {
|
|
69477
|
+
/** HTTP status code. */
|
|
69478
|
+
status?: number;
|
|
69479
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69480
|
+
Forbidden: { [key: string]: any } & {
|
|
69481
|
+
/** HTTP status code. */
|
|
69482
|
+
status?: number;
|
|
69483
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69484
|
+
Conflict: { [key: string]: any } & {
|
|
69485
|
+
/** HTTP status code. */
|
|
69486
|
+
status?: number;
|
|
69487
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69488
|
+
/** Invalid field details. */
|
|
69489
|
+
InvalidFields: {
|
|
69490
|
+
/**
|
|
69491
|
+
* Name of the field.
|
|
69492
|
+
* Dot notation is used for nested object field names.
|
|
69493
|
+
*/
|
|
69494
|
+
field?: string;
|
|
69495
|
+
/** Message field. */
|
|
69496
|
+
message?: string;
|
|
69497
|
+
}[];
|
|
69498
|
+
ValidationError: { [key: string]: any } & {
|
|
69499
|
+
/** HTTP status code. */
|
|
69500
|
+
status?: number;
|
|
69501
|
+
} & reportsComponents["schemas"]["BaseProblem"] & {
|
|
69502
|
+
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
69503
|
+
};
|
|
69504
|
+
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
69505
|
+
TooManyRequests: {
|
|
69506
|
+
/**
|
|
69507
|
+
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
69508
|
+
* It should provide human-readable documentation for the problem type.
|
|
69509
|
+
* When this member is not present, its value is assumed to be "about:blank".
|
|
69510
|
+
*/
|
|
69511
|
+
type?: string;
|
|
69512
|
+
/**
|
|
69513
|
+
* Short, human-readable summary of the problem type.
|
|
69514
|
+
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
69515
|
+
*/
|
|
69516
|
+
title?: string;
|
|
69517
|
+
/** HTTP status code. */
|
|
69518
|
+
status?: number;
|
|
69519
|
+
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
69520
|
+
detail?: string;
|
|
69521
|
+
/**
|
|
69522
|
+
* URI reference that identifies the specific occurrence of the problem.
|
|
69523
|
+
* It may or may not yield further information if dereferenced.
|
|
69524
|
+
*/
|
|
69525
|
+
instance?: string;
|
|
69526
|
+
} & { [key: string]: any };
|
|
69527
|
+
NotFound: {
|
|
69528
|
+
/** HTTP status code. */
|
|
69529
|
+
status?: number;
|
|
69530
|
+
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69531
|
+
/** Unique resource ID. */
|
|
69532
|
+
ResourceId: string;
|
|
68862
69533
|
AML: {
|
|
68863
69534
|
/** First name of the individual, or name of entity. */
|
|
68864
69535
|
firstName?: string;
|
|
@@ -68929,6 +69600,11 @@ export interface reportsComponents {
|
|
|
68929
69600
|
* This content varies per list.
|
|
68930
69601
|
*/
|
|
68931
69602
|
comments?: string | null;
|
|
69603
|
+
/** Additional metadata on AML sources, when available. */
|
|
69604
|
+
metadata?: {
|
|
69605
|
+
/** Direct lookup identifier for the LexisNexis WorldCompliance Online Search Tool. */
|
|
69606
|
+
lookupId?: string;
|
|
69607
|
+
} | null;
|
|
68932
69608
|
/** Details of the matching logic and confidence scoring. */
|
|
68933
69609
|
matchDetails?: {
|
|
68934
69610
|
/** List of factors that contributed to the confidence score calculation. */
|
|
@@ -69075,6 +69751,8 @@ export interface reportsComponents {
|
|
|
69075
69751
|
| "internal_system_error"
|
|
69076
69752
|
)
|
|
69077
69753
|
| null;
|
|
69754
|
+
/** List of codes that explain the no-match result. */
|
|
69755
|
+
noMatchDetails?: string[];
|
|
69078
69756
|
/** Related links. */
|
|
69079
69757
|
_links?: {
|
|
69080
69758
|
/** Link URL. */
|
|
@@ -69083,78 +69761,6 @@ export interface reportsComponents {
|
|
|
69083
69761
|
rel?: "self" | "customer";
|
|
69084
69762
|
}[];
|
|
69085
69763
|
};
|
|
69086
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
69087
|
-
BaseProblem: {
|
|
69088
|
-
/**
|
|
69089
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
69090
|
-
* It should provide human-readable documentation for the problem type.
|
|
69091
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
69092
|
-
*/
|
|
69093
|
-
type?: string;
|
|
69094
|
-
/**
|
|
69095
|
-
* Short, human-readable summary of the problem type.
|
|
69096
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
69097
|
-
*/
|
|
69098
|
-
title?: string;
|
|
69099
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
69100
|
-
detail?: string;
|
|
69101
|
-
/**
|
|
69102
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
69103
|
-
* It may or may not yield further information if dereferenced.
|
|
69104
|
-
*/
|
|
69105
|
-
instance?: string;
|
|
69106
|
-
} & { [key: string]: any };
|
|
69107
|
-
Unauthorized: { [key: string]: any } & {
|
|
69108
|
-
/** HTTP status code. */
|
|
69109
|
-
status?: number;
|
|
69110
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69111
|
-
Forbidden: { [key: string]: any } & {
|
|
69112
|
-
/** HTTP status code. */
|
|
69113
|
-
status?: number;
|
|
69114
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69115
|
-
NotFound: {
|
|
69116
|
-
/** HTTP status code. */
|
|
69117
|
-
status?: number;
|
|
69118
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69119
|
-
/** Invalid field details. */
|
|
69120
|
-
InvalidFields: {
|
|
69121
|
-
/**
|
|
69122
|
-
* Name of the field.
|
|
69123
|
-
* Dot notation is used for nested object field names.
|
|
69124
|
-
*/
|
|
69125
|
-
field?: string;
|
|
69126
|
-
/** Message field. */
|
|
69127
|
-
message?: string;
|
|
69128
|
-
}[];
|
|
69129
|
-
ValidationError: { [key: string]: any } & {
|
|
69130
|
-
/** HTTP status code. */
|
|
69131
|
-
status?: number;
|
|
69132
|
-
} & reportsComponents["schemas"]["BaseProblem"] & {
|
|
69133
|
-
invalidFields?: reportsComponents["schemas"]["InvalidFields"];
|
|
69134
|
-
};
|
|
69135
|
-
/** RFC-7807 [problem details](https://tools.ietf.org/html/rfc7807) JSON object. */
|
|
69136
|
-
TooManyRequests: {
|
|
69137
|
-
/**
|
|
69138
|
-
* Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
|
|
69139
|
-
* It should provide human-readable documentation for the problem type.
|
|
69140
|
-
* When this member is not present, its value is assumed to be "about:blank".
|
|
69141
|
-
*/
|
|
69142
|
-
type?: string;
|
|
69143
|
-
/**
|
|
69144
|
-
* Short, human-readable summary of the problem type.
|
|
69145
|
-
* Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.
|
|
69146
|
-
*/
|
|
69147
|
-
title?: string;
|
|
69148
|
-
/** HTTP status code. */
|
|
69149
|
-
status?: number;
|
|
69150
|
-
/** Human-readable explanation that is specific to this occurrence of the problem. */
|
|
69151
|
-
detail?: string;
|
|
69152
|
-
/**
|
|
69153
|
-
* URI reference that identifies the specific occurrence of the problem.
|
|
69154
|
-
* It may or may not yield further information if dereferenced.
|
|
69155
|
-
*/
|
|
69156
|
-
instance?: string;
|
|
69157
|
-
} & { [key: string]: any };
|
|
69158
69764
|
/** AML check review. */
|
|
69159
69765
|
AmlCheckReview: {
|
|
69160
69766
|
/** Status of the AML check. */
|
|
@@ -69302,10 +69908,6 @@ export interface reportsComponents {
|
|
|
69302
69908
|
file?: { [key: string]: any };
|
|
69303
69909
|
};
|
|
69304
69910
|
};
|
|
69305
|
-
Conflict: { [key: string]: any } & {
|
|
69306
|
-
/** HTTP status code. */
|
|
69307
|
-
status?: number;
|
|
69308
|
-
} & reportsComponents["schemas"]["BaseProblem"];
|
|
69309
69911
|
AuthenticationOptions: {
|
|
69310
69912
|
/** Allowed password pattern. */
|
|
69311
69913
|
passwordPattern?: string | null;
|
|
@@ -73238,9 +73840,16 @@ export interface reportsComponents {
|
|
|
73238
73840
|
* This value may contain alphanumeric characters.
|
|
73239
73841
|
*/
|
|
73240
73842
|
documentNumber?: string | null;
|
|
73241
|
-
/**
|
|
73843
|
+
/**
|
|
73844
|
+
* MRZ sex code (ICAO 9303).
|
|
73845
|
+
* `M`, `F`, or `X`.
|
|
73846
|
+
* Null if not extracted.
|
|
73847
|
+
*/
|
|
73242
73848
|
sex?: string | null;
|
|
73243
|
-
/**
|
|
73849
|
+
/**
|
|
73850
|
+
* MRZ check digits validation.
|
|
73851
|
+
* Null if there is no MRZ, no check data, or a non-standard layout.
|
|
73852
|
+
*/
|
|
73244
73853
|
mrzChecksumValid?: boolean | null;
|
|
73245
73854
|
/** Interpreted subtype of the uploaded document. */
|
|
73246
73855
|
documentSubtype?: reportsComponents["schemas"]["KycDocumentSubtypes"];
|
|
@@ -74850,8 +75459,6 @@ export interface reportsComponents {
|
|
|
74850
75459
|
* Use this plan for non-recurring, one-time, sales.
|
|
74851
75460
|
*/
|
|
74852
75461
|
OneTimeSalePlan: {
|
|
74853
|
-
/** ID of the plan. */
|
|
74854
|
-
id: string;
|
|
74855
75462
|
/**
|
|
74856
75463
|
* Name of the plan.
|
|
74857
75464
|
* This name is displayed on invoices and receipts.
|
|
@@ -74990,8 +75597,6 @@ export interface reportsComponents {
|
|
|
74990
75597
|
* Use this plan for subscriptions or sales that reoccur over a period of time.
|
|
74991
75598
|
*/
|
|
74992
75599
|
SubscriptionPlan: {
|
|
74993
|
-
/** ID of the plan. */
|
|
74994
|
-
id: string;
|
|
74995
75600
|
/**
|
|
74996
75601
|
* Name of the plan.
|
|
74997
75602
|
* This name is displayed on invoices and receipts.
|
|
@@ -75086,8 +75691,6 @@ export interface reportsComponents {
|
|
|
75086
75691
|
* Trials may have a reduced fee, or may be free.
|
|
75087
75692
|
*/
|
|
75088
75693
|
TrialOnlyPlan: {
|
|
75089
|
-
/** ID of the plan. */
|
|
75090
|
-
id: string;
|
|
75091
75694
|
/**
|
|
75092
75695
|
* Name of the plan.
|
|
75093
75696
|
* This name is displayed on invoices and receipts.
|
|
@@ -75140,9 +75743,24 @@ export interface reportsComponents {
|
|
|
75140
75743
|
rel?: "self" | "attachments";
|
|
75141
75744
|
}[];
|
|
75142
75745
|
};
|
|
75143
|
-
Plan: Partial<
|
|
75144
|
-
|
|
75145
|
-
|
|
75746
|
+
Plan: Partial<
|
|
75747
|
+
{
|
|
75748
|
+
/** ID of the plan. */
|
|
75749
|
+
id: string;
|
|
75750
|
+
} & reportsComponents["schemas"]["OneTimeSalePlan"]
|
|
75751
|
+
> &
|
|
75752
|
+
Partial<
|
|
75753
|
+
{
|
|
75754
|
+
/** ID of the plan. */
|
|
75755
|
+
id: string;
|
|
75756
|
+
} & reportsComponents["schemas"]["SubscriptionPlan"]
|
|
75757
|
+
> &
|
|
75758
|
+
Partial<
|
|
75759
|
+
{
|
|
75760
|
+
/** ID of the plan. */
|
|
75761
|
+
id: string;
|
|
75762
|
+
} & reportsComponents["schemas"]["TrialOnlyPlan"]
|
|
75763
|
+
>;
|
|
75146
75764
|
/**
|
|
75147
75765
|
* Products are the items that your business sells.
|
|
75148
75766
|
* Products include digital goods, services, and physical goods.
|
|
@@ -75200,14 +75818,24 @@ export interface reportsComponents {
|
|
|
75200
75818
|
/** ID of the plan. */
|
|
75201
75819
|
id: reportsComponents["schemas"]["ResourceId"];
|
|
75202
75820
|
};
|
|
75203
|
-
FlexiblePlan:
|
|
75204
|
-
|
|
75205
|
-
|
|
75206
|
-
|
|
75207
|
-
|
|
75208
|
-
|
|
75209
|
-
|
|
75210
|
-
|
|
75821
|
+
FlexiblePlan: Partial<
|
|
75822
|
+
{
|
|
75823
|
+
/** ID of the plan. */
|
|
75824
|
+
id: string;
|
|
75825
|
+
} & reportsComponents["schemas"]["OneTimeSalePlan"]
|
|
75826
|
+
> &
|
|
75827
|
+
Partial<
|
|
75828
|
+
{
|
|
75829
|
+
/** ID of the plan. */
|
|
75830
|
+
id: string;
|
|
75831
|
+
} & reportsComponents["schemas"]["SubscriptionPlan"]
|
|
75832
|
+
> &
|
|
75833
|
+
Partial<
|
|
75834
|
+
{
|
|
75835
|
+
/** ID of the plan. */
|
|
75836
|
+
id: string;
|
|
75837
|
+
} & reportsComponents["schemas"]["TrialOnlyPlan"]
|
|
75838
|
+
>;
|
|
75211
75839
|
/**
|
|
75212
75840
|
* Specifies the soft and hard usage limit thresholds for an item with a metered billing plan.
|
|
75213
75841
|
* This value is ignored when the plan is not metered.
|
|
@@ -78776,7 +79404,10 @@ export interface reportsComponents {
|
|
|
78776
79404
|
* > **Important**: Do not URL encode the filter value.
|
|
78777
79405
|
*/
|
|
78778
79406
|
filter?: string | null;
|
|
78779
|
-
/**
|
|
79407
|
+
/**
|
|
79408
|
+
* Title of the message.
|
|
79409
|
+
* This title displays in reports.
|
|
79410
|
+
*/
|
|
78780
79411
|
title?: string;
|
|
78781
79412
|
/** List of messages. */
|
|
78782
79413
|
messages?: {
|
|
@@ -78838,7 +79469,10 @@ export interface reportsComponents {
|
|
|
78838
79469
|
}[];
|
|
78839
79470
|
/** Date and time when the message is scheduled to send. */
|
|
78840
79471
|
startSendingTime?: string;
|
|
78841
|
-
/**
|
|
79472
|
+
/**
|
|
79473
|
+
* Status of the broadcast message.
|
|
79474
|
+
* Setting it to `archived` archives the message, but only if it has already been sent.
|
|
79475
|
+
*/
|
|
78842
79476
|
status?: "draft" | "archived";
|
|
78843
79477
|
};
|
|
78844
79478
|
DepositRequest: {
|
|
@@ -84019,6 +84653,8 @@ export interface reportsComponents {
|
|
|
84019
84653
|
destinationTagCustomField?: string;
|
|
84020
84654
|
/** Cryptocurrency of the payout. */
|
|
84021
84655
|
payoutCurrency?: string;
|
|
84656
|
+
/** Cryptocurrency of the merchant account. */
|
|
84657
|
+
accountCurrency?: string;
|
|
84022
84658
|
/** Blockchain network to use for the payout. */
|
|
84023
84659
|
payoutNetwork?: "btc" | "usdt" | "eth" | "xrp";
|
|
84024
84660
|
};
|
|
@@ -85060,6 +85696,10 @@ export interface reportsComponents {
|
|
|
85060
85696
|
gatewayAccountId: string;
|
|
85061
85697
|
/** Name of the gateway account to use for processing this allocation. */
|
|
85062
85698
|
gatewayName?: string;
|
|
85699
|
+
/** Payout configuration of the gateway account that processes this allocation. */
|
|
85700
|
+
gatewayPayoutInstruction?:
|
|
85701
|
+
| ("all" | "covered-payout" | "approved-payment" | "none")
|
|
85702
|
+
| null;
|
|
85063
85703
|
/** Amount allocated to this payment instrument. */
|
|
85064
85704
|
amount: number;
|
|
85065
85705
|
/** Currency of the payout request allocation. */
|
|
@@ -85927,7 +86567,7 @@ export interface reportsComponents {
|
|
|
85927
86567
|
/** Type of resource to export. */
|
|
85928
86568
|
resource: "customers";
|
|
85929
86569
|
/** Output format of the export. */
|
|
85930
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
86570
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
85931
86571
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
85932
86572
|
/** List of email addresses to notify when an export is completed. */
|
|
85933
86573
|
emailNotification?: string[];
|
|
@@ -85974,7 +86614,7 @@ export interface reportsComponents {
|
|
|
85974
86614
|
/** Type of resource to export. */
|
|
85975
86615
|
resource: "subscriptions";
|
|
85976
86616
|
/** Output format of the export. */
|
|
85977
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
86617
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
85978
86618
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
85979
86619
|
/** List of email addresses to notify when an export is completed. */
|
|
85980
86620
|
emailNotification?: string[];
|
|
@@ -86021,7 +86661,7 @@ export interface reportsComponents {
|
|
|
86021
86661
|
/** Type of resource to export. */
|
|
86022
86662
|
resource: "transactions";
|
|
86023
86663
|
/** Output format of the export. */
|
|
86024
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
86664
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
86025
86665
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
86026
86666
|
/** List of email addresses to notify when an export is completed. */
|
|
86027
86667
|
emailNotification?: string[];
|
|
@@ -86068,7 +86708,7 @@ export interface reportsComponents {
|
|
|
86068
86708
|
/** Type of resource to export. */
|
|
86069
86709
|
resource: "invoices";
|
|
86070
86710
|
/** Output format of the export. */
|
|
86071
|
-
format: "csv" | "json" | "json-api" | "xml" | "pdf";
|
|
86711
|
+
format: "csv" | "json" | "json-api" | "xml" | "pdf" | "detailed-csv";
|
|
86072
86712
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
86073
86713
|
/** List of email addresses to notify when an export is completed. */
|
|
86074
86714
|
emailNotification?: string[];
|
|
@@ -86115,7 +86755,7 @@ export interface reportsComponents {
|
|
|
86115
86755
|
/** Type of resource to export. */
|
|
86116
86756
|
resource: "invoiceItems";
|
|
86117
86757
|
/** Output format of the export. */
|
|
86118
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
86758
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
86119
86759
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
86120
86760
|
/** List of email addresses to notify when an export is completed. */
|
|
86121
86761
|
emailNotification?: string[];
|
|
@@ -86162,7 +86802,7 @@ export interface reportsComponents {
|
|
|
86162
86802
|
/** Type of resource to export. */
|
|
86163
86803
|
resource: "amlChecks";
|
|
86164
86804
|
/** Output format of the export. */
|
|
86165
|
-
format: "csv" | "json" | "json-api" | "xml";
|
|
86805
|
+
format: "csv" | "json" | "json-api" | "xml" | "detailed-csv";
|
|
86166
86806
|
arguments?: reportsComponents["schemas"]["DataExportArguments"];
|
|
86167
86807
|
/** List of email addresses to notify when an export is completed. */
|
|
86168
86808
|
emailNotification?: string[];
|
|
@@ -89105,7 +89745,10 @@ export interface reportsComponents {
|
|
|
89105
89745
|
* Contains only fields that are safe to expose on the Storefront.
|
|
89106
89746
|
*/
|
|
89107
89747
|
referenceData?: {
|
|
89108
|
-
/**
|
|
89748
|
+
/**
|
|
89749
|
+
* Name of the cryptocurrency wallet associated with the payment instrument.
|
|
89750
|
+
* This field is only applicable for cryptocurrency payment instruments.
|
|
89751
|
+
*/
|
|
89109
89752
|
walletName?: string | null;
|
|
89110
89753
|
};
|
|
89111
89754
|
/**
|
|
@@ -89919,10 +90562,10 @@ export interface reportsComponents {
|
|
|
89919
90562
|
"application/json": reportsComponents["schemas"]["Forbidden"];
|
|
89920
90563
|
};
|
|
89921
90564
|
};
|
|
89922
|
-
/**
|
|
89923
|
-
|
|
90565
|
+
/** Conflict. */
|
|
90566
|
+
Conflict: {
|
|
89924
90567
|
content: {
|
|
89925
|
-
"application/json": reportsComponents["schemas"]["
|
|
90568
|
+
"application/json": reportsComponents["schemas"]["Conflict"];
|
|
89926
90569
|
};
|
|
89927
90570
|
};
|
|
89928
90571
|
/** Invalid data sent. */
|
|
@@ -89938,10 +90581,10 @@ export interface reportsComponents {
|
|
|
89938
90581
|
"application/json": reportsComponents["schemas"]["TooManyRequests"];
|
|
89939
90582
|
};
|
|
89940
90583
|
};
|
|
89941
|
-
/**
|
|
89942
|
-
|
|
90584
|
+
/** Resource not found. */
|
|
90585
|
+
NotFound: {
|
|
89943
90586
|
content: {
|
|
89944
|
-
"application/json": reportsComponents["schemas"]["
|
|
90587
|
+
"application/json": reportsComponents["schemas"]["NotFound"];
|
|
89945
90588
|
};
|
|
89946
90589
|
};
|
|
89947
90590
|
/** Customer. */
|
|
@@ -89969,6 +90612,8 @@ export interface reportsComponents {
|
|
|
89969
90612
|
collectionLimit: number;
|
|
89970
90613
|
/** Specifies the starting point within the collection of items to be returned. */
|
|
89971
90614
|
collectionOffset: number;
|
|
90615
|
+
/** ID of the resource. */
|
|
90616
|
+
resourceId: string;
|
|
89972
90617
|
/**
|
|
89973
90618
|
* Sorts and orders the collection of items. To sort in descending
|
|
89974
90619
|
* order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
|
|
@@ -89985,8 +90630,6 @@ export interface reportsComponents {
|
|
|
89985
90630
|
collectionFilter: string;
|
|
89986
90631
|
/** Use this field to perform a partial search of text fields. */
|
|
89987
90632
|
collectionQuery: string;
|
|
89988
|
-
/** ID of the resource. */
|
|
89989
|
-
resourceId: string;
|
|
89990
90633
|
/**
|
|
89991
90634
|
* Expands a request to include embedded objects within the `_embedded`
|
|
89992
90635
|
* property of the response. This field accepts a comma-separated list of objects.
|
|
@@ -90121,6 +90764,12 @@ export interface reportsComponents {
|
|
|
90121
90764
|
| "transactions";
|
|
90122
90765
|
};
|
|
90123
90766
|
requestBodies: {
|
|
90767
|
+
/** Account registration settings resource. */
|
|
90768
|
+
AccountRegistrationSettings: {
|
|
90769
|
+
content: {
|
|
90770
|
+
"application/json": reportsComponents["schemas"]["AccountRegistrationSettings"];
|
|
90771
|
+
};
|
|
90772
|
+
};
|
|
90124
90773
|
/** Attachment resource. */
|
|
90125
90774
|
Attachment: {
|
|
90126
90775
|
content: {
|
|
@@ -94046,6 +94695,24 @@ declare module "create-api-handler" {
|
|
|
94046
94695
|
import Member from "member";
|
|
94047
94696
|
import Collection from "collection";
|
|
94048
94697
|
}
|
|
94698
|
+
declare module "resources/account-registration-settings-resource" {
|
|
94699
|
+
export default function AccountRegistrationSettingsResource({ apiHandler }: {
|
|
94700
|
+
apiHandler: any;
|
|
94701
|
+
}): {
|
|
94702
|
+
getAll({ limit, offset }?: rebilly.GetAccountRegistrationSettingsCollectionRequest): rebilly.GetAccountRegistrationSettingsCollectionResponsePromise;
|
|
94703
|
+
create({ id, data }: rebilly.CreateAccountRegistrationSettingsRequest): rebilly.PostAccountRegistrationSettingsResponsePromise;
|
|
94704
|
+
get({ id }: {
|
|
94705
|
+
id: any;
|
|
94706
|
+
}): rebilly.GetAccountRegistrationSettingsResponsePromise;
|
|
94707
|
+
update({ id, data }: {
|
|
94708
|
+
id: any;
|
|
94709
|
+
data: any;
|
|
94710
|
+
}): rebilly.PutAccountRegistrationSettingsResponsePromise;
|
|
94711
|
+
delete({ id }: {
|
|
94712
|
+
id: any;
|
|
94713
|
+
}): any;
|
|
94714
|
+
};
|
|
94715
|
+
}
|
|
94049
94716
|
declare module "resources/account-resource" {
|
|
94050
94717
|
export default function AccountResource({ apiHandler }: {
|
|
94051
94718
|
apiHandler: any;
|
|
@@ -96027,6 +96694,20 @@ declare module "resources/api-instance" {
|
|
|
96027
96694
|
constructor({ apiHandler }: {
|
|
96028
96695
|
apiHandler: any;
|
|
96029
96696
|
});
|
|
96697
|
+
accountRegistrationSettings: {
|
|
96698
|
+
getAll({ limit, offset }?: rebilly.GetAccountRegistrationSettingsCollectionRequest): rebilly.GetAccountRegistrationSettingsCollectionResponsePromise;
|
|
96699
|
+
create({ id, data }: rebilly.CreateAccountRegistrationSettingsRequest): rebilly.PostAccountRegistrationSettingsResponsePromise;
|
|
96700
|
+
get({ id }: {
|
|
96701
|
+
id: any;
|
|
96702
|
+
}): rebilly.GetAccountRegistrationSettingsResponsePromise;
|
|
96703
|
+
update({ id, data }: {
|
|
96704
|
+
id: any;
|
|
96705
|
+
data: any;
|
|
96706
|
+
}): rebilly.PutAccountRegistrationSettingsResponsePromise;
|
|
96707
|
+
delete({ id }: {
|
|
96708
|
+
id: any;
|
|
96709
|
+
}): any;
|
|
96710
|
+
};
|
|
96030
96711
|
account: {
|
|
96031
96712
|
forgotPassword({ data }: {
|
|
96032
96713
|
data: any;
|