rebilly-js-sdk 62.153.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.
@@ -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 GetCustomerComplianceScreeningReportRequest = { id: string }
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
- * Retrieves a compliance screening report in PDF format for a customer.
2943
- * The report includes the customer's Know Your Customer (KYC) and Anti-Money Laundering (AML) screening results.
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
- get: operations["GetCustomerComplianceScreeningReport"];
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
- /** Additional email addresses for notification delivery. */
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?: {
@@ -24123,6 +24301,17 @@ export interface coreComponents {
24123
24301
  | coreComponents["schemas"]["PayoutRequestsDataExport"]
24124
24302
  | coreComponents["schemas"]["PayoutRequestAllocationsDataExport"]
24125
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
+ };
24126
24315
  OrganizationExport: {
24127
24316
  /** Unique resource ID. */
24128
24317
  id?: string;
@@ -24939,7 +25128,11 @@ export interface coreComponents {
24939
25128
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
24940
25129
  /** Tax numbers associated with the account. */
24941
25130
  taxNumbers?: coreComponents["schemas"]["TaxNumber"][] | null;
24942
- /** Additional email addresses for notification delivery. */
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
+ */
24943
25136
  notificationEmails?: string[];
24944
25137
  _links?: coreComponents["schemas"]["SelfLink"];
24945
25138
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -26277,8 +26470,10 @@ export interface coreComponents {
26277
26470
  /** ID of the quote. */
26278
26471
  id?: string;
26279
26472
  /**
26280
- * Type of the quote.
26473
+ * Type of the quote for modifications to existing recurring orders.
26281
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.
26282
26477
  */
26283
26478
  type?: "change";
26284
26479
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -27769,6 +27964,14 @@ export interface coreComponents {
27769
27964
  "application/json": coreComponents["schemas"]["BadRequest"];
27770
27965
  };
27771
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
+ };
27772
27975
  /**
27773
27976
  * Request accepted.
27774
27977
  * No response body returned.
@@ -28552,13 +28755,29 @@ export interface coreComponents {
28552
28755
  };
28553
28756
  };
28554
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. */
28555
28775
  PatchCredential: {
28556
28776
  content: {
28557
- "application/json": Partial<
28558
- coreComponents["schemas"]["PatchServiceCredential"]
28559
- > &
28560
- Partial<coreComponents["schemas"]["PatchPlaidCredential"]> &
28561
- Partial<coreComponents["schemas"]["PatchTaxJarCredential"]>;
28777
+ "application/json":
28778
+ | coreComponents["schemas"]["PatchServiceCredential"]
28779
+ | coreComponents["schemas"]["PatchPlaidCredential"]
28780
+ | coreComponents["schemas"]["PatchTaxJarCredential"];
28562
28781
  };
28563
28782
  };
28564
28783
  /** Ruleset resource. */
@@ -31633,11 +31852,11 @@ export interface operations {
31633
31852
  };
31634
31853
  };
31635
31854
  /**
31636
- * Retrieves a compliance screening report in PDF format for a customer.
31637
- * The report includes the customer's Know Your Customer (KYC) and Anti-Money Laundering (AML) screening results.
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.
31638
31857
  * Requires the KYC and AML products to be enabled for the organization.
31639
31858
  */
31640
- GetCustomerComplianceScreeningReport: {
31859
+ PostCustomerComplianceScreeningReport: {
31641
31860
  parameters: {
31642
31861
  path: {
31643
31862
  /** ID of the resource. */
@@ -31645,15 +31864,17 @@ export interface operations {
31645
31864
  };
31646
31865
  };
31647
31866
  responses: {
31648
- /** Compliance screening report retrieved. */
31649
- 200: {
31867
+ /** Compliance screening report generated. */
31868
+ 201: {
31869
+ headers: {};
31650
31870
  content: {
31651
- "application/pdf": string;
31871
+ "application/json": coreComponents["schemas"]["Attachment"];
31652
31872
  };
31653
31873
  };
31654
31874
  401: coreComponents["responses"]["Unauthorized"];
31655
31875
  403: coreComponents["responses"]["Forbidden"];
31656
31876
  404: coreComponents["responses"]["NotFound"];
31877
+ 429: coreComponents["responses"]["TooManyRequests"];
31657
31878
  };
31658
31879
  };
31659
31880
  /** Retrieves a list of all disputes. */
@@ -33997,6 +34218,13 @@ export interface operations {
33997
34218
  * Updates the document matches of a KYC document with a specified ID.
33998
34219
  *
33999
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.
34000
34228
  */
34001
34229
  PostKycDocumentMatches: {
34002
34230
  parameters: {
@@ -34011,15 +34239,18 @@ export interface operations {
34011
34239
  401: coreComponents["responses"]["Unauthorized"];
34012
34240
  403: coreComponents["responses"]["Forbidden"];
34013
34241
  404: coreComponents["responses"]["NotFound"];
34242
+ 422: coreComponents["responses"]["ValidationError"];
34014
34243
  429: coreComponents["responses"]["TooManyRequests"];
34015
34244
  };
34016
- /** Kyc document resource. */
34245
+ /** KYC document matches overwrite payload. */
34017
34246
  requestBody: {
34018
34247
  content: {
34019
34248
  "application/json": Partial<
34020
- coreComponents["schemas"]["KycIdentityMatches"]
34249
+ coreComponents["schemas"]["KycIdentityMatchesOverwrite"]
34021
34250
  > &
34022
- Partial<coreComponents["schemas"]["KycAddressMatches"]>;
34251
+ Partial<coreComponents["schemas"]["KycAddressMatchesOverwrite"]> &
34252
+ Partial<coreComponents["schemas"]["KycPurchaseMatchesOverwrite"]> &
34253
+ Partial<coreComponents["schemas"]["KycFundsMatchesOverwrite"]>;
34023
34254
  };
34024
34255
  };
34025
34256
  };
@@ -39298,12 +39529,7 @@ export interface operations {
39298
39529
  422: coreComponents["responses"]["ValidationError"];
39299
39530
  429: coreComponents["responses"]["TooManyRequests"];
39300
39531
  };
39301
- /** Service credential resource. */
39302
- requestBody: {
39303
- content: {
39304
- "application/json": coreComponents["schemas"]["ServiceCredential"];
39305
- };
39306
- };
39532
+ requestBody: coreComponents["requestBodies"]["PostCredential"];
39307
39533
  };
39308
39534
  /** Retrieves a service credential with a specified ID. */
39309
39535
  GetServiceCredential: {
@@ -46588,7 +46814,11 @@ export interface storefrontComponents {
46588
46814
  leadSource?: storefrontComponents["schemas"]["LeadSourceData"];
46589
46815
  /** ID of the associated person. */
46590
46816
  personId?: string | null;
46591
- /** Additional email addresses for notification delivery. */
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
+ */
46592
46822
  notificationEmails?: string[];
46593
46823
  /** Related links. */
46594
46824
  _links?: {
@@ -49990,6 +50220,38 @@ export interface storefrontComponents {
49990
50220
  | storefrontComponents["schemas"]["ProofOfFundsKycDocument"]
49991
50221
  | storefrontComponents["schemas"]["ProofOfPurchaseKycDocument"]
49992
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
+ };
49993
50255
  /** Settings for KYC score calculation. */
49994
50256
  KycSettings: {
49995
50257
  identityProof?: storefrontComponents["schemas"]["KycSettingsIdentity"];
@@ -51606,8 +51868,10 @@ export interface storefrontComponents {
51606
51868
  /** ID of the quote. */
51607
51869
  id?: string;
51608
51870
  /**
51609
- * Type of the quote.
51871
+ * Type of the quote for modifications to existing recurring orders.
51610
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.
51611
51875
  */
51612
51876
  type: "change";
51613
51877
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -55958,9 +56222,124 @@ export interface storefrontComponents {
55958
56222
  | storefrontComponents["schemas"]["TaxJarCredential"]
55959
56223
  | storefrontComponents["schemas"]["AvalaraCredential"]
55960
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
+ };
55961
56324
  PatchServiceCredential: {
55962
56325
  /** Status of the credential. */
55963
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";
55964
56343
  };
55965
56344
  /** Plaid credential. */
55966
56345
  PatchPlaidCredential: {
@@ -55980,6 +56359,13 @@ export interface storefrontComponents {
55980
56359
  * This setting enables the creation of Stripe bank account tokens.
55981
56360
  */
55982
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";
55983
56369
  };
55984
56370
  /** TaxJar credential. */
55985
56371
  PatchTaxJarCredential: {
@@ -55990,6 +56376,13 @@ export interface storefrontComponents {
55990
56376
  * For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
55991
56377
  */
55992
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";
55993
56386
  };
55994
56387
  GoogleSpreadsheet: {
55995
56388
  /** ID of the Google Spreadsheet. */
@@ -57123,6 +57516,10 @@ export interface storefrontComponents {
57123
57516
  riskProfile?: string;
57124
57517
  /** Name of the transaction custom field that holds the Level 2/3 data. */
57125
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;
57126
57523
  };
57127
57524
  threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
57128
57525
  };
@@ -59180,6 +59577,8 @@ export interface storefrontComponents {
59180
59577
  tokenApiKey: string;
59181
59578
  /** Paybilt API key. */
59182
59579
  apiKey: string;
59580
+ /** Paybilt HMAC key used to verify webhook signatures. */
59581
+ hmacKey?: string;
59183
59582
  };
59184
59583
  threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
59185
59584
  settings?: {
@@ -62880,6 +63279,17 @@ export interface storefrontComponents {
62880
63279
  | storefrontComponents["schemas"]["PayoutRequestsDataExport"]
62881
63280
  | storefrontComponents["schemas"]["PayoutRequestAllocationsDataExport"]
62882
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
+ };
62883
63293
  OrganizationExport: {
62884
63294
  /** Unique resource ID. */
62885
63295
  id?: string;
@@ -63696,7 +64106,11 @@ export interface storefrontComponents {
63696
64106
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
63697
64107
  /** Tax numbers associated with the account. */
63698
64108
  taxNumbers?: storefrontComponents["schemas"]["TaxNumber"][] | null;
63699
- /** Additional email addresses for notification delivery. */
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
+ */
63700
64114
  notificationEmails?: string[];
63701
64115
  _links?: storefrontComponents["schemas"]["SelfLink"];
63702
64116
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -65034,8 +65448,10 @@ export interface storefrontComponents {
65034
65448
  /** ID of the quote. */
65035
65449
  id?: string;
65036
65450
  /**
65037
- * Type of the quote.
65451
+ * Type of the quote for modifications to existing recurring orders.
65038
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.
65039
65455
  */
65040
65456
  type?: "change";
65041
65457
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -66526,6 +66942,14 @@ export interface storefrontComponents {
66526
66942
  "application/json": storefrontComponents["schemas"]["BadRequest"];
66527
66943
  };
66528
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
+ };
66529
66953
  /**
66530
66954
  * Request accepted.
66531
66955
  * No response body returned.
@@ -67309,13 +67733,29 @@ export interface storefrontComponents {
67309
67733
  };
67310
67734
  };
67311
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. */
67312
67753
  PatchCredential: {
67313
67754
  content: {
67314
- "application/json": Partial<
67315
- storefrontComponents["schemas"]["PatchServiceCredential"]
67316
- > &
67317
- Partial<storefrontComponents["schemas"]["PatchPlaidCredential"]> &
67318
- Partial<storefrontComponents["schemas"]["PatchTaxJarCredential"]>;
67755
+ "application/json":
67756
+ | storefrontComponents["schemas"]["PatchServiceCredential"]
67757
+ | storefrontComponents["schemas"]["PatchPlaidCredential"]
67758
+ | storefrontComponents["schemas"]["PatchTaxJarCredential"];
67319
67759
  };
67320
67760
  };
67321
67761
  /** Ruleset resource. */
@@ -72620,7 +73060,11 @@ export interface reportsComponents {
72620
73060
  leadSource?: reportsComponents["schemas"]["LeadSourceData"];
72621
73061
  /** ID of the associated person. */
72622
73062
  personId?: string | null;
72623
- /** Additional email addresses for notification delivery. */
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
+ */
72624
73068
  notificationEmails?: string[];
72625
73069
  /** Related links. */
72626
73070
  _links?: {
@@ -76022,6 +76466,38 @@ export interface reportsComponents {
76022
76466
  | reportsComponents["schemas"]["ProofOfFundsKycDocument"]
76023
76467
  | reportsComponents["schemas"]["ProofOfPurchaseKycDocument"]
76024
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
+ };
76025
76501
  /** Settings for KYC score calculation. */
76026
76502
  KycSettings: {
76027
76503
  identityProof?: reportsComponents["schemas"]["KycSettingsIdentity"];
@@ -77638,8 +78114,10 @@ export interface reportsComponents {
77638
78114
  /** ID of the quote. */
77639
78115
  id?: string;
77640
78116
  /**
77641
- * Type of the quote.
78117
+ * Type of the quote for modifications to existing recurring orders.
77642
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.
77643
78121
  */
77644
78122
  type: "change";
77645
78123
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -81990,9 +82468,124 @@ export interface reportsComponents {
81990
82468
  | reportsComponents["schemas"]["TaxJarCredential"]
81991
82469
  | reportsComponents["schemas"]["AvalaraCredential"]
81992
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
+ };
81993
82570
  PatchServiceCredential: {
81994
82571
  /** Status of the credential. */
81995
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";
81996
82589
  };
81997
82590
  /** Plaid credential. */
81998
82591
  PatchPlaidCredential: {
@@ -82012,6 +82605,13 @@ export interface reportsComponents {
82012
82605
  * This setting enables the creation of Stripe bank account tokens.
82013
82606
  */
82014
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";
82015
82615
  };
82016
82616
  /** TaxJar credential. */
82017
82617
  PatchTaxJarCredential: {
@@ -82022,6 +82622,13 @@ export interface reportsComponents {
82022
82622
  * For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
82023
82623
  */
82024
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";
82025
82632
  };
82026
82633
  GoogleSpreadsheet: {
82027
82634
  /** ID of the Google Spreadsheet. */
@@ -83155,6 +83762,10 @@ export interface reportsComponents {
83155
83762
  riskProfile?: string;
83156
83763
  /** Name of the transaction custom field that holds the Level 2/3 data. */
83157
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;
83158
83769
  };
83159
83770
  threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
83160
83771
  };
@@ -85212,6 +85823,8 @@ export interface reportsComponents {
85212
85823
  tokenApiKey: string;
85213
85824
  /** Paybilt API key. */
85214
85825
  apiKey: string;
85826
+ /** Paybilt HMAC key used to verify webhook signatures. */
85827
+ hmacKey?: string;
85215
85828
  };
85216
85829
  threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
85217
85830
  settings?: {
@@ -88912,6 +89525,17 @@ export interface reportsComponents {
88912
89525
  | reportsComponents["schemas"]["PayoutRequestsDataExport"]
88913
89526
  | reportsComponents["schemas"]["PayoutRequestAllocationsDataExport"]
88914
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
+ };
88915
89539
  OrganizationExport: {
88916
89540
  /** Unique resource ID. */
88917
89541
  id?: string;
@@ -89728,7 +90352,11 @@ export interface reportsComponents {
89728
90352
  updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
89729
90353
  /** Tax numbers associated with the account. */
89730
90354
  taxNumbers?: reportsComponents["schemas"]["TaxNumber"][] | null;
89731
- /** Additional email addresses for notification delivery. */
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
+ */
89732
90360
  notificationEmails?: string[];
89733
90361
  _links?: reportsComponents["schemas"]["SelfLink"];
89734
90362
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -91066,8 +91694,10 @@ export interface reportsComponents {
91066
91694
  /** ID of the quote. */
91067
91695
  id?: string;
91068
91696
  /**
91069
- * Type of the quote.
91697
+ * Type of the quote for modifications to existing recurring orders.
91070
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.
91071
91701
  */
91072
91702
  type?: "change";
91073
91703
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -92558,6 +93188,14 @@ export interface reportsComponents {
92558
93188
  "application/json": reportsComponents["schemas"]["BadRequest"];
92559
93189
  };
92560
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
+ };
92561
93199
  /**
92562
93200
  * Request accepted.
92563
93201
  * No response body returned.
@@ -93341,13 +93979,29 @@ export interface reportsComponents {
93341
93979
  };
93342
93980
  };
93343
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. */
93344
93999
  PatchCredential: {
93345
94000
  content: {
93346
- "application/json": Partial<
93347
- reportsComponents["schemas"]["PatchServiceCredential"]
93348
- > &
93349
- Partial<reportsComponents["schemas"]["PatchPlaidCredential"]> &
93350
- Partial<reportsComponents["schemas"]["PatchTaxJarCredential"]>;
94001
+ "application/json":
94002
+ | reportsComponents["schemas"]["PatchServiceCredential"]
94003
+ | reportsComponents["schemas"]["PatchPlaidCredential"]
94004
+ | reportsComponents["schemas"]["PatchTaxJarCredential"];
93351
94005
  };
93352
94006
  };
93353
94007
  /** Ruleset resource. */
@@ -94885,7 +95539,7 @@ export interface operations {
94885
95539
  };
94886
95540
  401: reportsComponents["responses"]["Unauthorized"];
94887
95541
  403: reportsComponents["responses"]["Forbidden"];
94888
- 422: reportsComponents["responses"]["ValidationError"];
95542
+ 422: reportsComponents["responses"]["DataExportValidationError"];
94889
95543
  429: reportsComponents["responses"]["TooManyRequests"];
94890
95544
  };
94891
95545
  requestBody: reportsComponents["requestBodies"]["DataExport"];
@@ -94956,7 +95610,7 @@ export interface operations {
94956
95610
  };
94957
95611
  401: reportsComponents["responses"]["Unauthorized"];
94958
95612
  403: reportsComponents["responses"]["Forbidden"];
94959
- 422: reportsComponents["responses"]["ValidationError"];
95613
+ 422: reportsComponents["responses"]["DataExportValidationError"];
94960
95614
  429: reportsComponents["responses"]["TooManyRequests"];
94961
95615
  };
94962
95616
  requestBody: reportsComponents["requestBodies"]["DataExport"];
@@ -96666,9 +97320,8 @@ declare module "rebilly-js-sdk" {
96666
97320
  export type GetCustomerCreditBalanceRequest = rebilly.GetCustomerCreditBalanceRequest;
96667
97321
  export type GetCustomerCreditBalanceResponse = rebilly.GetCustomerCreditBalanceResponse;
96668
97322
  export type GetCustomerCreditBalanceResponsePromise = rebilly.GetCustomerCreditBalanceResponsePromise;
96669
- export type GetCustomerComplianceScreeningReportRequest = rebilly.GetCustomerComplianceScreeningReportRequest;
96670
- export type GetCustomerComplianceScreeningReportResponse = rebilly.GetCustomerComplianceScreeningReportResponse;
96671
- export type GetCustomerComplianceScreeningReportResponsePromise = rebilly.GetCustomerComplianceScreeningReportResponsePromise;
97323
+ export type PostCustomerComplianceScreeningReportResponse = rebilly.PostCustomerComplianceScreeningReportResponse;
97324
+ export type PostCustomerComplianceScreeningReportResponsePromise = rebilly.PostCustomerComplianceScreeningReportResponsePromise;
96672
97325
  export type GetDisputeCollectionRequest = rebilly.GetDisputeCollectionRequest;
96673
97326
  export type GetDisputeCollectionResponse = rebilly.GetDisputeCollectionResponse;
96674
97327
  export type GetDisputeCollectionResponsePromise = rebilly.GetDisputeCollectionResponsePromise;
@@ -98986,6 +99639,9 @@ declare module "resources/customers-resource" {
98986
99639
  getCustomerCreditBalance({ id }: {
98987
99640
  id: any;
98988
99641
  }): rebilly.GetCustomerCreditBalanceResponsePromise;
99642
+ generateComplianceScreeningReport({ id }: {
99643
+ id: any;
99644
+ }): any;
98989
99645
  downloadComplianceScreeningReport({ id }: {
98990
99646
  id: any;
98991
99647
  }): any;
@@ -100932,6 +101588,9 @@ declare module "resources/api-instance" {
100932
101588
  getCustomerCreditBalance({ id }: {
100933
101589
  id: any;
100934
101590
  }): rebilly.GetCustomerCreditBalanceResponsePromise;
101591
+ generateComplianceScreeningReport({ id }: {
101592
+ id: any;
101593
+ }): any;
100935
101594
  downloadComplianceScreeningReport({ id }: {
100936
101595
  id: any;
100937
101596
  }): any;