rebilly-js-sdk 62.152.0 → 62.154.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.cts +803 -99
- package/dist/rebilly-js-sdk.d.mts +803 -99
- package/dist/rebilly-js-sdk.d.ts +803 -99
- package/dist/rebilly-js-sdk.es.mjs +83 -80
- package/dist/rebilly-js-sdk.umd.js +3 -3
- package/package.json +1 -1
- package/src/resources/customers-resource.js +3 -0
|
@@ -255,10 +255,8 @@ declare namespace rebilly {
|
|
|
255
255
|
type GetCustomerCreditBalanceResponse = operations['GetCustomerCreditBalance']['responses']['200']['content']['application/json']
|
|
256
256
|
type GetCustomerCreditBalanceResponsePromise = Promise<{fields: GetCustomerCreditBalanceResponse}>
|
|
257
257
|
|
|
258
|
-
type
|
|
259
|
-
|
|
260
|
-
type GetCustomerComplianceScreeningReportResponse = operations['GetCustomerComplianceScreeningReport']['responses']['200']
|
|
261
|
-
type GetCustomerComplianceScreeningReportResponsePromise = Promise<{fields: GetCustomerComplianceScreeningReportResponse}>
|
|
258
|
+
type PostCustomerComplianceScreeningReportResponse = operations['PostCustomerComplianceScreeningReport']['responses']['201']['content']['application/json']
|
|
259
|
+
type PostCustomerComplianceScreeningReportResponsePromise = Promise<{fields: PostCustomerComplianceScreeningReportResponse}>
|
|
262
260
|
|
|
263
261
|
type GetDisputeCollectionRequest = operations['GetDisputeCollection']['parameters']["query"] & (operations['GetDisputeCollection']['parameters'] extends {path: {}} ? operations['GetDisputeCollection']['parameters']["path"] : {})
|
|
264
262
|
|
|
@@ -2939,11 +2937,11 @@ export interface corePaths {
|
|
|
2939
2937
|
};
|
|
2940
2938
|
"/customers/{id}/compliance-screening-report": {
|
|
2941
2939
|
/**
|
|
2942
|
-
*
|
|
2943
|
-
* The report
|
|
2940
|
+
* Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer.
|
|
2941
|
+
* The report is stored as a PDF customer attachment.
|
|
2944
2942
|
* Requires the KYC and AML products to be enabled for the organization.
|
|
2945
2943
|
*/
|
|
2946
|
-
|
|
2944
|
+
post: operations["PostCustomerComplianceScreeningReport"];
|
|
2947
2945
|
parameters: {
|
|
2948
2946
|
path: {
|
|
2949
2947
|
/** ID of the resource. */
|
|
@@ -3505,6 +3503,13 @@ export interface corePaths {
|
|
|
3505
3503
|
* Updates the document matches of a KYC document with a specified ID.
|
|
3506
3504
|
*
|
|
3507
3505
|
* > **Note:** Use this operation for manual overrides.
|
|
3506
|
+
*
|
|
3507
|
+
* The request body schema depends on the KYC document `documentType`.
|
|
3508
|
+
* The operation rejects unknown fields.
|
|
3509
|
+
*
|
|
3510
|
+
* Optionally send `type` with one of:
|
|
3511
|
+
* `identity-proof`, `address-proof`, `purchase-proof`, or `funds-proof`.
|
|
3512
|
+
* If provided, `type` matches the document type of the KYC document.
|
|
3508
3513
|
*/
|
|
3509
3514
|
post: operations["PostKycDocumentMatches"];
|
|
3510
3515
|
parameters: {
|
|
@@ -7831,7 +7836,11 @@ export interface coreComponents {
|
|
|
7831
7836
|
leadSource?: coreComponents["schemas"]["LeadSourceData"];
|
|
7832
7837
|
/** ID of the associated person. */
|
|
7833
7838
|
personId?: string | null;
|
|
7834
|
-
/**
|
|
7839
|
+
/**
|
|
7840
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
7841
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
7842
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
7843
|
+
*/
|
|
7835
7844
|
notificationEmails?: string[];
|
|
7836
7845
|
/** Related links. */
|
|
7837
7846
|
_links?: {
|
|
@@ -11233,6 +11242,38 @@ export interface coreComponents {
|
|
|
11233
11242
|
| coreComponents["schemas"]["ProofOfFundsKycDocument"]
|
|
11234
11243
|
| coreComponents["schemas"]["ProofOfPurchaseKycDocument"]
|
|
11235
11244
|
| coreComponents["schemas"]["ProofOfCreditFileKycDocument"];
|
|
11245
|
+
/** Request body for overwriting identity KYC document matches. */
|
|
11246
|
+
KycIdentityMatchesOverwrite: coreComponents["schemas"]["KycIdentityMatches"] & {
|
|
11247
|
+
/**
|
|
11248
|
+
* Type of KYC document matches.
|
|
11249
|
+
* If provided, value is `identity-proof` and matches the document type of the KYC document.
|
|
11250
|
+
*/
|
|
11251
|
+
type?: "identity-proof";
|
|
11252
|
+
};
|
|
11253
|
+
/** Request body for overwriting address KYC document matches. */
|
|
11254
|
+
KycAddressMatchesOverwrite: coreComponents["schemas"]["KycAddressMatches"] & {
|
|
11255
|
+
/**
|
|
11256
|
+
* Type of KYC document matches.
|
|
11257
|
+
* If provided, value is `address-proof` and matches the document type of the KYC document.
|
|
11258
|
+
*/
|
|
11259
|
+
type?: "address-proof";
|
|
11260
|
+
};
|
|
11261
|
+
/** Request body for overwriting purchase KYC document matches. */
|
|
11262
|
+
KycPurchaseMatchesOverwrite: coreComponents["schemas"]["PurchaseMatches"] & {
|
|
11263
|
+
/**
|
|
11264
|
+
* Type of KYC document matches.
|
|
11265
|
+
* If provided, value is `purchase-proof` and matches the document type of the KYC document.
|
|
11266
|
+
*/
|
|
11267
|
+
type?: "purchase-proof";
|
|
11268
|
+
};
|
|
11269
|
+
/** Request body for overwriting funds KYC document matches. */
|
|
11270
|
+
KycFundsMatchesOverwrite: coreComponents["schemas"]["FundsMatches"] & {
|
|
11271
|
+
/**
|
|
11272
|
+
* Type of KYC document matches.
|
|
11273
|
+
* If provided, value is `funds-proof` and matches the document type of the KYC document.
|
|
11274
|
+
*/
|
|
11275
|
+
type?: "funds-proof";
|
|
11276
|
+
};
|
|
11236
11277
|
/** Settings for KYC score calculation. */
|
|
11237
11278
|
KycSettings: {
|
|
11238
11279
|
identityProof?: coreComponents["schemas"]["KycSettingsIdentity"];
|
|
@@ -12849,8 +12890,10 @@ export interface coreComponents {
|
|
|
12849
12890
|
/** ID of the quote. */
|
|
12850
12891
|
id?: string;
|
|
12851
12892
|
/**
|
|
12852
|
-
* Type of the quote.
|
|
12893
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
12853
12894
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
12895
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
12896
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
12854
12897
|
*/
|
|
12855
12898
|
type: "change";
|
|
12856
12899
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -17201,9 +17244,124 @@ export interface coreComponents {
|
|
|
17201
17244
|
| coreComponents["schemas"]["TaxJarCredential"]
|
|
17202
17245
|
| coreComponents["schemas"]["AvalaraCredential"]
|
|
17203
17246
|
| coreComponents["schemas"]["PlaidCredential"];
|
|
17247
|
+
PostSmtpCredential: coreComponents["schemas"]["SmtpCredential"] & {
|
|
17248
|
+
/**
|
|
17249
|
+
* Type of the credential.
|
|
17250
|
+
* Value that matches the `{type}` path parameter.
|
|
17251
|
+
* For backward compatibility, when this field is absent,
|
|
17252
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17253
|
+
*/
|
|
17254
|
+
type: "smtp";
|
|
17255
|
+
};
|
|
17256
|
+
PostWebhookCredential: coreComponents["schemas"]["WebhookCredential"] & {
|
|
17257
|
+
/**
|
|
17258
|
+
* Type of the credential.
|
|
17259
|
+
* Value that matches the `{type}` path parameter.
|
|
17260
|
+
* For backward compatibility, when this field is absent,
|
|
17261
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17262
|
+
*/
|
|
17263
|
+
type: "webhook";
|
|
17264
|
+
};
|
|
17265
|
+
PostExperianCredential: coreComponents["schemas"]["ExperianCredential"] & {
|
|
17266
|
+
/**
|
|
17267
|
+
* Type of the credential.
|
|
17268
|
+
* Value that matches the `{type}` path parameter.
|
|
17269
|
+
* For backward compatibility, when this field is absent,
|
|
17270
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17271
|
+
*/
|
|
17272
|
+
type: "experian";
|
|
17273
|
+
};
|
|
17274
|
+
PostMailgunCredential: coreComponents["schemas"]["MailgunCredential"] & {
|
|
17275
|
+
/**
|
|
17276
|
+
* Type of the credential.
|
|
17277
|
+
* Value that matches the `{type}` path parameter.
|
|
17278
|
+
* For backward compatibility, when this field is absent,
|
|
17279
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17280
|
+
*/
|
|
17281
|
+
type: "mailgun";
|
|
17282
|
+
};
|
|
17283
|
+
PostOAuth2Credential: coreComponents["schemas"]["OAuth2Credential"] & {
|
|
17284
|
+
/**
|
|
17285
|
+
* Type of the credential.
|
|
17286
|
+
* Value that matches the `{type}` path parameter.
|
|
17287
|
+
* For backward compatibility, when this field is absent,
|
|
17288
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17289
|
+
*/
|
|
17290
|
+
type: "oauth2";
|
|
17291
|
+
};
|
|
17292
|
+
PostPostmarkCredential: coreComponents["schemas"]["PostmarkCredential"] & {
|
|
17293
|
+
/**
|
|
17294
|
+
* Type of the credential.
|
|
17295
|
+
* Value that matches the `{type}` path parameter.
|
|
17296
|
+
* For backward compatibility, when this field is absent,
|
|
17297
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17298
|
+
*/
|
|
17299
|
+
type: "postmark";
|
|
17300
|
+
};
|
|
17301
|
+
PostSendGridCredential: coreComponents["schemas"]["SendGridCredential"] & {
|
|
17302
|
+
/**
|
|
17303
|
+
* Type of the credential.
|
|
17304
|
+
* Value that matches the `{type}` path parameter.
|
|
17305
|
+
* For backward compatibility, when this field is absent,
|
|
17306
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17307
|
+
*/
|
|
17308
|
+
type: "sendgrid";
|
|
17309
|
+
};
|
|
17310
|
+
PostAwsSesCredential: coreComponents["schemas"]["SESCredential"] & {
|
|
17311
|
+
/**
|
|
17312
|
+
* Type of the credential.
|
|
17313
|
+
* Value that matches the `{type}` path parameter.
|
|
17314
|
+
* For backward compatibility, when this field is absent,
|
|
17315
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17316
|
+
*/
|
|
17317
|
+
type: "aws-ses";
|
|
17318
|
+
};
|
|
17319
|
+
PostTaxJarCredential: coreComponents["schemas"]["TaxJarCredential"] & {
|
|
17320
|
+
/**
|
|
17321
|
+
* Type of the credential.
|
|
17322
|
+
* Value that matches the `{type}` path parameter.
|
|
17323
|
+
* For backward compatibility, when this field is absent,
|
|
17324
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17325
|
+
*/
|
|
17326
|
+
type: "taxjar";
|
|
17327
|
+
};
|
|
17328
|
+
PostAvalaraCredential: coreComponents["schemas"]["AvalaraCredential"] & {
|
|
17329
|
+
/**
|
|
17330
|
+
* Type of the credential.
|
|
17331
|
+
* Value that matches the `{type}` path parameter.
|
|
17332
|
+
* For backward compatibility, when this field is absent,
|
|
17333
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17334
|
+
*/
|
|
17335
|
+
type: "avalara";
|
|
17336
|
+
};
|
|
17337
|
+
PostPlaidCredential: coreComponents["schemas"]["PlaidCredential"] & {
|
|
17338
|
+
/**
|
|
17339
|
+
* Type of the credential.
|
|
17340
|
+
* Value that matches the `{type}` path parameter.
|
|
17341
|
+
* For backward compatibility, when this field is absent,
|
|
17342
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17343
|
+
*/
|
|
17344
|
+
type: "plaid";
|
|
17345
|
+
};
|
|
17204
17346
|
PatchServiceCredential: {
|
|
17205
17347
|
/** Status of the credential. */
|
|
17206
17348
|
status: "active" | "inactive" | "deactivated";
|
|
17349
|
+
/**
|
|
17350
|
+
* Type of the credential.
|
|
17351
|
+
* Value that matches the `{type}` path parameter.
|
|
17352
|
+
* For backward compatibility, when this field is absent,
|
|
17353
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17354
|
+
*/
|
|
17355
|
+
type:
|
|
17356
|
+
| "smtp"
|
|
17357
|
+
| "webhook"
|
|
17358
|
+
| "mailgun"
|
|
17359
|
+
| "sendgrid"
|
|
17360
|
+
| "aws-ses"
|
|
17361
|
+
| "oauth2"
|
|
17362
|
+
| "postmark"
|
|
17363
|
+
| "experian"
|
|
17364
|
+
| "avalara";
|
|
17207
17365
|
};
|
|
17208
17366
|
/** Plaid credential. */
|
|
17209
17367
|
PatchPlaidCredential: {
|
|
@@ -17223,6 +17381,13 @@ export interface coreComponents {
|
|
|
17223
17381
|
* This setting enables the creation of Stripe bank account tokens.
|
|
17224
17382
|
*/
|
|
17225
17383
|
useStripe?: boolean;
|
|
17384
|
+
/**
|
|
17385
|
+
* Type of the credential.
|
|
17386
|
+
* Value that matches the `{type}` path parameter.
|
|
17387
|
+
* For backward compatibility, when this field is absent,
|
|
17388
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17389
|
+
*/
|
|
17390
|
+
type: "plaid";
|
|
17226
17391
|
};
|
|
17227
17392
|
/** TaxJar credential. */
|
|
17228
17393
|
PatchTaxJarCredential: {
|
|
@@ -17233,6 +17398,13 @@ export interface coreComponents {
|
|
|
17233
17398
|
* For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
|
|
17234
17399
|
*/
|
|
17235
17400
|
omitFromAddress?: boolean;
|
|
17401
|
+
/**
|
|
17402
|
+
* Type of the credential.
|
|
17403
|
+
* Value that matches the `{type}` path parameter.
|
|
17404
|
+
* For backward compatibility, when this field is absent,
|
|
17405
|
+
* the `{type}` path parameter supplies the credential type.
|
|
17406
|
+
*/
|
|
17407
|
+
type: "taxjar";
|
|
17236
17408
|
};
|
|
17237
17409
|
GoogleSpreadsheet: {
|
|
17238
17410
|
/** ID of the Google Spreadsheet. */
|
|
@@ -18366,6 +18538,10 @@ export interface coreComponents {
|
|
|
18366
18538
|
riskProfile?: string;
|
|
18367
18539
|
/** Name of the transaction custom field that holds the Level 2/3 data. */
|
|
18368
18540
|
levelTwoThreeDataCustomField?: string;
|
|
18541
|
+
/** ID of the Digital Payment Application (DPA) for Mastercard Secure Card on File (SCOF). */
|
|
18542
|
+
mastercardDpaId?: string;
|
|
18543
|
+
/** ID of the Mastercard Secure Card on File (SCOF) service. */
|
|
18544
|
+
mastercardServiceId?: string;
|
|
18369
18545
|
};
|
|
18370
18546
|
threeDSecureServer?: coreComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
18371
18547
|
};
|
|
@@ -20423,6 +20599,8 @@ export interface coreComponents {
|
|
|
20423
20599
|
tokenApiKey: string;
|
|
20424
20600
|
/** Paybilt API key. */
|
|
20425
20601
|
apiKey: string;
|
|
20602
|
+
/** Paybilt HMAC key used to verify webhook signatures. */
|
|
20603
|
+
hmacKey?: string;
|
|
20426
20604
|
};
|
|
20427
20605
|
threeDSecureServer?: coreComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
20428
20606
|
settings?: {
|
|
@@ -23560,6 +23738,10 @@ export interface coreComponents {
|
|
|
23560
23738
|
*/
|
|
23561
23739
|
start?: string;
|
|
23562
23740
|
};
|
|
23741
|
+
/** Reason the export failed, if the export status is `failed`. */
|
|
23742
|
+
DataExportFailureReason:
|
|
23743
|
+
| ("record-limit-exceeded" | "max-retries-reached")
|
|
23744
|
+
| null;
|
|
23563
23745
|
/**
|
|
23564
23746
|
* Date range of the data export.
|
|
23565
23747
|
* If this value is not set, all data is included.
|
|
@@ -23609,7 +23791,8 @@ export interface coreComponents {
|
|
|
23609
23791
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23610
23792
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23611
23793
|
/** Status of export request. */
|
|
23612
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
23794
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
23795
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23613
23796
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23614
23797
|
field?: string;
|
|
23615
23798
|
};
|
|
@@ -23656,7 +23839,8 @@ export interface coreComponents {
|
|
|
23656
23839
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23657
23840
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23658
23841
|
/** Status of export request. */
|
|
23659
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
23842
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
23843
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23660
23844
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23661
23845
|
field?: string;
|
|
23662
23846
|
};
|
|
@@ -23703,7 +23887,8 @@ export interface coreComponents {
|
|
|
23703
23887
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23704
23888
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23705
23889
|
/** Status of export request. */
|
|
23706
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
23890
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
23891
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23707
23892
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23708
23893
|
field?: string;
|
|
23709
23894
|
};
|
|
@@ -23750,7 +23935,8 @@ export interface coreComponents {
|
|
|
23750
23935
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23751
23936
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23752
23937
|
/** Status of export request. */
|
|
23753
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
23938
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
23939
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23754
23940
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23755
23941
|
field?: string;
|
|
23756
23942
|
};
|
|
@@ -23797,7 +23983,8 @@ export interface coreComponents {
|
|
|
23797
23983
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23798
23984
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23799
23985
|
/** Status of export request. */
|
|
23800
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
23986
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
23987
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23801
23988
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23802
23989
|
field?: string;
|
|
23803
23990
|
};
|
|
@@ -23844,7 +24031,8 @@ export interface coreComponents {
|
|
|
23844
24031
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23845
24032
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23846
24033
|
/** Status of export request. */
|
|
23847
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24034
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24035
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23848
24036
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23849
24037
|
field?: string;
|
|
23850
24038
|
};
|
|
@@ -23891,7 +24079,8 @@ export interface coreComponents {
|
|
|
23891
24079
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23892
24080
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23893
24081
|
/** Status of the export request. */
|
|
23894
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24082
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24083
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23895
24084
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23896
24085
|
field?: string;
|
|
23897
24086
|
};
|
|
@@ -23938,7 +24127,8 @@ export interface coreComponents {
|
|
|
23938
24127
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23939
24128
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23940
24129
|
/** Status of export request. */
|
|
23941
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24130
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24131
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23942
24132
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23943
24133
|
field?: string;
|
|
23944
24134
|
};
|
|
@@ -23985,7 +24175,8 @@ export interface coreComponents {
|
|
|
23985
24175
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
23986
24176
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
23987
24177
|
/** Status of the export request. */
|
|
23988
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24178
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24179
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
23989
24180
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
23990
24181
|
field?: string;
|
|
23991
24182
|
};
|
|
@@ -24032,7 +24223,8 @@ export interface coreComponents {
|
|
|
24032
24223
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
24033
24224
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
24034
24225
|
/** Status of the export request. */
|
|
24035
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24226
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24227
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
24036
24228
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
24037
24229
|
field?: string;
|
|
24038
24230
|
};
|
|
@@ -24079,7 +24271,8 @@ export interface coreComponents {
|
|
|
24079
24271
|
createdTime?: coreComponents["schemas"]["CreatedTime"];
|
|
24080
24272
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
24081
24273
|
/** Status of the export request. */
|
|
24082
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
24274
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
24275
|
+
failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
|
|
24083
24276
|
dateRange?: coreComponents["schemas"]["DataExportDateRange"] & {
|
|
24084
24277
|
field?: string;
|
|
24085
24278
|
};
|
|
@@ -24108,6 +24301,17 @@ export interface coreComponents {
|
|
|
24108
24301
|
| coreComponents["schemas"]["PayoutRequestsDataExport"]
|
|
24109
24302
|
| coreComponents["schemas"]["PayoutRequestAllocationsDataExport"]
|
|
24110
24303
|
| coreComponents["schemas"]["UsersDataExport"];
|
|
24304
|
+
DataExportLimitExceeded: { [key: string]: any } & {
|
|
24305
|
+
/** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
|
|
24306
|
+
type: "data-export-limit-exceeded";
|
|
24307
|
+
/** HTTP status code. */
|
|
24308
|
+
status?: number;
|
|
24309
|
+
} & coreComponents["schemas"]["DetailedProblem"] & {
|
|
24310
|
+
/** Number of records that match the export request. */
|
|
24311
|
+
matchedRecords: number;
|
|
24312
|
+
/** Maximum number of records for a single export. */
|
|
24313
|
+
maxRecords: number;
|
|
24314
|
+
};
|
|
24111
24315
|
OrganizationExport: {
|
|
24112
24316
|
/** Unique resource ID. */
|
|
24113
24317
|
id?: string;
|
|
@@ -24884,13 +25088,13 @@ export interface coreComponents {
|
|
|
24884
25088
|
};
|
|
24885
25089
|
SubscriptionSummaryMetrics: {
|
|
24886
25090
|
/** Currency code in ISO 4217 format. */
|
|
24887
|
-
currency
|
|
25091
|
+
currency: string;
|
|
24888
25092
|
/** Total amount of all issued, past due, and paid invoices. */
|
|
24889
|
-
invoicedAmount
|
|
25093
|
+
invoicedAmount: number;
|
|
24890
25094
|
/** Total amount of all paid invoices. */
|
|
24891
|
-
collectedAmount
|
|
25095
|
+
collectedAmount: number;
|
|
24892
25096
|
/** Number of issued, past due, or paid invoices. */
|
|
24893
|
-
invoiceCount
|
|
25097
|
+
invoiceCount: number;
|
|
24894
25098
|
};
|
|
24895
25099
|
StorefrontAccount: {
|
|
24896
25100
|
/** ID of the account. */
|
|
@@ -24924,7 +25128,11 @@ export interface coreComponents {
|
|
|
24924
25128
|
updatedTime?: coreComponents["schemas"]["UpdatedTime"];
|
|
24925
25129
|
/** Tax numbers associated with the account. */
|
|
24926
25130
|
taxNumbers?: coreComponents["schemas"]["TaxNumber"][] | null;
|
|
24927
|
-
/**
|
|
25131
|
+
/**
|
|
25132
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
25133
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
25134
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
25135
|
+
*/
|
|
24928
25136
|
notificationEmails?: string[];
|
|
24929
25137
|
_links?: coreComponents["schemas"]["SelfLink"];
|
|
24930
25138
|
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
@@ -26262,8 +26470,10 @@ export interface coreComponents {
|
|
|
26262
26470
|
/** ID of the quote. */
|
|
26263
26471
|
id?: string;
|
|
26264
26472
|
/**
|
|
26265
|
-
* Type of the quote.
|
|
26473
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
26266
26474
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
26475
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
26476
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
26267
26477
|
*/
|
|
26268
26478
|
type?: "change";
|
|
26269
26479
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -27754,6 +27964,14 @@ export interface coreComponents {
|
|
|
27754
27964
|
"application/json": coreComponents["schemas"]["BadRequest"];
|
|
27755
27965
|
};
|
|
27756
27966
|
};
|
|
27967
|
+
/** Invalid data sent, or the export exceeds the maximum record limit. */
|
|
27968
|
+
DataExportValidationError: {
|
|
27969
|
+
content: {
|
|
27970
|
+
"application/json":
|
|
27971
|
+
| coreComponents["schemas"]["ValidationError"]
|
|
27972
|
+
| coreComponents["schemas"]["DataExportLimitExceeded"];
|
|
27973
|
+
};
|
|
27974
|
+
};
|
|
27757
27975
|
/**
|
|
27758
27976
|
* Request accepted.
|
|
27759
27977
|
* No response body returned.
|
|
@@ -28537,13 +28755,29 @@ export interface coreComponents {
|
|
|
28537
28755
|
};
|
|
28538
28756
|
};
|
|
28539
28757
|
/** Service credential resource. */
|
|
28758
|
+
PostCredential: {
|
|
28759
|
+
content: {
|
|
28760
|
+
"application/json":
|
|
28761
|
+
| coreComponents["schemas"]["PostSmtpCredential"]
|
|
28762
|
+
| coreComponents["schemas"]["PostWebhookCredential"]
|
|
28763
|
+
| coreComponents["schemas"]["PostExperianCredential"]
|
|
28764
|
+
| coreComponents["schemas"]["PostMailgunCredential"]
|
|
28765
|
+
| coreComponents["schemas"]["PostOAuth2Credential"]
|
|
28766
|
+
| coreComponents["schemas"]["PostPostmarkCredential"]
|
|
28767
|
+
| coreComponents["schemas"]["PostSendGridCredential"]
|
|
28768
|
+
| coreComponents["schemas"]["PostAwsSesCredential"]
|
|
28769
|
+
| coreComponents["schemas"]["PostTaxJarCredential"]
|
|
28770
|
+
| coreComponents["schemas"]["PostAvalaraCredential"]
|
|
28771
|
+
| coreComponents["schemas"]["PostPlaidCredential"];
|
|
28772
|
+
};
|
|
28773
|
+
};
|
|
28774
|
+
/** Service credential resource. */
|
|
28540
28775
|
PatchCredential: {
|
|
28541
28776
|
content: {
|
|
28542
|
-
"application/json":
|
|
28543
|
-
coreComponents["schemas"]["PatchServiceCredential"]
|
|
28544
|
-
|
|
28545
|
-
|
|
28546
|
-
Partial<coreComponents["schemas"]["PatchTaxJarCredential"]>;
|
|
28777
|
+
"application/json":
|
|
28778
|
+
| coreComponents["schemas"]["PatchServiceCredential"]
|
|
28779
|
+
| coreComponents["schemas"]["PatchPlaidCredential"]
|
|
28780
|
+
| coreComponents["schemas"]["PatchTaxJarCredential"];
|
|
28547
28781
|
};
|
|
28548
28782
|
};
|
|
28549
28783
|
/** Ruleset resource. */
|
|
@@ -31618,11 +31852,11 @@ export interface operations {
|
|
|
31618
31852
|
};
|
|
31619
31853
|
};
|
|
31620
31854
|
/**
|
|
31621
|
-
*
|
|
31622
|
-
* The report
|
|
31855
|
+
* Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer.
|
|
31856
|
+
* The report is stored as a PDF customer attachment.
|
|
31623
31857
|
* Requires the KYC and AML products to be enabled for the organization.
|
|
31624
31858
|
*/
|
|
31625
|
-
|
|
31859
|
+
PostCustomerComplianceScreeningReport: {
|
|
31626
31860
|
parameters: {
|
|
31627
31861
|
path: {
|
|
31628
31862
|
/** ID of the resource. */
|
|
@@ -31630,15 +31864,17 @@ export interface operations {
|
|
|
31630
31864
|
};
|
|
31631
31865
|
};
|
|
31632
31866
|
responses: {
|
|
31633
|
-
/** Compliance screening report
|
|
31634
|
-
|
|
31867
|
+
/** Compliance screening report generated. */
|
|
31868
|
+
201: {
|
|
31869
|
+
headers: {};
|
|
31635
31870
|
content: {
|
|
31636
|
-
"application/
|
|
31871
|
+
"application/json": coreComponents["schemas"]["Attachment"];
|
|
31637
31872
|
};
|
|
31638
31873
|
};
|
|
31639
31874
|
401: coreComponents["responses"]["Unauthorized"];
|
|
31640
31875
|
403: coreComponents["responses"]["Forbidden"];
|
|
31641
31876
|
404: coreComponents["responses"]["NotFound"];
|
|
31877
|
+
429: coreComponents["responses"]["TooManyRequests"];
|
|
31642
31878
|
};
|
|
31643
31879
|
};
|
|
31644
31880
|
/** Retrieves a list of all disputes. */
|
|
@@ -33982,6 +34218,13 @@ export interface operations {
|
|
|
33982
34218
|
* Updates the document matches of a KYC document with a specified ID.
|
|
33983
34219
|
*
|
|
33984
34220
|
* > **Note:** Use this operation for manual overrides.
|
|
34221
|
+
*
|
|
34222
|
+
* The request body schema depends on the KYC document `documentType`.
|
|
34223
|
+
* The operation rejects unknown fields.
|
|
34224
|
+
*
|
|
34225
|
+
* Optionally send `type` with one of:
|
|
34226
|
+
* `identity-proof`, `address-proof`, `purchase-proof`, or `funds-proof`.
|
|
34227
|
+
* If provided, `type` matches the document type of the KYC document.
|
|
33985
34228
|
*/
|
|
33986
34229
|
PostKycDocumentMatches: {
|
|
33987
34230
|
parameters: {
|
|
@@ -33996,15 +34239,18 @@ export interface operations {
|
|
|
33996
34239
|
401: coreComponents["responses"]["Unauthorized"];
|
|
33997
34240
|
403: coreComponents["responses"]["Forbidden"];
|
|
33998
34241
|
404: coreComponents["responses"]["NotFound"];
|
|
34242
|
+
422: coreComponents["responses"]["ValidationError"];
|
|
33999
34243
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
34000
34244
|
};
|
|
34001
|
-
/**
|
|
34245
|
+
/** KYC document matches overwrite payload. */
|
|
34002
34246
|
requestBody: {
|
|
34003
34247
|
content: {
|
|
34004
34248
|
"application/json": Partial<
|
|
34005
|
-
coreComponents["schemas"]["
|
|
34249
|
+
coreComponents["schemas"]["KycIdentityMatchesOverwrite"]
|
|
34006
34250
|
> &
|
|
34007
|
-
Partial<coreComponents["schemas"]["
|
|
34251
|
+
Partial<coreComponents["schemas"]["KycAddressMatchesOverwrite"]> &
|
|
34252
|
+
Partial<coreComponents["schemas"]["KycPurchaseMatchesOverwrite"]> &
|
|
34253
|
+
Partial<coreComponents["schemas"]["KycFundsMatchesOverwrite"]>;
|
|
34008
34254
|
};
|
|
34009
34255
|
};
|
|
34010
34256
|
};
|
|
@@ -39283,12 +39529,7 @@ export interface operations {
|
|
|
39283
39529
|
422: coreComponents["responses"]["ValidationError"];
|
|
39284
39530
|
429: coreComponents["responses"]["TooManyRequests"];
|
|
39285
39531
|
};
|
|
39286
|
-
|
|
39287
|
-
requestBody: {
|
|
39288
|
-
content: {
|
|
39289
|
-
"application/json": coreComponents["schemas"]["ServiceCredential"];
|
|
39290
|
-
};
|
|
39291
|
-
};
|
|
39532
|
+
requestBody: coreComponents["requestBodies"]["PostCredential"];
|
|
39292
39533
|
};
|
|
39293
39534
|
/** Retrieves a service credential with a specified ID. */
|
|
39294
39535
|
GetServiceCredential: {
|
|
@@ -46573,7 +46814,11 @@ export interface storefrontComponents {
|
|
|
46573
46814
|
leadSource?: storefrontComponents["schemas"]["LeadSourceData"];
|
|
46574
46815
|
/** ID of the associated person. */
|
|
46575
46816
|
personId?: string | null;
|
|
46576
|
-
/**
|
|
46817
|
+
/**
|
|
46818
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
46819
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
46820
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
46821
|
+
*/
|
|
46577
46822
|
notificationEmails?: string[];
|
|
46578
46823
|
/** Related links. */
|
|
46579
46824
|
_links?: {
|
|
@@ -49975,6 +50220,38 @@ export interface storefrontComponents {
|
|
|
49975
50220
|
| storefrontComponents["schemas"]["ProofOfFundsKycDocument"]
|
|
49976
50221
|
| storefrontComponents["schemas"]["ProofOfPurchaseKycDocument"]
|
|
49977
50222
|
| storefrontComponents["schemas"]["ProofOfCreditFileKycDocument"];
|
|
50223
|
+
/** Request body for overwriting identity KYC document matches. */
|
|
50224
|
+
KycIdentityMatchesOverwrite: storefrontComponents["schemas"]["KycIdentityMatches"] & {
|
|
50225
|
+
/**
|
|
50226
|
+
* Type of KYC document matches.
|
|
50227
|
+
* If provided, value is `identity-proof` and matches the document type of the KYC document.
|
|
50228
|
+
*/
|
|
50229
|
+
type?: "identity-proof";
|
|
50230
|
+
};
|
|
50231
|
+
/** Request body for overwriting address KYC document matches. */
|
|
50232
|
+
KycAddressMatchesOverwrite: storefrontComponents["schemas"]["KycAddressMatches"] & {
|
|
50233
|
+
/**
|
|
50234
|
+
* Type of KYC document matches.
|
|
50235
|
+
* If provided, value is `address-proof` and matches the document type of the KYC document.
|
|
50236
|
+
*/
|
|
50237
|
+
type?: "address-proof";
|
|
50238
|
+
};
|
|
50239
|
+
/** Request body for overwriting purchase KYC document matches. */
|
|
50240
|
+
KycPurchaseMatchesOverwrite: storefrontComponents["schemas"]["PurchaseMatches"] & {
|
|
50241
|
+
/**
|
|
50242
|
+
* Type of KYC document matches.
|
|
50243
|
+
* If provided, value is `purchase-proof` and matches the document type of the KYC document.
|
|
50244
|
+
*/
|
|
50245
|
+
type?: "purchase-proof";
|
|
50246
|
+
};
|
|
50247
|
+
/** Request body for overwriting funds KYC document matches. */
|
|
50248
|
+
KycFundsMatchesOverwrite: storefrontComponents["schemas"]["FundsMatches"] & {
|
|
50249
|
+
/**
|
|
50250
|
+
* Type of KYC document matches.
|
|
50251
|
+
* If provided, value is `funds-proof` and matches the document type of the KYC document.
|
|
50252
|
+
*/
|
|
50253
|
+
type?: "funds-proof";
|
|
50254
|
+
};
|
|
49978
50255
|
/** Settings for KYC score calculation. */
|
|
49979
50256
|
KycSettings: {
|
|
49980
50257
|
identityProof?: storefrontComponents["schemas"]["KycSettingsIdentity"];
|
|
@@ -51591,8 +51868,10 @@ export interface storefrontComponents {
|
|
|
51591
51868
|
/** ID of the quote. */
|
|
51592
51869
|
id?: string;
|
|
51593
51870
|
/**
|
|
51594
|
-
* Type of the quote.
|
|
51871
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
51595
51872
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
51873
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
51874
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
51596
51875
|
*/
|
|
51597
51876
|
type: "change";
|
|
51598
51877
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -55943,9 +56222,124 @@ export interface storefrontComponents {
|
|
|
55943
56222
|
| storefrontComponents["schemas"]["TaxJarCredential"]
|
|
55944
56223
|
| storefrontComponents["schemas"]["AvalaraCredential"]
|
|
55945
56224
|
| storefrontComponents["schemas"]["PlaidCredential"];
|
|
56225
|
+
PostSmtpCredential: storefrontComponents["schemas"]["SmtpCredential"] & {
|
|
56226
|
+
/**
|
|
56227
|
+
* Type of the credential.
|
|
56228
|
+
* Value that matches the `{type}` path parameter.
|
|
56229
|
+
* For backward compatibility, when this field is absent,
|
|
56230
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56231
|
+
*/
|
|
56232
|
+
type: "smtp";
|
|
56233
|
+
};
|
|
56234
|
+
PostWebhookCredential: storefrontComponents["schemas"]["WebhookCredential"] & {
|
|
56235
|
+
/**
|
|
56236
|
+
* Type of the credential.
|
|
56237
|
+
* Value that matches the `{type}` path parameter.
|
|
56238
|
+
* For backward compatibility, when this field is absent,
|
|
56239
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56240
|
+
*/
|
|
56241
|
+
type: "webhook";
|
|
56242
|
+
};
|
|
56243
|
+
PostExperianCredential: storefrontComponents["schemas"]["ExperianCredential"] & {
|
|
56244
|
+
/**
|
|
56245
|
+
* Type of the credential.
|
|
56246
|
+
* Value that matches the `{type}` path parameter.
|
|
56247
|
+
* For backward compatibility, when this field is absent,
|
|
56248
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56249
|
+
*/
|
|
56250
|
+
type: "experian";
|
|
56251
|
+
};
|
|
56252
|
+
PostMailgunCredential: storefrontComponents["schemas"]["MailgunCredential"] & {
|
|
56253
|
+
/**
|
|
56254
|
+
* Type of the credential.
|
|
56255
|
+
* Value that matches the `{type}` path parameter.
|
|
56256
|
+
* For backward compatibility, when this field is absent,
|
|
56257
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56258
|
+
*/
|
|
56259
|
+
type: "mailgun";
|
|
56260
|
+
};
|
|
56261
|
+
PostOAuth2Credential: storefrontComponents["schemas"]["OAuth2Credential"] & {
|
|
56262
|
+
/**
|
|
56263
|
+
* Type of the credential.
|
|
56264
|
+
* Value that matches the `{type}` path parameter.
|
|
56265
|
+
* For backward compatibility, when this field is absent,
|
|
56266
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56267
|
+
*/
|
|
56268
|
+
type: "oauth2";
|
|
56269
|
+
};
|
|
56270
|
+
PostPostmarkCredential: storefrontComponents["schemas"]["PostmarkCredential"] & {
|
|
56271
|
+
/**
|
|
56272
|
+
* Type of the credential.
|
|
56273
|
+
* Value that matches the `{type}` path parameter.
|
|
56274
|
+
* For backward compatibility, when this field is absent,
|
|
56275
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56276
|
+
*/
|
|
56277
|
+
type: "postmark";
|
|
56278
|
+
};
|
|
56279
|
+
PostSendGridCredential: storefrontComponents["schemas"]["SendGridCredential"] & {
|
|
56280
|
+
/**
|
|
56281
|
+
* Type of the credential.
|
|
56282
|
+
* Value that matches the `{type}` path parameter.
|
|
56283
|
+
* For backward compatibility, when this field is absent,
|
|
56284
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56285
|
+
*/
|
|
56286
|
+
type: "sendgrid";
|
|
56287
|
+
};
|
|
56288
|
+
PostAwsSesCredential: storefrontComponents["schemas"]["SESCredential"] & {
|
|
56289
|
+
/**
|
|
56290
|
+
* Type of the credential.
|
|
56291
|
+
* Value that matches the `{type}` path parameter.
|
|
56292
|
+
* For backward compatibility, when this field is absent,
|
|
56293
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56294
|
+
*/
|
|
56295
|
+
type: "aws-ses";
|
|
56296
|
+
};
|
|
56297
|
+
PostTaxJarCredential: storefrontComponents["schemas"]["TaxJarCredential"] & {
|
|
56298
|
+
/**
|
|
56299
|
+
* Type of the credential.
|
|
56300
|
+
* Value that matches the `{type}` path parameter.
|
|
56301
|
+
* For backward compatibility, when this field is absent,
|
|
56302
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56303
|
+
*/
|
|
56304
|
+
type: "taxjar";
|
|
56305
|
+
};
|
|
56306
|
+
PostAvalaraCredential: storefrontComponents["schemas"]["AvalaraCredential"] & {
|
|
56307
|
+
/**
|
|
56308
|
+
* Type of the credential.
|
|
56309
|
+
* Value that matches the `{type}` path parameter.
|
|
56310
|
+
* For backward compatibility, when this field is absent,
|
|
56311
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56312
|
+
*/
|
|
56313
|
+
type: "avalara";
|
|
56314
|
+
};
|
|
56315
|
+
PostPlaidCredential: storefrontComponents["schemas"]["PlaidCredential"] & {
|
|
56316
|
+
/**
|
|
56317
|
+
* Type of the credential.
|
|
56318
|
+
* Value that matches the `{type}` path parameter.
|
|
56319
|
+
* For backward compatibility, when this field is absent,
|
|
56320
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56321
|
+
*/
|
|
56322
|
+
type: "plaid";
|
|
56323
|
+
};
|
|
55946
56324
|
PatchServiceCredential: {
|
|
55947
56325
|
/** Status of the credential. */
|
|
55948
56326
|
status: "active" | "inactive" | "deactivated";
|
|
56327
|
+
/**
|
|
56328
|
+
* Type of the credential.
|
|
56329
|
+
* Value that matches the `{type}` path parameter.
|
|
56330
|
+
* For backward compatibility, when this field is absent,
|
|
56331
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56332
|
+
*/
|
|
56333
|
+
type:
|
|
56334
|
+
| "smtp"
|
|
56335
|
+
| "webhook"
|
|
56336
|
+
| "mailgun"
|
|
56337
|
+
| "sendgrid"
|
|
56338
|
+
| "aws-ses"
|
|
56339
|
+
| "oauth2"
|
|
56340
|
+
| "postmark"
|
|
56341
|
+
| "experian"
|
|
56342
|
+
| "avalara";
|
|
55949
56343
|
};
|
|
55950
56344
|
/** Plaid credential. */
|
|
55951
56345
|
PatchPlaidCredential: {
|
|
@@ -55965,6 +56359,13 @@ export interface storefrontComponents {
|
|
|
55965
56359
|
* This setting enables the creation of Stripe bank account tokens.
|
|
55966
56360
|
*/
|
|
55967
56361
|
useStripe?: boolean;
|
|
56362
|
+
/**
|
|
56363
|
+
* Type of the credential.
|
|
56364
|
+
* Value that matches the `{type}` path parameter.
|
|
56365
|
+
* For backward compatibility, when this field is absent,
|
|
56366
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56367
|
+
*/
|
|
56368
|
+
type: "plaid";
|
|
55968
56369
|
};
|
|
55969
56370
|
/** TaxJar credential. */
|
|
55970
56371
|
PatchTaxJarCredential: {
|
|
@@ -55975,6 +56376,13 @@ export interface storefrontComponents {
|
|
|
55975
56376
|
* For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
|
|
55976
56377
|
*/
|
|
55977
56378
|
omitFromAddress?: boolean;
|
|
56379
|
+
/**
|
|
56380
|
+
* Type of the credential.
|
|
56381
|
+
* Value that matches the `{type}` path parameter.
|
|
56382
|
+
* For backward compatibility, when this field is absent,
|
|
56383
|
+
* the `{type}` path parameter supplies the credential type.
|
|
56384
|
+
*/
|
|
56385
|
+
type: "taxjar";
|
|
55978
56386
|
};
|
|
55979
56387
|
GoogleSpreadsheet: {
|
|
55980
56388
|
/** ID of the Google Spreadsheet. */
|
|
@@ -57108,6 +57516,10 @@ export interface storefrontComponents {
|
|
|
57108
57516
|
riskProfile?: string;
|
|
57109
57517
|
/** Name of the transaction custom field that holds the Level 2/3 data. */
|
|
57110
57518
|
levelTwoThreeDataCustomField?: string;
|
|
57519
|
+
/** ID of the Digital Payment Application (DPA) for Mastercard Secure Card on File (SCOF). */
|
|
57520
|
+
mastercardDpaId?: string;
|
|
57521
|
+
/** ID of the Mastercard Secure Card on File (SCOF) service. */
|
|
57522
|
+
mastercardServiceId?: string;
|
|
57111
57523
|
};
|
|
57112
57524
|
threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
57113
57525
|
};
|
|
@@ -59165,6 +59577,8 @@ export interface storefrontComponents {
|
|
|
59165
59577
|
tokenApiKey: string;
|
|
59166
59578
|
/** Paybilt API key. */
|
|
59167
59579
|
apiKey: string;
|
|
59580
|
+
/** Paybilt HMAC key used to verify webhook signatures. */
|
|
59581
|
+
hmacKey?: string;
|
|
59168
59582
|
};
|
|
59169
59583
|
threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
59170
59584
|
settings?: {
|
|
@@ -62302,6 +62716,10 @@ export interface storefrontComponents {
|
|
|
62302
62716
|
*/
|
|
62303
62717
|
start?: string;
|
|
62304
62718
|
};
|
|
62719
|
+
/** Reason the export failed, if the export status is `failed`. */
|
|
62720
|
+
DataExportFailureReason:
|
|
62721
|
+
| ("record-limit-exceeded" | "max-retries-reached")
|
|
62722
|
+
| null;
|
|
62305
62723
|
/**
|
|
62306
62724
|
* Date range of the data export.
|
|
62307
62725
|
* If this value is not set, all data is included.
|
|
@@ -62351,7 +62769,8 @@ export interface storefrontComponents {
|
|
|
62351
62769
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62352
62770
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62353
62771
|
/** Status of export request. */
|
|
62354
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
62772
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
62773
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62355
62774
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62356
62775
|
field?: string;
|
|
62357
62776
|
};
|
|
@@ -62398,7 +62817,8 @@ export interface storefrontComponents {
|
|
|
62398
62817
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62399
62818
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62400
62819
|
/** Status of export request. */
|
|
62401
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
62820
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
62821
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62402
62822
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62403
62823
|
field?: string;
|
|
62404
62824
|
};
|
|
@@ -62445,7 +62865,8 @@ export interface storefrontComponents {
|
|
|
62445
62865
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62446
62866
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62447
62867
|
/** Status of export request. */
|
|
62448
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
62868
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
62869
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62449
62870
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62450
62871
|
field?: string;
|
|
62451
62872
|
};
|
|
@@ -62492,7 +62913,8 @@ export interface storefrontComponents {
|
|
|
62492
62913
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62493
62914
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62494
62915
|
/** Status of export request. */
|
|
62495
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
62916
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
62917
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62496
62918
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62497
62919
|
field?: string;
|
|
62498
62920
|
};
|
|
@@ -62539,7 +62961,8 @@ export interface storefrontComponents {
|
|
|
62539
62961
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62540
62962
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62541
62963
|
/** Status of export request. */
|
|
62542
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
62964
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
62965
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62543
62966
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62544
62967
|
field?: string;
|
|
62545
62968
|
};
|
|
@@ -62586,7 +63009,8 @@ export interface storefrontComponents {
|
|
|
62586
63009
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62587
63010
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62588
63011
|
/** Status of export request. */
|
|
62589
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63012
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63013
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62590
63014
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62591
63015
|
field?: string;
|
|
62592
63016
|
};
|
|
@@ -62633,7 +63057,8 @@ export interface storefrontComponents {
|
|
|
62633
63057
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62634
63058
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62635
63059
|
/** Status of the export request. */
|
|
62636
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63060
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63061
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62637
63062
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62638
63063
|
field?: string;
|
|
62639
63064
|
};
|
|
@@ -62680,7 +63105,8 @@ export interface storefrontComponents {
|
|
|
62680
63105
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62681
63106
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62682
63107
|
/** Status of export request. */
|
|
62683
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63108
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63109
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62684
63110
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62685
63111
|
field?: string;
|
|
62686
63112
|
};
|
|
@@ -62727,7 +63153,8 @@ export interface storefrontComponents {
|
|
|
62727
63153
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62728
63154
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62729
63155
|
/** Status of the export request. */
|
|
62730
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63156
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63157
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62731
63158
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62732
63159
|
field?: string;
|
|
62733
63160
|
};
|
|
@@ -62774,7 +63201,8 @@ export interface storefrontComponents {
|
|
|
62774
63201
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62775
63202
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62776
63203
|
/** Status of the export request. */
|
|
62777
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63204
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63205
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62778
63206
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62779
63207
|
field?: string;
|
|
62780
63208
|
};
|
|
@@ -62821,7 +63249,8 @@ export interface storefrontComponents {
|
|
|
62821
63249
|
createdTime?: storefrontComponents["schemas"]["CreatedTime"];
|
|
62822
63250
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
62823
63251
|
/** Status of the export request. */
|
|
62824
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
63252
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
63253
|
+
failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
|
|
62825
63254
|
dateRange?: storefrontComponents["schemas"]["DataExportDateRange"] & {
|
|
62826
63255
|
field?: string;
|
|
62827
63256
|
};
|
|
@@ -62850,6 +63279,17 @@ export interface storefrontComponents {
|
|
|
62850
63279
|
| storefrontComponents["schemas"]["PayoutRequestsDataExport"]
|
|
62851
63280
|
| storefrontComponents["schemas"]["PayoutRequestAllocationsDataExport"]
|
|
62852
63281
|
| storefrontComponents["schemas"]["UsersDataExport"];
|
|
63282
|
+
DataExportLimitExceeded: { [key: string]: any } & {
|
|
63283
|
+
/** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
|
|
63284
|
+
type: "data-export-limit-exceeded";
|
|
63285
|
+
/** HTTP status code. */
|
|
63286
|
+
status?: number;
|
|
63287
|
+
} & storefrontComponents["schemas"]["DetailedProblem"] & {
|
|
63288
|
+
/** Number of records that match the export request. */
|
|
63289
|
+
matchedRecords: number;
|
|
63290
|
+
/** Maximum number of records for a single export. */
|
|
63291
|
+
maxRecords: number;
|
|
63292
|
+
};
|
|
62853
63293
|
OrganizationExport: {
|
|
62854
63294
|
/** Unique resource ID. */
|
|
62855
63295
|
id?: string;
|
|
@@ -63626,13 +64066,13 @@ export interface storefrontComponents {
|
|
|
63626
64066
|
};
|
|
63627
64067
|
SubscriptionSummaryMetrics: {
|
|
63628
64068
|
/** Currency code in ISO 4217 format. */
|
|
63629
|
-
currency
|
|
64069
|
+
currency: string;
|
|
63630
64070
|
/** Total amount of all issued, past due, and paid invoices. */
|
|
63631
|
-
invoicedAmount
|
|
64071
|
+
invoicedAmount: number;
|
|
63632
64072
|
/** Total amount of all paid invoices. */
|
|
63633
|
-
collectedAmount
|
|
64073
|
+
collectedAmount: number;
|
|
63634
64074
|
/** Number of issued, past due, or paid invoices. */
|
|
63635
|
-
invoiceCount
|
|
64075
|
+
invoiceCount: number;
|
|
63636
64076
|
};
|
|
63637
64077
|
StorefrontAccount: {
|
|
63638
64078
|
/** ID of the account. */
|
|
@@ -63666,7 +64106,11 @@ export interface storefrontComponents {
|
|
|
63666
64106
|
updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
|
|
63667
64107
|
/** Tax numbers associated with the account. */
|
|
63668
64108
|
taxNumbers?: storefrontComponents["schemas"]["TaxNumber"][] | null;
|
|
63669
|
-
/**
|
|
64109
|
+
/**
|
|
64110
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
64111
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
64112
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
64113
|
+
*/
|
|
63670
64114
|
notificationEmails?: string[];
|
|
63671
64115
|
_links?: storefrontComponents["schemas"]["SelfLink"];
|
|
63672
64116
|
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
@@ -65004,8 +65448,10 @@ export interface storefrontComponents {
|
|
|
65004
65448
|
/** ID of the quote. */
|
|
65005
65449
|
id?: string;
|
|
65006
65450
|
/**
|
|
65007
|
-
* Type of the quote.
|
|
65451
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
65008
65452
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
65453
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
65454
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
65009
65455
|
*/
|
|
65010
65456
|
type?: "change";
|
|
65011
65457
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -66496,6 +66942,14 @@ export interface storefrontComponents {
|
|
|
66496
66942
|
"application/json": storefrontComponents["schemas"]["BadRequest"];
|
|
66497
66943
|
};
|
|
66498
66944
|
};
|
|
66945
|
+
/** Invalid data sent, or the export exceeds the maximum record limit. */
|
|
66946
|
+
DataExportValidationError: {
|
|
66947
|
+
content: {
|
|
66948
|
+
"application/json":
|
|
66949
|
+
| storefrontComponents["schemas"]["ValidationError"]
|
|
66950
|
+
| storefrontComponents["schemas"]["DataExportLimitExceeded"];
|
|
66951
|
+
};
|
|
66952
|
+
};
|
|
66499
66953
|
/**
|
|
66500
66954
|
* Request accepted.
|
|
66501
66955
|
* No response body returned.
|
|
@@ -67279,13 +67733,29 @@ export interface storefrontComponents {
|
|
|
67279
67733
|
};
|
|
67280
67734
|
};
|
|
67281
67735
|
/** Service credential resource. */
|
|
67736
|
+
PostCredential: {
|
|
67737
|
+
content: {
|
|
67738
|
+
"application/json":
|
|
67739
|
+
| storefrontComponents["schemas"]["PostSmtpCredential"]
|
|
67740
|
+
| storefrontComponents["schemas"]["PostWebhookCredential"]
|
|
67741
|
+
| storefrontComponents["schemas"]["PostExperianCredential"]
|
|
67742
|
+
| storefrontComponents["schemas"]["PostMailgunCredential"]
|
|
67743
|
+
| storefrontComponents["schemas"]["PostOAuth2Credential"]
|
|
67744
|
+
| storefrontComponents["schemas"]["PostPostmarkCredential"]
|
|
67745
|
+
| storefrontComponents["schemas"]["PostSendGridCredential"]
|
|
67746
|
+
| storefrontComponents["schemas"]["PostAwsSesCredential"]
|
|
67747
|
+
| storefrontComponents["schemas"]["PostTaxJarCredential"]
|
|
67748
|
+
| storefrontComponents["schemas"]["PostAvalaraCredential"]
|
|
67749
|
+
| storefrontComponents["schemas"]["PostPlaidCredential"];
|
|
67750
|
+
};
|
|
67751
|
+
};
|
|
67752
|
+
/** Service credential resource. */
|
|
67282
67753
|
PatchCredential: {
|
|
67283
67754
|
content: {
|
|
67284
|
-
"application/json":
|
|
67285
|
-
storefrontComponents["schemas"]["PatchServiceCredential"]
|
|
67286
|
-
|
|
67287
|
-
|
|
67288
|
-
Partial<storefrontComponents["schemas"]["PatchTaxJarCredential"]>;
|
|
67755
|
+
"application/json":
|
|
67756
|
+
| storefrontComponents["schemas"]["PatchServiceCredential"]
|
|
67757
|
+
| storefrontComponents["schemas"]["PatchPlaidCredential"]
|
|
67758
|
+
| storefrontComponents["schemas"]["PatchTaxJarCredential"];
|
|
67289
67759
|
};
|
|
67290
67760
|
};
|
|
67291
67761
|
/** Ruleset resource. */
|
|
@@ -72590,7 +73060,11 @@ export interface reportsComponents {
|
|
|
72590
73060
|
leadSource?: reportsComponents["schemas"]["LeadSourceData"];
|
|
72591
73061
|
/** ID of the associated person. */
|
|
72592
73062
|
personId?: string | null;
|
|
72593
|
-
/**
|
|
73063
|
+
/**
|
|
73064
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
73065
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
73066
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
73067
|
+
*/
|
|
72594
73068
|
notificationEmails?: string[];
|
|
72595
73069
|
/** Related links. */
|
|
72596
73070
|
_links?: {
|
|
@@ -75992,6 +76466,38 @@ export interface reportsComponents {
|
|
|
75992
76466
|
| reportsComponents["schemas"]["ProofOfFundsKycDocument"]
|
|
75993
76467
|
| reportsComponents["schemas"]["ProofOfPurchaseKycDocument"]
|
|
75994
76468
|
| reportsComponents["schemas"]["ProofOfCreditFileKycDocument"];
|
|
76469
|
+
/** Request body for overwriting identity KYC document matches. */
|
|
76470
|
+
KycIdentityMatchesOverwrite: reportsComponents["schemas"]["KycIdentityMatches"] & {
|
|
76471
|
+
/**
|
|
76472
|
+
* Type of KYC document matches.
|
|
76473
|
+
* If provided, value is `identity-proof` and matches the document type of the KYC document.
|
|
76474
|
+
*/
|
|
76475
|
+
type?: "identity-proof";
|
|
76476
|
+
};
|
|
76477
|
+
/** Request body for overwriting address KYC document matches. */
|
|
76478
|
+
KycAddressMatchesOverwrite: reportsComponents["schemas"]["KycAddressMatches"] & {
|
|
76479
|
+
/**
|
|
76480
|
+
* Type of KYC document matches.
|
|
76481
|
+
* If provided, value is `address-proof` and matches the document type of the KYC document.
|
|
76482
|
+
*/
|
|
76483
|
+
type?: "address-proof";
|
|
76484
|
+
};
|
|
76485
|
+
/** Request body for overwriting purchase KYC document matches. */
|
|
76486
|
+
KycPurchaseMatchesOverwrite: reportsComponents["schemas"]["PurchaseMatches"] & {
|
|
76487
|
+
/**
|
|
76488
|
+
* Type of KYC document matches.
|
|
76489
|
+
* If provided, value is `purchase-proof` and matches the document type of the KYC document.
|
|
76490
|
+
*/
|
|
76491
|
+
type?: "purchase-proof";
|
|
76492
|
+
};
|
|
76493
|
+
/** Request body for overwriting funds KYC document matches. */
|
|
76494
|
+
KycFundsMatchesOverwrite: reportsComponents["schemas"]["FundsMatches"] & {
|
|
76495
|
+
/**
|
|
76496
|
+
* Type of KYC document matches.
|
|
76497
|
+
* If provided, value is `funds-proof` and matches the document type of the KYC document.
|
|
76498
|
+
*/
|
|
76499
|
+
type?: "funds-proof";
|
|
76500
|
+
};
|
|
75995
76501
|
/** Settings for KYC score calculation. */
|
|
75996
76502
|
KycSettings: {
|
|
75997
76503
|
identityProof?: reportsComponents["schemas"]["KycSettingsIdentity"];
|
|
@@ -77608,8 +78114,10 @@ export interface reportsComponents {
|
|
|
77608
78114
|
/** ID of the quote. */
|
|
77609
78115
|
id?: string;
|
|
77610
78116
|
/**
|
|
77611
|
-
* Type of the quote.
|
|
78117
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
77612
78118
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
78119
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
78120
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
77613
78121
|
*/
|
|
77614
78122
|
type: "change";
|
|
77615
78123
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -81960,9 +82468,124 @@ export interface reportsComponents {
|
|
|
81960
82468
|
| reportsComponents["schemas"]["TaxJarCredential"]
|
|
81961
82469
|
| reportsComponents["schemas"]["AvalaraCredential"]
|
|
81962
82470
|
| reportsComponents["schemas"]["PlaidCredential"];
|
|
82471
|
+
PostSmtpCredential: reportsComponents["schemas"]["SmtpCredential"] & {
|
|
82472
|
+
/**
|
|
82473
|
+
* Type of the credential.
|
|
82474
|
+
* Value that matches the `{type}` path parameter.
|
|
82475
|
+
* For backward compatibility, when this field is absent,
|
|
82476
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82477
|
+
*/
|
|
82478
|
+
type: "smtp";
|
|
82479
|
+
};
|
|
82480
|
+
PostWebhookCredential: reportsComponents["schemas"]["WebhookCredential"] & {
|
|
82481
|
+
/**
|
|
82482
|
+
* Type of the credential.
|
|
82483
|
+
* Value that matches the `{type}` path parameter.
|
|
82484
|
+
* For backward compatibility, when this field is absent,
|
|
82485
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82486
|
+
*/
|
|
82487
|
+
type: "webhook";
|
|
82488
|
+
};
|
|
82489
|
+
PostExperianCredential: reportsComponents["schemas"]["ExperianCredential"] & {
|
|
82490
|
+
/**
|
|
82491
|
+
* Type of the credential.
|
|
82492
|
+
* Value that matches the `{type}` path parameter.
|
|
82493
|
+
* For backward compatibility, when this field is absent,
|
|
82494
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82495
|
+
*/
|
|
82496
|
+
type: "experian";
|
|
82497
|
+
};
|
|
82498
|
+
PostMailgunCredential: reportsComponents["schemas"]["MailgunCredential"] & {
|
|
82499
|
+
/**
|
|
82500
|
+
* Type of the credential.
|
|
82501
|
+
* Value that matches the `{type}` path parameter.
|
|
82502
|
+
* For backward compatibility, when this field is absent,
|
|
82503
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82504
|
+
*/
|
|
82505
|
+
type: "mailgun";
|
|
82506
|
+
};
|
|
82507
|
+
PostOAuth2Credential: reportsComponents["schemas"]["OAuth2Credential"] & {
|
|
82508
|
+
/**
|
|
82509
|
+
* Type of the credential.
|
|
82510
|
+
* Value that matches the `{type}` path parameter.
|
|
82511
|
+
* For backward compatibility, when this field is absent,
|
|
82512
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82513
|
+
*/
|
|
82514
|
+
type: "oauth2";
|
|
82515
|
+
};
|
|
82516
|
+
PostPostmarkCredential: reportsComponents["schemas"]["PostmarkCredential"] & {
|
|
82517
|
+
/**
|
|
82518
|
+
* Type of the credential.
|
|
82519
|
+
* Value that matches the `{type}` path parameter.
|
|
82520
|
+
* For backward compatibility, when this field is absent,
|
|
82521
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82522
|
+
*/
|
|
82523
|
+
type: "postmark";
|
|
82524
|
+
};
|
|
82525
|
+
PostSendGridCredential: reportsComponents["schemas"]["SendGridCredential"] & {
|
|
82526
|
+
/**
|
|
82527
|
+
* Type of the credential.
|
|
82528
|
+
* Value that matches the `{type}` path parameter.
|
|
82529
|
+
* For backward compatibility, when this field is absent,
|
|
82530
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82531
|
+
*/
|
|
82532
|
+
type: "sendgrid";
|
|
82533
|
+
};
|
|
82534
|
+
PostAwsSesCredential: reportsComponents["schemas"]["SESCredential"] & {
|
|
82535
|
+
/**
|
|
82536
|
+
* Type of the credential.
|
|
82537
|
+
* Value that matches the `{type}` path parameter.
|
|
82538
|
+
* For backward compatibility, when this field is absent,
|
|
82539
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82540
|
+
*/
|
|
82541
|
+
type: "aws-ses";
|
|
82542
|
+
};
|
|
82543
|
+
PostTaxJarCredential: reportsComponents["schemas"]["TaxJarCredential"] & {
|
|
82544
|
+
/**
|
|
82545
|
+
* Type of the credential.
|
|
82546
|
+
* Value that matches the `{type}` path parameter.
|
|
82547
|
+
* For backward compatibility, when this field is absent,
|
|
82548
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82549
|
+
*/
|
|
82550
|
+
type: "taxjar";
|
|
82551
|
+
};
|
|
82552
|
+
PostAvalaraCredential: reportsComponents["schemas"]["AvalaraCredential"] & {
|
|
82553
|
+
/**
|
|
82554
|
+
* Type of the credential.
|
|
82555
|
+
* Value that matches the `{type}` path parameter.
|
|
82556
|
+
* For backward compatibility, when this field is absent,
|
|
82557
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82558
|
+
*/
|
|
82559
|
+
type: "avalara";
|
|
82560
|
+
};
|
|
82561
|
+
PostPlaidCredential: reportsComponents["schemas"]["PlaidCredential"] & {
|
|
82562
|
+
/**
|
|
82563
|
+
* Type of the credential.
|
|
82564
|
+
* Value that matches the `{type}` path parameter.
|
|
82565
|
+
* For backward compatibility, when this field is absent,
|
|
82566
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82567
|
+
*/
|
|
82568
|
+
type: "plaid";
|
|
82569
|
+
};
|
|
81963
82570
|
PatchServiceCredential: {
|
|
81964
82571
|
/** Status of the credential. */
|
|
81965
82572
|
status: "active" | "inactive" | "deactivated";
|
|
82573
|
+
/**
|
|
82574
|
+
* Type of the credential.
|
|
82575
|
+
* Value that matches the `{type}` path parameter.
|
|
82576
|
+
* For backward compatibility, when this field is absent,
|
|
82577
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82578
|
+
*/
|
|
82579
|
+
type:
|
|
82580
|
+
| "smtp"
|
|
82581
|
+
| "webhook"
|
|
82582
|
+
| "mailgun"
|
|
82583
|
+
| "sendgrid"
|
|
82584
|
+
| "aws-ses"
|
|
82585
|
+
| "oauth2"
|
|
82586
|
+
| "postmark"
|
|
82587
|
+
| "experian"
|
|
82588
|
+
| "avalara";
|
|
81966
82589
|
};
|
|
81967
82590
|
/** Plaid credential. */
|
|
81968
82591
|
PatchPlaidCredential: {
|
|
@@ -81982,6 +82605,13 @@ export interface reportsComponents {
|
|
|
81982
82605
|
* This setting enables the creation of Stripe bank account tokens.
|
|
81983
82606
|
*/
|
|
81984
82607
|
useStripe?: boolean;
|
|
82608
|
+
/**
|
|
82609
|
+
* Type of the credential.
|
|
82610
|
+
* Value that matches the `{type}` path parameter.
|
|
82611
|
+
* For backward compatibility, when this field is absent,
|
|
82612
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82613
|
+
*/
|
|
82614
|
+
type: "plaid";
|
|
81985
82615
|
};
|
|
81986
82616
|
/** TaxJar credential. */
|
|
81987
82617
|
PatchTaxJarCredential: {
|
|
@@ -81992,6 +82622,13 @@ export interface reportsComponents {
|
|
|
81992
82622
|
* For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
|
|
81993
82623
|
*/
|
|
81994
82624
|
omitFromAddress?: boolean;
|
|
82625
|
+
/**
|
|
82626
|
+
* Type of the credential.
|
|
82627
|
+
* Value that matches the `{type}` path parameter.
|
|
82628
|
+
* For backward compatibility, when this field is absent,
|
|
82629
|
+
* the `{type}` path parameter supplies the credential type.
|
|
82630
|
+
*/
|
|
82631
|
+
type: "taxjar";
|
|
81995
82632
|
};
|
|
81996
82633
|
GoogleSpreadsheet: {
|
|
81997
82634
|
/** ID of the Google Spreadsheet. */
|
|
@@ -83125,6 +83762,10 @@ export interface reportsComponents {
|
|
|
83125
83762
|
riskProfile?: string;
|
|
83126
83763
|
/** Name of the transaction custom field that holds the Level 2/3 data. */
|
|
83127
83764
|
levelTwoThreeDataCustomField?: string;
|
|
83765
|
+
/** ID of the Digital Payment Application (DPA) for Mastercard Secure Card on File (SCOF). */
|
|
83766
|
+
mastercardDpaId?: string;
|
|
83767
|
+
/** ID of the Mastercard Secure Card on File (SCOF) service. */
|
|
83768
|
+
mastercardServiceId?: string;
|
|
83128
83769
|
};
|
|
83129
83770
|
threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
83130
83771
|
};
|
|
@@ -85182,6 +85823,8 @@ export interface reportsComponents {
|
|
|
85182
85823
|
tokenApiKey: string;
|
|
85183
85824
|
/** Paybilt API key. */
|
|
85184
85825
|
apiKey: string;
|
|
85826
|
+
/** Paybilt HMAC key used to verify webhook signatures. */
|
|
85827
|
+
hmacKey?: string;
|
|
85185
85828
|
};
|
|
85186
85829
|
threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
|
|
85187
85830
|
settings?: {
|
|
@@ -88319,6 +88962,10 @@ export interface reportsComponents {
|
|
|
88319
88962
|
*/
|
|
88320
88963
|
start?: string;
|
|
88321
88964
|
};
|
|
88965
|
+
/** Reason the export failed, if the export status is `failed`. */
|
|
88966
|
+
DataExportFailureReason:
|
|
88967
|
+
| ("record-limit-exceeded" | "max-retries-reached")
|
|
88968
|
+
| null;
|
|
88322
88969
|
/**
|
|
88323
88970
|
* Date range of the data export.
|
|
88324
88971
|
* If this value is not set, all data is included.
|
|
@@ -88368,7 +89015,8 @@ export interface reportsComponents {
|
|
|
88368
89015
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88369
89016
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88370
89017
|
/** Status of export request. */
|
|
88371
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89018
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89019
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88372
89020
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88373
89021
|
field?: string;
|
|
88374
89022
|
};
|
|
@@ -88415,7 +89063,8 @@ export interface reportsComponents {
|
|
|
88415
89063
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88416
89064
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88417
89065
|
/** Status of export request. */
|
|
88418
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89066
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89067
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88419
89068
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88420
89069
|
field?: string;
|
|
88421
89070
|
};
|
|
@@ -88462,7 +89111,8 @@ export interface reportsComponents {
|
|
|
88462
89111
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88463
89112
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88464
89113
|
/** Status of export request. */
|
|
88465
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89114
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89115
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88466
89116
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88467
89117
|
field?: string;
|
|
88468
89118
|
};
|
|
@@ -88509,7 +89159,8 @@ export interface reportsComponents {
|
|
|
88509
89159
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88510
89160
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88511
89161
|
/** Status of export request. */
|
|
88512
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89162
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89163
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88513
89164
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88514
89165
|
field?: string;
|
|
88515
89166
|
};
|
|
@@ -88556,7 +89207,8 @@ export interface reportsComponents {
|
|
|
88556
89207
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88557
89208
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88558
89209
|
/** Status of export request. */
|
|
88559
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89210
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89211
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88560
89212
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88561
89213
|
field?: string;
|
|
88562
89214
|
};
|
|
@@ -88603,7 +89255,8 @@ export interface reportsComponents {
|
|
|
88603
89255
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88604
89256
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88605
89257
|
/** Status of export request. */
|
|
88606
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89258
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89259
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88607
89260
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88608
89261
|
field?: string;
|
|
88609
89262
|
};
|
|
@@ -88650,7 +89303,8 @@ export interface reportsComponents {
|
|
|
88650
89303
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88651
89304
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88652
89305
|
/** Status of the export request. */
|
|
88653
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89306
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89307
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88654
89308
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88655
89309
|
field?: string;
|
|
88656
89310
|
};
|
|
@@ -88697,7 +89351,8 @@ export interface reportsComponents {
|
|
|
88697
89351
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88698
89352
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88699
89353
|
/** Status of export request. */
|
|
88700
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89354
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89355
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88701
89356
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88702
89357
|
field?: string;
|
|
88703
89358
|
};
|
|
@@ -88744,7 +89399,8 @@ export interface reportsComponents {
|
|
|
88744
89399
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88745
89400
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88746
89401
|
/** Status of the export request. */
|
|
88747
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89402
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89403
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88748
89404
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88749
89405
|
field?: string;
|
|
88750
89406
|
};
|
|
@@ -88791,7 +89447,8 @@ export interface reportsComponents {
|
|
|
88791
89447
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88792
89448
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88793
89449
|
/** Status of the export request. */
|
|
88794
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89450
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89451
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88795
89452
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88796
89453
|
field?: string;
|
|
88797
89454
|
};
|
|
@@ -88838,7 +89495,8 @@ export interface reportsComponents {
|
|
|
88838
89495
|
createdTime?: reportsComponents["schemas"]["CreatedTime"];
|
|
88839
89496
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
88840
89497
|
/** Status of the export request. */
|
|
88841
|
-
status?: "pending" | "queued" | "processing" | "completed";
|
|
89498
|
+
status?: "pending" | "queued" | "processing" | "completed" | "failed";
|
|
89499
|
+
failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
|
|
88842
89500
|
dateRange?: reportsComponents["schemas"]["DataExportDateRange"] & {
|
|
88843
89501
|
field?: string;
|
|
88844
89502
|
};
|
|
@@ -88867,6 +89525,17 @@ export interface reportsComponents {
|
|
|
88867
89525
|
| reportsComponents["schemas"]["PayoutRequestsDataExport"]
|
|
88868
89526
|
| reportsComponents["schemas"]["PayoutRequestAllocationsDataExport"]
|
|
88869
89527
|
| reportsComponents["schemas"]["UsersDataExport"];
|
|
89528
|
+
DataExportLimitExceeded: { [key: string]: any } & {
|
|
89529
|
+
/** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
|
|
89530
|
+
type: "data-export-limit-exceeded";
|
|
89531
|
+
/** HTTP status code. */
|
|
89532
|
+
status?: number;
|
|
89533
|
+
} & reportsComponents["schemas"]["DetailedProblem"] & {
|
|
89534
|
+
/** Number of records that match the export request. */
|
|
89535
|
+
matchedRecords: number;
|
|
89536
|
+
/** Maximum number of records for a single export. */
|
|
89537
|
+
maxRecords: number;
|
|
89538
|
+
};
|
|
88870
89539
|
OrganizationExport: {
|
|
88871
89540
|
/** Unique resource ID. */
|
|
88872
89541
|
id?: string;
|
|
@@ -89643,13 +90312,13 @@ export interface reportsComponents {
|
|
|
89643
90312
|
};
|
|
89644
90313
|
SubscriptionSummaryMetrics: {
|
|
89645
90314
|
/** Currency code in ISO 4217 format. */
|
|
89646
|
-
currency
|
|
90315
|
+
currency: string;
|
|
89647
90316
|
/** Total amount of all issued, past due, and paid invoices. */
|
|
89648
|
-
invoicedAmount
|
|
90317
|
+
invoicedAmount: number;
|
|
89649
90318
|
/** Total amount of all paid invoices. */
|
|
89650
|
-
collectedAmount
|
|
90319
|
+
collectedAmount: number;
|
|
89651
90320
|
/** Number of issued, past due, or paid invoices. */
|
|
89652
|
-
invoiceCount
|
|
90321
|
+
invoiceCount: number;
|
|
89653
90322
|
};
|
|
89654
90323
|
StorefrontAccount: {
|
|
89655
90324
|
/** ID of the account. */
|
|
@@ -89683,7 +90352,11 @@ export interface reportsComponents {
|
|
|
89683
90352
|
updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
|
|
89684
90353
|
/** Tax numbers associated with the account. */
|
|
89685
90354
|
taxNumbers?: reportsComponents["schemas"]["TaxNumber"][] | null;
|
|
89686
|
-
/**
|
|
90355
|
+
/**
|
|
90356
|
+
* Email addresses for notification delivery in event-based email notifications.
|
|
90357
|
+
* When you configure event-based email notifications, you can send to these addresses, the customer's primary email address, or another email address you specify.
|
|
90358
|
+
* For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
|
|
90359
|
+
*/
|
|
89687
90360
|
notificationEmails?: string[];
|
|
89688
90361
|
_links?: reportsComponents["schemas"]["SelfLink"];
|
|
89689
90362
|
/** Embedded objects that are requested by the `expand` query parameter. */
|
|
@@ -91021,8 +91694,10 @@ export interface reportsComponents {
|
|
|
91021
91694
|
/** ID of the quote. */
|
|
91022
91695
|
id?: string;
|
|
91023
91696
|
/**
|
|
91024
|
-
* Type of the quote.
|
|
91697
|
+
* Type of the quote for modifications to existing recurring orders.
|
|
91025
91698
|
* When a quote is accepted, quote items and settings are applied to the related order.
|
|
91699
|
+
* Change quotes can only be created for orders with `active` or `trial-ended` status.
|
|
91700
|
+
* For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
|
|
91026
91701
|
*/
|
|
91027
91702
|
type?: "change";
|
|
91028
91703
|
/** Conditions that must be met for the quote to be automatically accepted. */
|
|
@@ -92513,6 +93188,14 @@ export interface reportsComponents {
|
|
|
92513
93188
|
"application/json": reportsComponents["schemas"]["BadRequest"];
|
|
92514
93189
|
};
|
|
92515
93190
|
};
|
|
93191
|
+
/** Invalid data sent, or the export exceeds the maximum record limit. */
|
|
93192
|
+
DataExportValidationError: {
|
|
93193
|
+
content: {
|
|
93194
|
+
"application/json":
|
|
93195
|
+
| reportsComponents["schemas"]["ValidationError"]
|
|
93196
|
+
| reportsComponents["schemas"]["DataExportLimitExceeded"];
|
|
93197
|
+
};
|
|
93198
|
+
};
|
|
92516
93199
|
/**
|
|
92517
93200
|
* Request accepted.
|
|
92518
93201
|
* No response body returned.
|
|
@@ -93296,13 +93979,29 @@ export interface reportsComponents {
|
|
|
93296
93979
|
};
|
|
93297
93980
|
};
|
|
93298
93981
|
/** Service credential resource. */
|
|
93982
|
+
PostCredential: {
|
|
93983
|
+
content: {
|
|
93984
|
+
"application/json":
|
|
93985
|
+
| reportsComponents["schemas"]["PostSmtpCredential"]
|
|
93986
|
+
| reportsComponents["schemas"]["PostWebhookCredential"]
|
|
93987
|
+
| reportsComponents["schemas"]["PostExperianCredential"]
|
|
93988
|
+
| reportsComponents["schemas"]["PostMailgunCredential"]
|
|
93989
|
+
| reportsComponents["schemas"]["PostOAuth2Credential"]
|
|
93990
|
+
| reportsComponents["schemas"]["PostPostmarkCredential"]
|
|
93991
|
+
| reportsComponents["schemas"]["PostSendGridCredential"]
|
|
93992
|
+
| reportsComponents["schemas"]["PostAwsSesCredential"]
|
|
93993
|
+
| reportsComponents["schemas"]["PostTaxJarCredential"]
|
|
93994
|
+
| reportsComponents["schemas"]["PostAvalaraCredential"]
|
|
93995
|
+
| reportsComponents["schemas"]["PostPlaidCredential"];
|
|
93996
|
+
};
|
|
93997
|
+
};
|
|
93998
|
+
/** Service credential resource. */
|
|
93299
93999
|
PatchCredential: {
|
|
93300
94000
|
content: {
|
|
93301
|
-
"application/json":
|
|
93302
|
-
reportsComponents["schemas"]["PatchServiceCredential"]
|
|
93303
|
-
|
|
93304
|
-
|
|
93305
|
-
Partial<reportsComponents["schemas"]["PatchTaxJarCredential"]>;
|
|
94001
|
+
"application/json":
|
|
94002
|
+
| reportsComponents["schemas"]["PatchServiceCredential"]
|
|
94003
|
+
| reportsComponents["schemas"]["PatchPlaidCredential"]
|
|
94004
|
+
| reportsComponents["schemas"]["PatchTaxJarCredential"];
|
|
93306
94005
|
};
|
|
93307
94006
|
};
|
|
93308
94007
|
/** Ruleset resource. */
|
|
@@ -94840,7 +95539,7 @@ export interface operations {
|
|
|
94840
95539
|
};
|
|
94841
95540
|
401: reportsComponents["responses"]["Unauthorized"];
|
|
94842
95541
|
403: reportsComponents["responses"]["Forbidden"];
|
|
94843
|
-
422: reportsComponents["responses"]["
|
|
95542
|
+
422: reportsComponents["responses"]["DataExportValidationError"];
|
|
94844
95543
|
429: reportsComponents["responses"]["TooManyRequests"];
|
|
94845
95544
|
};
|
|
94846
95545
|
requestBody: reportsComponents["requestBodies"]["DataExport"];
|
|
@@ -94911,7 +95610,7 @@ export interface operations {
|
|
|
94911
95610
|
};
|
|
94912
95611
|
401: reportsComponents["responses"]["Unauthorized"];
|
|
94913
95612
|
403: reportsComponents["responses"]["Forbidden"];
|
|
94914
|
-
422: reportsComponents["responses"]["
|
|
95613
|
+
422: reportsComponents["responses"]["DataExportValidationError"];
|
|
94915
95614
|
429: reportsComponents["responses"]["TooManyRequests"];
|
|
94916
95615
|
};
|
|
94917
95616
|
requestBody: reportsComponents["requestBodies"]["DataExport"];
|
|
@@ -96621,9 +97320,8 @@ declare module "rebilly-js-sdk" {
|
|
|
96621
97320
|
export type GetCustomerCreditBalanceRequest = rebilly.GetCustomerCreditBalanceRequest;
|
|
96622
97321
|
export type GetCustomerCreditBalanceResponse = rebilly.GetCustomerCreditBalanceResponse;
|
|
96623
97322
|
export type GetCustomerCreditBalanceResponsePromise = rebilly.GetCustomerCreditBalanceResponsePromise;
|
|
96624
|
-
export type
|
|
96625
|
-
export type
|
|
96626
|
-
export type GetCustomerComplianceScreeningReportResponsePromise = rebilly.GetCustomerComplianceScreeningReportResponsePromise;
|
|
97323
|
+
export type PostCustomerComplianceScreeningReportResponse = rebilly.PostCustomerComplianceScreeningReportResponse;
|
|
97324
|
+
export type PostCustomerComplianceScreeningReportResponsePromise = rebilly.PostCustomerComplianceScreeningReportResponsePromise;
|
|
96627
97325
|
export type GetDisputeCollectionRequest = rebilly.GetDisputeCollectionRequest;
|
|
96628
97326
|
export type GetDisputeCollectionResponse = rebilly.GetDisputeCollectionResponse;
|
|
96629
97327
|
export type GetDisputeCollectionResponsePromise = rebilly.GetDisputeCollectionResponsePromise;
|
|
@@ -98941,6 +99639,9 @@ declare module "resources/customers-resource" {
|
|
|
98941
99639
|
getCustomerCreditBalance({ id }: {
|
|
98942
99640
|
id: any;
|
|
98943
99641
|
}): rebilly.GetCustomerCreditBalanceResponsePromise;
|
|
99642
|
+
generateComplianceScreeningReport({ id }: {
|
|
99643
|
+
id: any;
|
|
99644
|
+
}): any;
|
|
98944
99645
|
downloadComplianceScreeningReport({ id }: {
|
|
98945
99646
|
id: any;
|
|
98946
99647
|
}): any;
|
|
@@ -100887,6 +101588,9 @@ declare module "resources/api-instance" {
|
|
|
100887
101588
|
getCustomerCreditBalance({ id }: {
|
|
100888
101589
|
id: any;
|
|
100889
101590
|
}): rebilly.GetCustomerCreditBalanceResponsePromise;
|
|
101591
|
+
generateComplianceScreeningReport({ id }: {
|
|
101592
|
+
id: any;
|
|
101593
|
+
}): any;
|
|
100890
101594
|
downloadComplianceScreeningReport({ id }: {
|
|
100891
101595
|
id: any;
|
|
100892
101596
|
}): any;
|