rebilly-js-sdk 61.6.0 → 61.8.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/CHANGELOG.md +2 -2
- package/dist/rebilly-js-sdk.d.ts +125 -230
- package/dist/rebilly-js-sdk.es.mjs +1600 -1609
- package/dist/rebilly-js-sdk.umd.js +3 -3
- package/package.json +1 -1
- package/src/resources/customers-resource.js +0 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
## [61.
|
|
1
|
+
## [61.8.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v61.7.0...rebilly-js-sdk-v61.8.0) (2025-09-15)
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
### Features
|
|
5
5
|
|
|
6
|
-
* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#
|
|
6
|
+
* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#14953](https://github.com/Rebilly/rebilly/issues/14953)) ([a51f871](https://github.com/Rebilly/rebilly/commit/a51f87154fddd0db02f0cf02c5704a301a17127e))
|
package/dist/rebilly-js-sdk.d.ts
CHANGED
|
@@ -1745,25 +1745,16 @@ declare namespace rebilly {
|
|
|
1745
1745
|
|
|
1746
1746
|
type GetCustomerEddScoreResponse = operations['GetCustomerEddScore']['responses']['200']['content']['application/json']
|
|
1747
1747
|
type GetCustomerEddScoreResponsePromise = Promise<{fields: GetCustomerEddScoreResponse}>
|
|
1748
|
-
type PatchCustomerEddScoreRequest = operations['PatchCustomerEddScore']['requestBody']['content']['application/json']
|
|
1749
|
-
type PatchCustomerEddScoreResponse = operations['PatchCustomerEddScore']['responses']['200']['content']['application/json']
|
|
1750
|
-
type PatchCustomerEddScoreResponsePromise = Promise<{fields: PatchCustomerEddScoreResponse}>
|
|
1751
1748
|
|
|
1752
1749
|
type GetCustomerEddTimelineCollectionRequest = operations['GetCustomerEddTimelineCollection']['parameters']["query"] & (operations['GetCustomerEddTimelineCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddTimelineCollection']['parameters']["path"] : {}) & { id: string }
|
|
1753
1750
|
|
|
1754
1751
|
type GetCustomerEddTimelineCollectionResponse = operations['GetCustomerEddTimelineCollection']['responses']['200']['content']['application/json'][0]
|
|
1755
1752
|
type GetCustomerEddTimelineCollectionResponsePromise = Promise<{ items: {fields: GetCustomerEddTimelineCollectionResponse}[], getJSON: object, total?: number, offset?: number, limit?: number }>
|
|
1756
|
-
type PostCustomerEddTimelineRequest = operations['PostCustomerEddTimeline']['requestBody']['content']['application/json']
|
|
1757
|
-
type CreateCustomerEddTimelineRequest = { id?: string, data: PostCustomerEddTimelineRequest, expand?: string }
|
|
1758
|
-
type PostCustomerEddTimelineResponse = operations['PostCustomerEddTimeline']['responses']['201']['content']['application/json']
|
|
1759
|
-
type PostCustomerEddTimelineResponsePromise = Promise<{fields: PostCustomerEddTimelineResponse}>
|
|
1760
1753
|
|
|
1761
1754
|
type GetCustomerEddTimelineRequest = { id: string,messageId: string }
|
|
1762
1755
|
|
|
1763
1756
|
type GetCustomerEddTimelineResponse = operations['GetCustomerEddTimeline']['responses']['200']['content']['application/json']
|
|
1764
1757
|
type GetCustomerEddTimelineResponsePromise = Promise<{fields: GetCustomerEddTimelineResponse}>
|
|
1765
|
-
type DeleteCustomerEddTimelineResponse = operations['DeleteCustomerEddTimeline']['responses']['204']
|
|
1766
|
-
type DeleteCustomerEddTimelineResponsePromise = Promise<{fields: DeleteCustomerEddTimelineResponse}>
|
|
1767
1758
|
|
|
1768
1759
|
type GetCustomerEddSearchResultCollectionRequest = operations['GetCustomerEddSearchResultCollection']['parameters']["query"] & (operations['GetCustomerEddSearchResultCollection']['parameters'] extends {path: {}} ? operations['GetCustomerEddSearchResultCollection']['parameters']["path"] : {}) & { id: string }
|
|
1769
1760
|
|
|
@@ -2348,7 +2339,7 @@ export interface corePaths {
|
|
|
2348
2339
|
"/aml-checks/{id}/review": {
|
|
2349
2340
|
/**
|
|
2350
2341
|
* Reviews an AML check.
|
|
2351
|
-
* The AML check can be either confirmed or marked as a false positive
|
|
2342
|
+
* The AML check can be either confirmed or marked as a false positive.
|
|
2352
2343
|
*/
|
|
2353
2344
|
post: operations["PostAmlCheckReview"];
|
|
2354
2345
|
parameters: {
|
|
@@ -5160,8 +5151,6 @@ export interface corePaths {
|
|
|
5160
5151
|
"/customers/{id}/edd-score": {
|
|
5161
5152
|
/** Retrieves an EDD score for a customer with a specified ID. */
|
|
5162
5153
|
get: operations["GetCustomerEddScore"];
|
|
5163
|
-
/** Updates an EDD score for a customer with a specified ID. */
|
|
5164
|
-
patch: operations["PatchCustomerEddScore"];
|
|
5165
5154
|
parameters: {
|
|
5166
5155
|
path: {
|
|
5167
5156
|
/** ID of the resource. */
|
|
@@ -5172,8 +5161,6 @@ export interface corePaths {
|
|
|
5172
5161
|
"/customers/{id}/edd-timeline": {
|
|
5173
5162
|
/** Retrieves a list of EDD timeline messages. */
|
|
5174
5163
|
get: operations["GetCustomerEddTimelineCollection"];
|
|
5175
|
-
/** Creates an EDD timeline comment. */
|
|
5176
|
-
post: operations["PostCustomerEddTimeline"];
|
|
5177
5164
|
parameters: {
|
|
5178
5165
|
path: {
|
|
5179
5166
|
/** ID of the resource. */
|
|
@@ -5184,8 +5171,6 @@ export interface corePaths {
|
|
|
5184
5171
|
"/customers/{id}/edd-timeline/{messageId}": {
|
|
5185
5172
|
/** Retrieves an EDD message with a specified ID. */
|
|
5186
5173
|
get: operations["GetCustomerEddTimeline"];
|
|
5187
|
-
/** Deletes an EDD timeline message with a specified ID. */
|
|
5188
|
-
delete: operations["DeleteCustomerEddTimeline"];
|
|
5189
5174
|
parameters: {
|
|
5190
5175
|
path: {
|
|
5191
5176
|
/** ID of the resource. */
|
|
@@ -5284,28 +5269,6 @@ export interface coreComponents {
|
|
|
5284
5269
|
/** Type of link. */
|
|
5285
5270
|
rel?: "self";
|
|
5286
5271
|
}[];
|
|
5287
|
-
/**
|
|
5288
|
-
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
5289
|
-
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
5290
|
-
*/
|
|
5291
|
-
Tag: {
|
|
5292
|
-
/** ID of the tag. */
|
|
5293
|
-
id?: coreComponents["schemas"]["ResourceId"];
|
|
5294
|
-
/**
|
|
5295
|
-
* Unique name for the tag.
|
|
5296
|
-
* Tag names are not case-sensitive.
|
|
5297
|
-
*/
|
|
5298
|
-
name: string;
|
|
5299
|
-
/**
|
|
5300
|
-
* Type of tag.
|
|
5301
|
-
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
5302
|
-
* For example, you can only use customer tags on customers.
|
|
5303
|
-
*/
|
|
5304
|
-
type: "customer" | "kyc-document" | "aml-check";
|
|
5305
|
-
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
5306
|
-
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
5307
|
-
_links?: coreComponents["schemas"]["SelfLink"];
|
|
5308
|
-
};
|
|
5309
5272
|
AML: {
|
|
5310
5273
|
/** First name of the individual, or name of entity. */
|
|
5311
5274
|
firstName?: string;
|
|
@@ -5372,6 +5335,28 @@ export interface coreComponents {
|
|
|
5372
5335
|
comments?: string | null;
|
|
5373
5336
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
5374
5337
|
};
|
|
5338
|
+
/**
|
|
5339
|
+
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
5340
|
+
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
5341
|
+
*/
|
|
5342
|
+
Tag: {
|
|
5343
|
+
/** ID of the tag. */
|
|
5344
|
+
id?: coreComponents["schemas"]["ResourceId"];
|
|
5345
|
+
/**
|
|
5346
|
+
* Unique name for the tag.
|
|
5347
|
+
* Tag names are not case-sensitive.
|
|
5348
|
+
*/
|
|
5349
|
+
name: string;
|
|
5350
|
+
/**
|
|
5351
|
+
* Type of tag.
|
|
5352
|
+
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
5353
|
+
* For example, you can only use customer tags on customers.
|
|
5354
|
+
*/
|
|
5355
|
+
type: "customer" | "kyc-document" | "aml-check";
|
|
5356
|
+
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
5357
|
+
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
5358
|
+
_links?: coreComponents["schemas"]["SelfLink"];
|
|
5359
|
+
};
|
|
5375
5360
|
/** AML check result. */
|
|
5376
5361
|
AmlCheck: {
|
|
5377
5362
|
/** Unique resource ID. */
|
|
@@ -5423,8 +5408,6 @@ export interface coreComponents {
|
|
|
5423
5408
|
/** Customer's postal code at the time of the AML check. */
|
|
5424
5409
|
postalCode?: string | null;
|
|
5425
5410
|
};
|
|
5426
|
-
/** List of tags that have been assigned to the customer. */
|
|
5427
|
-
tags?: coreComponents["schemas"]["Tag"][];
|
|
5428
5411
|
/** ID of the customer's organization. */
|
|
5429
5412
|
organizationId?: string;
|
|
5430
5413
|
};
|
|
@@ -5515,6 +5498,8 @@ export interface coreComponents {
|
|
|
5515
5498
|
AmlCheckReview: {
|
|
5516
5499
|
/** AML-related customer tag. */
|
|
5517
5500
|
tag?: "aml-match-confirmed" | "aml-match-false-positive";
|
|
5501
|
+
/** Status of the AML check. */
|
|
5502
|
+
status?: "confirmed-match" | "false-positive";
|
|
5518
5503
|
};
|
|
5519
5504
|
/** Degree of confidence to assign. */
|
|
5520
5505
|
AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
|
|
@@ -12360,8 +12345,9 @@ export interface coreComponents {
|
|
|
12360
12345
|
* When the delinquency time of an invoice is reached, the order is automatically canceled.
|
|
12361
12346
|
*
|
|
12362
12347
|
* {% admonition type="warning" %}
|
|
12363
|
-
* If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
12348
|
+
* - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
12364
12349
|
* You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
|
|
12350
|
+
* - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
|
|
12365
12351
|
* {% /admonition %}
|
|
12366
12352
|
*
|
|
12367
12353
|
* If this value is not passed during order creation,
|
|
@@ -15882,6 +15868,8 @@ export interface coreComponents {
|
|
|
15882
15868
|
transactionType: "01" | "03" | "10" | "11" | "28";
|
|
15883
15869
|
/** Specifies whether to decline transactions if a payment card is not enrolled. */
|
|
15884
15870
|
declineNotEnrolled?: boolean;
|
|
15871
|
+
/** Specifies whether to force the 3D Secure authentication into challenge flow. */
|
|
15872
|
+
forceChallenge?: boolean;
|
|
15885
15873
|
};
|
|
15886
15874
|
/** ACI gateway configuration. */
|
|
15887
15875
|
ACI: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -17328,6 +17316,7 @@ export interface coreComponents {
|
|
|
17328
17316
|
/** Account ID of the merchant. */
|
|
17329
17317
|
accountId: string;
|
|
17330
17318
|
};
|
|
17319
|
+
threeDSecureServer?: coreComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
17331
17320
|
};
|
|
17332
17321
|
/** loonie gateway configuration. */
|
|
17333
17322
|
loonie: coreComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -19521,6 +19510,16 @@ export interface coreComponents {
|
|
|
19521
19510
|
* {% /admonition %}
|
|
19522
19511
|
*/
|
|
19523
19512
|
orderDelinquencyPeriod?: string | null;
|
|
19513
|
+
/**
|
|
19514
|
+
* Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
|
|
19515
|
+
* If this value is `true`, recurring discounts are excluded from MRR.
|
|
19516
|
+
*/
|
|
19517
|
+
subtractRecurringDiscountsFromMrr?: boolean;
|
|
19518
|
+
/**
|
|
19519
|
+
* Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
|
|
19520
|
+
* If this value is `true`, one-time discounts are excluded from MRR.
|
|
19521
|
+
*/
|
|
19522
|
+
subtractOneTimeDiscountsFromMrr?: boolean;
|
|
19524
19523
|
} | null;
|
|
19525
19524
|
/**
|
|
19526
19525
|
* Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
|
|
@@ -24044,17 +24043,6 @@ export interface coreComponents {
|
|
|
24044
24043
|
rel?: "self";
|
|
24045
24044
|
}[];
|
|
24046
24045
|
};
|
|
24047
|
-
PatchEddScore: {
|
|
24048
|
-
/** Customer's EDD score. */
|
|
24049
|
-
score?: {
|
|
24050
|
-
occupation: coreComponents["schemas"]["EddScore"];
|
|
24051
|
-
arrest: coreComponents["schemas"]["EddScore"];
|
|
24052
|
-
bankruptcy: coreComponents["schemas"]["EddScore"];
|
|
24053
|
-
fraud: coreComponents["schemas"]["EddScore"];
|
|
24054
|
-
} | null;
|
|
24055
|
-
/** Date and time in ISO 8601 format when the EDD score is updated. */
|
|
24056
|
-
nextUpdateTime?: string | null;
|
|
24057
|
-
};
|
|
24058
24046
|
EddTimeline: {
|
|
24059
24047
|
/** ID of the timeline message. */
|
|
24060
24048
|
id?: string;
|
|
@@ -26369,7 +26357,7 @@ export interface operations {
|
|
|
26369
26357
|
};
|
|
26370
26358
|
/**
|
|
26371
26359
|
* Reviews an AML check.
|
|
26372
|
-
* The AML check can be either confirmed or marked as a false positive
|
|
26360
|
+
* The AML check can be either confirmed or marked as a false positive.
|
|
26373
26361
|
*/
|
|
26374
26362
|
PostAmlCheckReview: {
|
|
26375
26363
|
parameters: {
|
|
@@ -38103,33 +38091,6 @@ export interface operations {
|
|
|
38103
38091
|
404: coreComponents["responses"]["NotFound"];
|
|
38104
38092
|
};
|
|
38105
38093
|
};
|
|
38106
|
-
/** Updates an EDD score for a customer with a specified ID. */
|
|
38107
|
-
PatchCustomerEddScore: {
|
|
38108
|
-
parameters: {
|
|
38109
|
-
path: {
|
|
38110
|
-
/** ID of the resource. */
|
|
38111
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
38112
|
-
};
|
|
38113
|
-
};
|
|
38114
|
-
responses: {
|
|
38115
|
-
/** EDD score updated. */
|
|
38116
|
-
200: {
|
|
38117
|
-
headers: {};
|
|
38118
|
-
content: {
|
|
38119
|
-
"application/json": coreComponents["schemas"]["Edd"];
|
|
38120
|
-
};
|
|
38121
|
-
};
|
|
38122
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
38123
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
38124
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
38125
|
-
429: coreComponents["responses"]["TooManyRequests"];
|
|
38126
|
-
};
|
|
38127
|
-
requestBody: {
|
|
38128
|
-
content: {
|
|
38129
|
-
"application/json": coreComponents["schemas"]["PatchEddScore"];
|
|
38130
|
-
};
|
|
38131
|
-
};
|
|
38132
|
-
};
|
|
38133
38094
|
/** Retrieves a list of EDD timeline messages. */
|
|
38134
38095
|
GetCustomerEddTimelineCollection: {
|
|
38135
38096
|
parameters: {
|
|
@@ -38171,34 +38132,6 @@ export interface operations {
|
|
|
38171
38132
|
403: coreComponents["responses"]["Forbidden"];
|
|
38172
38133
|
};
|
|
38173
38134
|
};
|
|
38174
|
-
/** Creates an EDD timeline comment. */
|
|
38175
|
-
PostCustomerEddTimeline: {
|
|
38176
|
-
parameters: {
|
|
38177
|
-
path: {
|
|
38178
|
-
/** ID of the resource. */
|
|
38179
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
38180
|
-
};
|
|
38181
|
-
};
|
|
38182
|
-
responses: {
|
|
38183
|
-
/** EDD timeline comment created. */
|
|
38184
|
-
201: {
|
|
38185
|
-
headers: {};
|
|
38186
|
-
content: {
|
|
38187
|
-
"application/json": coreComponents["schemas"]["EddTimeline"];
|
|
38188
|
-
};
|
|
38189
|
-
};
|
|
38190
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
38191
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
38192
|
-
422: coreComponents["responses"]["ValidationError"];
|
|
38193
|
-
429: coreComponents["responses"]["TooManyRequests"];
|
|
38194
|
-
};
|
|
38195
|
-
/** EDD timeline resource. */
|
|
38196
|
-
requestBody: {
|
|
38197
|
-
content: {
|
|
38198
|
-
"application/json": coreComponents["schemas"]["EddTimeline"];
|
|
38199
|
-
};
|
|
38200
|
-
};
|
|
38201
|
-
};
|
|
38202
38135
|
/** Retrieves an EDD message with a specified ID. */
|
|
38203
38136
|
GetCustomerEddTimeline: {
|
|
38204
38137
|
parameters: {
|
|
@@ -38221,26 +38154,6 @@ export interface operations {
|
|
|
38221
38154
|
404: coreComponents["responses"]["NotFound"];
|
|
38222
38155
|
};
|
|
38223
38156
|
};
|
|
38224
|
-
/** Deletes an EDD timeline message with a specified ID. */
|
|
38225
|
-
DeleteCustomerEddTimeline: {
|
|
38226
|
-
parameters: {
|
|
38227
|
-
path: {
|
|
38228
|
-
/** ID of the resource. */
|
|
38229
|
-
id: coreComponents["parameters"]["resourceId"];
|
|
38230
|
-
/** ID of the EDD timeline message. */
|
|
38231
|
-
messageId: string;
|
|
38232
|
-
};
|
|
38233
|
-
};
|
|
38234
|
-
responses: {
|
|
38235
|
-
/** EDD timeline message deleted. */
|
|
38236
|
-
204: never;
|
|
38237
|
-
401: coreComponents["responses"]["Unauthorized"];
|
|
38238
|
-
403: coreComponents["responses"]["Forbidden"];
|
|
38239
|
-
404: coreComponents["responses"]["NotFound"];
|
|
38240
|
-
409: coreComponents["responses"]["Conflict"];
|
|
38241
|
-
429: coreComponents["responses"]["TooManyRequests"];
|
|
38242
|
-
};
|
|
38243
|
-
};
|
|
38244
38157
|
/** Retrieve EDD search results for a customer with a specified ID. */
|
|
38245
38158
|
GetCustomerEddSearchResultCollection: {
|
|
38246
38159
|
parameters: {
|
|
@@ -39140,28 +39053,6 @@ export interface storefrontComponents {
|
|
|
39140
39053
|
/** Type of link. */
|
|
39141
39054
|
rel?: "self";
|
|
39142
39055
|
}[];
|
|
39143
|
-
/**
|
|
39144
|
-
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
39145
|
-
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
39146
|
-
*/
|
|
39147
|
-
Tag: {
|
|
39148
|
-
/** ID of the tag. */
|
|
39149
|
-
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
39150
|
-
/**
|
|
39151
|
-
* Unique name for the tag.
|
|
39152
|
-
* Tag names are not case-sensitive.
|
|
39153
|
-
*/
|
|
39154
|
-
name: string;
|
|
39155
|
-
/**
|
|
39156
|
-
* Type of tag.
|
|
39157
|
-
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
39158
|
-
* For example, you can only use customer tags on customers.
|
|
39159
|
-
*/
|
|
39160
|
-
type: "customer" | "kyc-document" | "aml-check";
|
|
39161
|
-
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
39162
|
-
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
39163
|
-
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
39164
|
-
};
|
|
39165
39056
|
AML: {
|
|
39166
39057
|
/** First name of the individual, or name of entity. */
|
|
39167
39058
|
firstName?: string;
|
|
@@ -39228,6 +39119,28 @@ export interface storefrontComponents {
|
|
|
39228
39119
|
comments?: string | null;
|
|
39229
39120
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
39230
39121
|
};
|
|
39122
|
+
/**
|
|
39123
|
+
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
39124
|
+
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
39125
|
+
*/
|
|
39126
|
+
Tag: {
|
|
39127
|
+
/** ID of the tag. */
|
|
39128
|
+
id?: storefrontComponents["schemas"]["ResourceId"];
|
|
39129
|
+
/**
|
|
39130
|
+
* Unique name for the tag.
|
|
39131
|
+
* Tag names are not case-sensitive.
|
|
39132
|
+
*/
|
|
39133
|
+
name: string;
|
|
39134
|
+
/**
|
|
39135
|
+
* Type of tag.
|
|
39136
|
+
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
39137
|
+
* For example, you can only use customer tags on customers.
|
|
39138
|
+
*/
|
|
39139
|
+
type: "customer" | "kyc-document" | "aml-check";
|
|
39140
|
+
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
39141
|
+
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
39142
|
+
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
39143
|
+
};
|
|
39231
39144
|
/** AML check result. */
|
|
39232
39145
|
AmlCheck: {
|
|
39233
39146
|
/** Unique resource ID. */
|
|
@@ -39279,8 +39192,6 @@ export interface storefrontComponents {
|
|
|
39279
39192
|
/** Customer's postal code at the time of the AML check. */
|
|
39280
39193
|
postalCode?: string | null;
|
|
39281
39194
|
};
|
|
39282
|
-
/** List of tags that have been assigned to the customer. */
|
|
39283
|
-
tags?: storefrontComponents["schemas"]["Tag"][];
|
|
39284
39195
|
/** ID of the customer's organization. */
|
|
39285
39196
|
organizationId?: string;
|
|
39286
39197
|
};
|
|
@@ -39371,6 +39282,8 @@ export interface storefrontComponents {
|
|
|
39371
39282
|
AmlCheckReview: {
|
|
39372
39283
|
/** AML-related customer tag. */
|
|
39373
39284
|
tag?: "aml-match-confirmed" | "aml-match-false-positive";
|
|
39285
|
+
/** Status of the AML check. */
|
|
39286
|
+
status?: "confirmed-match" | "false-positive";
|
|
39374
39287
|
};
|
|
39375
39288
|
/** Degree of confidence to assign. */
|
|
39376
39289
|
AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
|
|
@@ -46216,8 +46129,9 @@ export interface storefrontComponents {
|
|
|
46216
46129
|
* When the delinquency time of an invoice is reached, the order is automatically canceled.
|
|
46217
46130
|
*
|
|
46218
46131
|
* {% admonition type="warning" %}
|
|
46219
|
-
* If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
46132
|
+
* - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
46220
46133
|
* You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
|
|
46134
|
+
* - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
|
|
46221
46135
|
* {% /admonition %}
|
|
46222
46136
|
*
|
|
46223
46137
|
* If this value is not passed during order creation,
|
|
@@ -49738,6 +49652,8 @@ export interface storefrontComponents {
|
|
|
49738
49652
|
transactionType: "01" | "03" | "10" | "11" | "28";
|
|
49739
49653
|
/** Specifies whether to decline transactions if a payment card is not enrolled. */
|
|
49740
49654
|
declineNotEnrolled?: boolean;
|
|
49655
|
+
/** Specifies whether to force the 3D Secure authentication into challenge flow. */
|
|
49656
|
+
forceChallenge?: boolean;
|
|
49741
49657
|
};
|
|
49742
49658
|
/** ACI gateway configuration. */
|
|
49743
49659
|
ACI: storefrontComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -51184,6 +51100,7 @@ export interface storefrontComponents {
|
|
|
51184
51100
|
/** Account ID of the merchant. */
|
|
51185
51101
|
accountId: string;
|
|
51186
51102
|
};
|
|
51103
|
+
threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
51187
51104
|
};
|
|
51188
51105
|
/** loonie gateway configuration. */
|
|
51189
51106
|
loonie: storefrontComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -53377,6 +53294,16 @@ export interface storefrontComponents {
|
|
|
53377
53294
|
* {% /admonition %}
|
|
53378
53295
|
*/
|
|
53379
53296
|
orderDelinquencyPeriod?: string | null;
|
|
53297
|
+
/**
|
|
53298
|
+
* Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
|
|
53299
|
+
* If this value is `true`, recurring discounts are excluded from MRR.
|
|
53300
|
+
*/
|
|
53301
|
+
subtractRecurringDiscountsFromMrr?: boolean;
|
|
53302
|
+
/**
|
|
53303
|
+
* Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
|
|
53304
|
+
* If this value is `true`, one-time discounts are excluded from MRR.
|
|
53305
|
+
*/
|
|
53306
|
+
subtractOneTimeDiscountsFromMrr?: boolean;
|
|
53380
53307
|
} | null;
|
|
53381
53308
|
/**
|
|
53382
53309
|
* Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
|
|
@@ -57900,17 +57827,6 @@ export interface storefrontComponents {
|
|
|
57900
57827
|
rel?: "self";
|
|
57901
57828
|
}[];
|
|
57902
57829
|
};
|
|
57903
|
-
PatchEddScore: {
|
|
57904
|
-
/** Customer's EDD score. */
|
|
57905
|
-
score?: {
|
|
57906
|
-
occupation: storefrontComponents["schemas"]["EddScore"];
|
|
57907
|
-
arrest: storefrontComponents["schemas"]["EddScore"];
|
|
57908
|
-
bankruptcy: storefrontComponents["schemas"]["EddScore"];
|
|
57909
|
-
fraud: storefrontComponents["schemas"]["EddScore"];
|
|
57910
|
-
} | null;
|
|
57911
|
-
/** Date and time in ISO 8601 format when the EDD score is updated. */
|
|
57912
|
-
nextUpdateTime?: string | null;
|
|
57913
|
-
};
|
|
57914
57830
|
EddTimeline: {
|
|
57915
57831
|
/** ID of the timeline message. */
|
|
57916
57832
|
id?: string;
|
|
@@ -62028,28 +61944,6 @@ export interface reportsComponents {
|
|
|
62028
61944
|
/** Type of link. */
|
|
62029
61945
|
rel?: "self";
|
|
62030
61946
|
}[];
|
|
62031
|
-
/**
|
|
62032
|
-
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
62033
|
-
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
62034
|
-
*/
|
|
62035
|
-
Tag: {
|
|
62036
|
-
/** ID of the tag. */
|
|
62037
|
-
id?: reportsComponents["schemas"]["ResourceId"];
|
|
62038
|
-
/**
|
|
62039
|
-
* Unique name for the tag.
|
|
62040
|
-
* Tag names are not case-sensitive.
|
|
62041
|
-
*/
|
|
62042
|
-
name: string;
|
|
62043
|
-
/**
|
|
62044
|
-
* Type of tag.
|
|
62045
|
-
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
62046
|
-
* For example, you can only use customer tags on customers.
|
|
62047
|
-
*/
|
|
62048
|
-
type: "customer" | "kyc-document" | "aml-check";
|
|
62049
|
-
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
62050
|
-
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
62051
|
-
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
62052
|
-
};
|
|
62053
61947
|
AML: {
|
|
62054
61948
|
/** First name of the individual, or name of entity. */
|
|
62055
61949
|
firstName?: string;
|
|
@@ -62116,6 +62010,28 @@ export interface reportsComponents {
|
|
|
62116
62010
|
comments?: string | null;
|
|
62117
62011
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
62118
62012
|
};
|
|
62013
|
+
/**
|
|
62014
|
+
* Use tags to organize and categorize customers or KYC documents based on keywords.
|
|
62015
|
+
* For more information, see [Tags](https://www.rebilly.com/docs/dev-docs/api/tags/).
|
|
62016
|
+
*/
|
|
62017
|
+
Tag: {
|
|
62018
|
+
/** ID of the tag. */
|
|
62019
|
+
id?: reportsComponents["schemas"]["ResourceId"];
|
|
62020
|
+
/**
|
|
62021
|
+
* Unique name for the tag.
|
|
62022
|
+
* Tag names are not case-sensitive.
|
|
62023
|
+
*/
|
|
62024
|
+
name: string;
|
|
62025
|
+
/**
|
|
62026
|
+
* Type of tag.
|
|
62027
|
+
* Tags of a specific type can only be assigned to corresponding entity types.
|
|
62028
|
+
* For example, you can only use customer tags on customers.
|
|
62029
|
+
*/
|
|
62030
|
+
type: "customer" | "kyc-document" | "aml-check";
|
|
62031
|
+
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
62032
|
+
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
62033
|
+
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
62034
|
+
};
|
|
62119
62035
|
/** AML check result. */
|
|
62120
62036
|
AmlCheck: {
|
|
62121
62037
|
/** Unique resource ID. */
|
|
@@ -62167,8 +62083,6 @@ export interface reportsComponents {
|
|
|
62167
62083
|
/** Customer's postal code at the time of the AML check. */
|
|
62168
62084
|
postalCode?: string | null;
|
|
62169
62085
|
};
|
|
62170
|
-
/** List of tags that have been assigned to the customer. */
|
|
62171
|
-
tags?: reportsComponents["schemas"]["Tag"][];
|
|
62172
62086
|
/** ID of the customer's organization. */
|
|
62173
62087
|
organizationId?: string;
|
|
62174
62088
|
};
|
|
@@ -62259,6 +62173,8 @@ export interface reportsComponents {
|
|
|
62259
62173
|
AmlCheckReview: {
|
|
62260
62174
|
/** AML-related customer tag. */
|
|
62261
62175
|
tag?: "aml-match-confirmed" | "aml-match-false-positive";
|
|
62176
|
+
/** Status of the AML check. */
|
|
62177
|
+
status?: "confirmed-match" | "false-positive";
|
|
62262
62178
|
};
|
|
62263
62179
|
/** Degree of confidence to assign. */
|
|
62264
62180
|
AmlConfidence: ("weak" | "medium" | "strong" | "very-strong") | null;
|
|
@@ -69104,8 +69020,9 @@ export interface reportsComponents {
|
|
|
69104
69020
|
* When the delinquency time of an invoice is reached, the order is automatically canceled.
|
|
69105
69021
|
*
|
|
69106
69022
|
* {% admonition type="warning" %}
|
|
69107
|
-
* If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
69023
|
+
* - If the `delinquencyPeriod` value is `null`, the order does not change state and remains active.
|
|
69108
69024
|
* You must explicitly configure the delinquency period to enable automatic cancellation of unpaid orders.
|
|
69025
|
+
* - If you add a delinquency period to an active order, it is applied to all new invoices created for the order. It is not applied to the unpaid and past-due invoices. To apply a delinquency period to unpaid and past-due invoices, set the `delinquencyTime` parameter using the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=delinquencytime).
|
|
69109
69026
|
* {% /admonition %}
|
|
69110
69027
|
*
|
|
69111
69028
|
* If this value is not passed during order creation,
|
|
@@ -72626,6 +72543,8 @@ export interface reportsComponents {
|
|
|
72626
72543
|
transactionType: "01" | "03" | "10" | "11" | "28";
|
|
72627
72544
|
/** Specifies whether to decline transactions if a payment card is not enrolled. */
|
|
72628
72545
|
declineNotEnrolled?: boolean;
|
|
72546
|
+
/** Specifies whether to force the 3D Secure authentication into challenge flow. */
|
|
72547
|
+
forceChallenge?: boolean;
|
|
72629
72548
|
};
|
|
72630
72549
|
/** ACI gateway configuration. */
|
|
72631
72550
|
ACI: reportsComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -74072,6 +73991,7 @@ export interface reportsComponents {
|
|
|
74072
73991
|
/** Account ID of the merchant. */
|
|
74073
73992
|
accountId: string;
|
|
74074
73993
|
};
|
|
73994
|
+
threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
74075
73995
|
};
|
|
74076
73996
|
/** loonie gateway configuration. */
|
|
74077
73997
|
loonie: reportsComponents["schemas"]["GatewayAccount"] & {
|
|
@@ -76265,6 +76185,16 @@ export interface reportsComponents {
|
|
|
76265
76185
|
* {% /admonition %}
|
|
76266
76186
|
*/
|
|
76267
76187
|
orderDelinquencyPeriod?: string | null;
|
|
76188
|
+
/**
|
|
76189
|
+
* Specifies whether recurring discounts should be subtracted from MRR in metrics calculation.
|
|
76190
|
+
* If this value is `true`, recurring discounts are excluded from MRR.
|
|
76191
|
+
*/
|
|
76192
|
+
subtractRecurringDiscountsFromMrr?: boolean;
|
|
76193
|
+
/**
|
|
76194
|
+
* Specifies whether one-time discounts should be subtracted from MRR in metrics calculation.
|
|
76195
|
+
* If this value is `true`, one-time discounts are excluded from MRR.
|
|
76196
|
+
*/
|
|
76197
|
+
subtractOneTimeDiscountsFromMrr?: boolean;
|
|
76268
76198
|
} | null;
|
|
76269
76199
|
/**
|
|
76270
76200
|
* Additional organization addresses where a merchant may want to collect taxes using the `taxjar` tax calculator.
|
|
@@ -80788,17 +80718,6 @@ export interface reportsComponents {
|
|
|
80788
80718
|
rel?: "self";
|
|
80789
80719
|
}[];
|
|
80790
80720
|
};
|
|
80791
|
-
PatchEddScore: {
|
|
80792
|
-
/** Customer's EDD score. */
|
|
80793
|
-
score?: {
|
|
80794
|
-
occupation: reportsComponents["schemas"]["EddScore"];
|
|
80795
|
-
arrest: reportsComponents["schemas"]["EddScore"];
|
|
80796
|
-
bankruptcy: reportsComponents["schemas"]["EddScore"];
|
|
80797
|
-
fraud: reportsComponents["schemas"]["EddScore"];
|
|
80798
|
-
} | null;
|
|
80799
|
-
/** Date and time in ISO 8601 format when the EDD score is updated. */
|
|
80800
|
-
nextUpdateTime?: string | null;
|
|
80801
|
-
};
|
|
80802
80721
|
EddTimeline: {
|
|
80803
80722
|
/** ID of the timeline message. */
|
|
80804
80723
|
id?: string;
|
|
@@ -83743,11 +83662,11 @@ export interface operations {
|
|
|
83743
83662
|
GetMonthlyRecurringRevenueReport: {
|
|
83744
83663
|
parameters: {
|
|
83745
83664
|
query: {
|
|
83746
|
-
/** Revenue currency. */
|
|
83665
|
+
/** Revenue currency. If not provided, the organization reporting currency is used. */
|
|
83747
83666
|
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
83748
|
-
/** Date and time when the report starts. */
|
|
83667
|
+
/** Date and time when the report starts. If not provided or null, the report starts from the previous month. */
|
|
83749
83668
|
periodStart: string;
|
|
83750
|
-
/** Date and time when the report ends. */
|
|
83669
|
+
/** Date and time when the report ends. If not provided or null, the report ends at the current month. */
|
|
83751
83670
|
periodEnd: string;
|
|
83752
83671
|
/** Limits the number of collection items to be returned. */
|
|
83753
83672
|
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
@@ -83776,11 +83695,11 @@ export interface operations {
|
|
|
83776
83695
|
GetAnnualRecurringRevenueReport: {
|
|
83777
83696
|
parameters: {
|
|
83778
83697
|
query: {
|
|
83779
|
-
/** Revenue currency. */
|
|
83698
|
+
/** Revenue currency. If not provided, the organization reporting currency is used. */
|
|
83780
83699
|
currency: reportsComponents["schemas"]["CurrencyCode"];
|
|
83781
|
-
/** Date and time when the report starts. */
|
|
83700
|
+
/** Date and time when the report starts. If not provided or null, the report starts from the previous month. */
|
|
83782
83701
|
periodStart: string;
|
|
83783
|
-
/** Date and time when the report ends. */
|
|
83702
|
+
/** Date and time when the report ends. If not provided or null, the report ends at the current month. */
|
|
83784
83703
|
periodEnd: string;
|
|
83785
83704
|
/** Limits the number of collection items to be returned. */
|
|
83786
83705
|
limit?: reportsComponents["parameters"]["collectionLimit"];
|
|
@@ -84894,23 +84813,11 @@ declare module "resources/customers-resource" {
|
|
|
84894
84813
|
getCustomerEddScore({ id }: {
|
|
84895
84814
|
id: any;
|
|
84896
84815
|
}): rebilly.GetCustomerEddScoreResponsePromise;
|
|
84897
|
-
patchCustomerEddScore({ id, data }: {
|
|
84898
|
-
id: any;
|
|
84899
|
-
data: any;
|
|
84900
|
-
}): any;
|
|
84901
84816
|
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
|
|
84902
|
-
createEddTimelineComment({ id, data }: {
|
|
84903
|
-
id: any;
|
|
84904
|
-
data: any;
|
|
84905
|
-
}): any;
|
|
84906
84817
|
getEddTimelineMessage({ id, messageId }: {
|
|
84907
84818
|
id: any;
|
|
84908
84819
|
messageId: any;
|
|
84909
84820
|
}): rebilly.GetCustomerEddTimelineResponsePromise;
|
|
84910
|
-
deleteEddTimelineMessage({ id, messageId }: {
|
|
84911
|
-
id: any;
|
|
84912
|
-
messageId: any;
|
|
84913
|
-
}): any;
|
|
84914
84821
|
getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
|
|
84915
84822
|
getEddSearchResult({ id, searchResultId }: {
|
|
84916
84823
|
id: any;
|
|
@@ -86640,23 +86547,11 @@ declare module "resources/api-instance" {
|
|
|
86640
86547
|
getCustomerEddScore({ id }: {
|
|
86641
86548
|
id: any;
|
|
86642
86549
|
}): rebilly.GetCustomerEddScoreResponsePromise;
|
|
86643
|
-
patchCustomerEddScore({ id, data }: {
|
|
86644
|
-
id: any;
|
|
86645
|
-
data: any;
|
|
86646
|
-
}): any;
|
|
86647
86550
|
getEddTimelineCollection({ id, limit, offset, filter, sort, q, }: rebilly.GetCustomerEddTimelineCollectionRequest): rebilly.GetCustomerEddTimelineCollectionResponsePromise;
|
|
86648
|
-
createEddTimelineComment({ id, data }: {
|
|
86649
|
-
id: any;
|
|
86650
|
-
data: any;
|
|
86651
|
-
}): any;
|
|
86652
86551
|
getEddTimelineMessage({ id, messageId }: {
|
|
86653
86552
|
id: any;
|
|
86654
86553
|
messageId: any;
|
|
86655
86554
|
}): rebilly.GetCustomerEddTimelineResponsePromise;
|
|
86656
|
-
deleteEddTimelineMessage({ id, messageId }: {
|
|
86657
|
-
id: any;
|
|
86658
|
-
messageId: any;
|
|
86659
|
-
}): any;
|
|
86660
86555
|
getAllEddSearchResults({ id, limit, offset }: rebilly.GetCustomerEddSearchResultCollectionRequest): rebilly.GetCustomerEddSearchResultCollectionResponsePromise;
|
|
86661
86556
|
getEddSearchResult({ id, searchResultId }: {
|
|
86662
86557
|
id: any;
|