rebilly-js-sdk 62.153.0 → 62.155.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?: {
@@ -22569,6 +22747,11 @@ export interface coreComponents {
22569
22747
  | null;
22570
22748
  /** Amount allocated to this payment instrument. */
22571
22749
  amount: number;
22750
+ /**
22751
+ * Total approved sales and captures minus approved payouts for the customer,
22752
+ * gateway account, and payment instrument, in the allocation currency.
22753
+ */
22754
+ exposureAmount?: number;
22572
22755
  /** Currency of the payout request allocation. */
22573
22756
  currency: coreComponents["schemas"]["CurrencyCode"];
22574
22757
  /** Status of this payout request allocation. */
@@ -24123,6 +24306,17 @@ export interface coreComponents {
24123
24306
  | coreComponents["schemas"]["PayoutRequestsDataExport"]
24124
24307
  | coreComponents["schemas"]["PayoutRequestAllocationsDataExport"]
24125
24308
  | coreComponents["schemas"]["UsersDataExport"];
24309
+ DataExportLimitExceeded: { [key: string]: any } & {
24310
+ /** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
24311
+ type: "data-export-limit-exceeded";
24312
+ /** HTTP status code. */
24313
+ status?: number;
24314
+ } & coreComponents["schemas"]["DetailedProblem"] & {
24315
+ /** Number of records that match the export request. */
24316
+ matchedRecords: number;
24317
+ /** Maximum number of records for a single export. */
24318
+ maxRecords: number;
24319
+ };
24126
24320
  OrganizationExport: {
24127
24321
  /** Unique resource ID. */
24128
24322
  id?: string;
@@ -24939,7 +25133,11 @@ export interface coreComponents {
24939
25133
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
24940
25134
  /** Tax numbers associated with the account. */
24941
25135
  taxNumbers?: coreComponents["schemas"]["TaxNumber"][] | null;
24942
- /** Additional email addresses for notification delivery. */
25136
+ /**
25137
+ * Email addresses for notification delivery in event-based email notifications.
25138
+ * 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.
25139
+ * For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
25140
+ */
24943
25141
  notificationEmails?: string[];
24944
25142
  _links?: coreComponents["schemas"]["SelfLink"];
24945
25143
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -26277,8 +26475,10 @@ export interface coreComponents {
26277
26475
  /** ID of the quote. */
26278
26476
  id?: string;
26279
26477
  /**
26280
- * Type of the quote.
26478
+ * Type of the quote for modifications to existing recurring orders.
26281
26479
  * When a quote is accepted, quote items and settings are applied to the related order.
26480
+ * Change quotes can only be created for orders with `active` or `trial-ended` status.
26481
+ * For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
26282
26482
  */
26283
26483
  type?: "change";
26284
26484
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -27769,6 +27969,14 @@ export interface coreComponents {
27769
27969
  "application/json": coreComponents["schemas"]["BadRequest"];
27770
27970
  };
27771
27971
  };
27972
+ /** Invalid data sent, or the export exceeds the maximum record limit. */
27973
+ DataExportValidationError: {
27974
+ content: {
27975
+ "application/json":
27976
+ | coreComponents["schemas"]["ValidationError"]
27977
+ | coreComponents["schemas"]["DataExportLimitExceeded"];
27978
+ };
27979
+ };
27772
27980
  /**
27773
27981
  * Request accepted.
27774
27982
  * No response body returned.
@@ -28552,13 +28760,29 @@ export interface coreComponents {
28552
28760
  };
28553
28761
  };
28554
28762
  /** Service credential resource. */
28763
+ PostCredential: {
28764
+ content: {
28765
+ "application/json":
28766
+ | coreComponents["schemas"]["PostSmtpCredential"]
28767
+ | coreComponents["schemas"]["PostWebhookCredential"]
28768
+ | coreComponents["schemas"]["PostExperianCredential"]
28769
+ | coreComponents["schemas"]["PostMailgunCredential"]
28770
+ | coreComponents["schemas"]["PostOAuth2Credential"]
28771
+ | coreComponents["schemas"]["PostPostmarkCredential"]
28772
+ | coreComponents["schemas"]["PostSendGridCredential"]
28773
+ | coreComponents["schemas"]["PostAwsSesCredential"]
28774
+ | coreComponents["schemas"]["PostTaxJarCredential"]
28775
+ | coreComponents["schemas"]["PostAvalaraCredential"]
28776
+ | coreComponents["schemas"]["PostPlaidCredential"];
28777
+ };
28778
+ };
28779
+ /** Service credential resource. */
28555
28780
  PatchCredential: {
28556
28781
  content: {
28557
- "application/json": Partial<
28558
- coreComponents["schemas"]["PatchServiceCredential"]
28559
- > &
28560
- Partial<coreComponents["schemas"]["PatchPlaidCredential"]> &
28561
- Partial<coreComponents["schemas"]["PatchTaxJarCredential"]>;
28782
+ "application/json":
28783
+ | coreComponents["schemas"]["PatchServiceCredential"]
28784
+ | coreComponents["schemas"]["PatchPlaidCredential"]
28785
+ | coreComponents["schemas"]["PatchTaxJarCredential"];
28562
28786
  };
28563
28787
  };
28564
28788
  /** Ruleset resource. */
@@ -31633,11 +31857,11 @@ export interface operations {
31633
31857
  };
31634
31858
  };
31635
31859
  /**
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.
31860
+ * Creates a compliance screening report that includes Know Your Customer (KYC) and Anti-Money Laundering (AML) results for a customer.
31861
+ * The report is stored as a PDF customer attachment.
31638
31862
  * Requires the KYC and AML products to be enabled for the organization.
31639
31863
  */
31640
- GetCustomerComplianceScreeningReport: {
31864
+ PostCustomerComplianceScreeningReport: {
31641
31865
  parameters: {
31642
31866
  path: {
31643
31867
  /** ID of the resource. */
@@ -31645,15 +31869,17 @@ export interface operations {
31645
31869
  };
31646
31870
  };
31647
31871
  responses: {
31648
- /** Compliance screening report retrieved. */
31649
- 200: {
31872
+ /** Compliance screening report generated. */
31873
+ 201: {
31874
+ headers: {};
31650
31875
  content: {
31651
- "application/pdf": string;
31876
+ "application/json": coreComponents["schemas"]["Attachment"];
31652
31877
  };
31653
31878
  };
31654
31879
  401: coreComponents["responses"]["Unauthorized"];
31655
31880
  403: coreComponents["responses"]["Forbidden"];
31656
31881
  404: coreComponents["responses"]["NotFound"];
31882
+ 429: coreComponents["responses"]["TooManyRequests"];
31657
31883
  };
31658
31884
  };
31659
31885
  /** Retrieves a list of all disputes. */
@@ -33997,6 +34223,13 @@ export interface operations {
33997
34223
  * Updates the document matches of a KYC document with a specified ID.
33998
34224
  *
33999
34225
  * > **Note:** Use this operation for manual overrides.
34226
+ *
34227
+ * The request body schema depends on the KYC document `documentType`.
34228
+ * The operation rejects unknown fields.
34229
+ *
34230
+ * Optionally send `type` with one of:
34231
+ * `identity-proof`, `address-proof`, `purchase-proof`, or `funds-proof`.
34232
+ * If provided, `type` matches the document type of the KYC document.
34000
34233
  */
34001
34234
  PostKycDocumentMatches: {
34002
34235
  parameters: {
@@ -34011,15 +34244,18 @@ export interface operations {
34011
34244
  401: coreComponents["responses"]["Unauthorized"];
34012
34245
  403: coreComponents["responses"]["Forbidden"];
34013
34246
  404: coreComponents["responses"]["NotFound"];
34247
+ 422: coreComponents["responses"]["ValidationError"];
34014
34248
  429: coreComponents["responses"]["TooManyRequests"];
34015
34249
  };
34016
- /** Kyc document resource. */
34250
+ /** KYC document matches overwrite payload. */
34017
34251
  requestBody: {
34018
34252
  content: {
34019
34253
  "application/json": Partial<
34020
- coreComponents["schemas"]["KycIdentityMatches"]
34254
+ coreComponents["schemas"]["KycIdentityMatchesOverwrite"]
34021
34255
  > &
34022
- Partial<coreComponents["schemas"]["KycAddressMatches"]>;
34256
+ Partial<coreComponents["schemas"]["KycAddressMatchesOverwrite"]> &
34257
+ Partial<coreComponents["schemas"]["KycPurchaseMatchesOverwrite"]> &
34258
+ Partial<coreComponents["schemas"]["KycFundsMatchesOverwrite"]>;
34023
34259
  };
34024
34260
  };
34025
34261
  };
@@ -39298,12 +39534,7 @@ export interface operations {
39298
39534
  422: coreComponents["responses"]["ValidationError"];
39299
39535
  429: coreComponents["responses"]["TooManyRequests"];
39300
39536
  };
39301
- /** Service credential resource. */
39302
- requestBody: {
39303
- content: {
39304
- "application/json": coreComponents["schemas"]["ServiceCredential"];
39305
- };
39306
- };
39537
+ requestBody: coreComponents["requestBodies"]["PostCredential"];
39307
39538
  };
39308
39539
  /** Retrieves a service credential with a specified ID. */
39309
39540
  GetServiceCredential: {
@@ -42095,10 +42326,7 @@ export interface operations {
42095
42326
  200: {
42096
42327
  headers: {};
42097
42328
  content: {
42098
- "application/json": (coreComponents["schemas"]["PayoutRequestAllocation"] & {
42099
- /** Total approved sales and captures minus approved payouts for the customer, gateway account, and payment instrument, in the allocation currency. */
42100
- exposureAmount?: number;
42101
- })[];
42329
+ "application/json": coreComponents["schemas"]["PayoutRequestAllocation"][];
42102
42330
  };
42103
42331
  };
42104
42332
  401: coreComponents["responses"]["Unauthorized"];
@@ -46588,7 +46816,11 @@ export interface storefrontComponents {
46588
46816
  leadSource?: storefrontComponents["schemas"]["LeadSourceData"];
46589
46817
  /** ID of the associated person. */
46590
46818
  personId?: string | null;
46591
- /** Additional email addresses for notification delivery. */
46819
+ /**
46820
+ * Email addresses for notification delivery in event-based email notifications.
46821
+ * 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.
46822
+ * For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
46823
+ */
46592
46824
  notificationEmails?: string[];
46593
46825
  /** Related links. */
46594
46826
  _links?: {
@@ -49990,6 +50222,38 @@ export interface storefrontComponents {
49990
50222
  | storefrontComponents["schemas"]["ProofOfFundsKycDocument"]
49991
50223
  | storefrontComponents["schemas"]["ProofOfPurchaseKycDocument"]
49992
50224
  | storefrontComponents["schemas"]["ProofOfCreditFileKycDocument"];
50225
+ /** Request body for overwriting identity KYC document matches. */
50226
+ KycIdentityMatchesOverwrite: storefrontComponents["schemas"]["KycIdentityMatches"] & {
50227
+ /**
50228
+ * Type of KYC document matches.
50229
+ * If provided, value is `identity-proof` and matches the document type of the KYC document.
50230
+ */
50231
+ type?: "identity-proof";
50232
+ };
50233
+ /** Request body for overwriting address KYC document matches. */
50234
+ KycAddressMatchesOverwrite: storefrontComponents["schemas"]["KycAddressMatches"] & {
50235
+ /**
50236
+ * Type of KYC document matches.
50237
+ * If provided, value is `address-proof` and matches the document type of the KYC document.
50238
+ */
50239
+ type?: "address-proof";
50240
+ };
50241
+ /** Request body for overwriting purchase KYC document matches. */
50242
+ KycPurchaseMatchesOverwrite: storefrontComponents["schemas"]["PurchaseMatches"] & {
50243
+ /**
50244
+ * Type of KYC document matches.
50245
+ * If provided, value is `purchase-proof` and matches the document type of the KYC document.
50246
+ */
50247
+ type?: "purchase-proof";
50248
+ };
50249
+ /** Request body for overwriting funds KYC document matches. */
50250
+ KycFundsMatchesOverwrite: storefrontComponents["schemas"]["FundsMatches"] & {
50251
+ /**
50252
+ * Type of KYC document matches.
50253
+ * If provided, value is `funds-proof` and matches the document type of the KYC document.
50254
+ */
50255
+ type?: "funds-proof";
50256
+ };
49993
50257
  /** Settings for KYC score calculation. */
49994
50258
  KycSettings: {
49995
50259
  identityProof?: storefrontComponents["schemas"]["KycSettingsIdentity"];
@@ -51606,8 +51870,10 @@ export interface storefrontComponents {
51606
51870
  /** ID of the quote. */
51607
51871
  id?: string;
51608
51872
  /**
51609
- * Type of the quote.
51873
+ * Type of the quote for modifications to existing recurring orders.
51610
51874
  * When a quote is accepted, quote items and settings are applied to the related order.
51875
+ * Change quotes can only be created for orders with `active` or `trial-ended` status.
51876
+ * For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
51611
51877
  */
51612
51878
  type: "change";
51613
51879
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -55958,9 +56224,124 @@ export interface storefrontComponents {
55958
56224
  | storefrontComponents["schemas"]["TaxJarCredential"]
55959
56225
  | storefrontComponents["schemas"]["AvalaraCredential"]
55960
56226
  | storefrontComponents["schemas"]["PlaidCredential"];
56227
+ PostSmtpCredential: storefrontComponents["schemas"]["SmtpCredential"] & {
56228
+ /**
56229
+ * Type of the credential.
56230
+ * Value that matches the `{type}` path parameter.
56231
+ * For backward compatibility, when this field is absent,
56232
+ * the `{type}` path parameter supplies the credential type.
56233
+ */
56234
+ type: "smtp";
56235
+ };
56236
+ PostWebhookCredential: storefrontComponents["schemas"]["WebhookCredential"] & {
56237
+ /**
56238
+ * Type of the credential.
56239
+ * Value that matches the `{type}` path parameter.
56240
+ * For backward compatibility, when this field is absent,
56241
+ * the `{type}` path parameter supplies the credential type.
56242
+ */
56243
+ type: "webhook";
56244
+ };
56245
+ PostExperianCredential: storefrontComponents["schemas"]["ExperianCredential"] & {
56246
+ /**
56247
+ * Type of the credential.
56248
+ * Value that matches the `{type}` path parameter.
56249
+ * For backward compatibility, when this field is absent,
56250
+ * the `{type}` path parameter supplies the credential type.
56251
+ */
56252
+ type: "experian";
56253
+ };
56254
+ PostMailgunCredential: storefrontComponents["schemas"]["MailgunCredential"] & {
56255
+ /**
56256
+ * Type of the credential.
56257
+ * Value that matches the `{type}` path parameter.
56258
+ * For backward compatibility, when this field is absent,
56259
+ * the `{type}` path parameter supplies the credential type.
56260
+ */
56261
+ type: "mailgun";
56262
+ };
56263
+ PostOAuth2Credential: storefrontComponents["schemas"]["OAuth2Credential"] & {
56264
+ /**
56265
+ * Type of the credential.
56266
+ * Value that matches the `{type}` path parameter.
56267
+ * For backward compatibility, when this field is absent,
56268
+ * the `{type}` path parameter supplies the credential type.
56269
+ */
56270
+ type: "oauth2";
56271
+ };
56272
+ PostPostmarkCredential: storefrontComponents["schemas"]["PostmarkCredential"] & {
56273
+ /**
56274
+ * Type of the credential.
56275
+ * Value that matches the `{type}` path parameter.
56276
+ * For backward compatibility, when this field is absent,
56277
+ * the `{type}` path parameter supplies the credential type.
56278
+ */
56279
+ type: "postmark";
56280
+ };
56281
+ PostSendGridCredential: storefrontComponents["schemas"]["SendGridCredential"] & {
56282
+ /**
56283
+ * Type of the credential.
56284
+ * Value that matches the `{type}` path parameter.
56285
+ * For backward compatibility, when this field is absent,
56286
+ * the `{type}` path parameter supplies the credential type.
56287
+ */
56288
+ type: "sendgrid";
56289
+ };
56290
+ PostAwsSesCredential: storefrontComponents["schemas"]["SESCredential"] & {
56291
+ /**
56292
+ * Type of the credential.
56293
+ * Value that matches the `{type}` path parameter.
56294
+ * For backward compatibility, when this field is absent,
56295
+ * the `{type}` path parameter supplies the credential type.
56296
+ */
56297
+ type: "aws-ses";
56298
+ };
56299
+ PostTaxJarCredential: storefrontComponents["schemas"]["TaxJarCredential"] & {
56300
+ /**
56301
+ * Type of the credential.
56302
+ * Value that matches the `{type}` path parameter.
56303
+ * For backward compatibility, when this field is absent,
56304
+ * the `{type}` path parameter supplies the credential type.
56305
+ */
56306
+ type: "taxjar";
56307
+ };
56308
+ PostAvalaraCredential: storefrontComponents["schemas"]["AvalaraCredential"] & {
56309
+ /**
56310
+ * Type of the credential.
56311
+ * Value that matches the `{type}` path parameter.
56312
+ * For backward compatibility, when this field is absent,
56313
+ * the `{type}` path parameter supplies the credential type.
56314
+ */
56315
+ type: "avalara";
56316
+ };
56317
+ PostPlaidCredential: storefrontComponents["schemas"]["PlaidCredential"] & {
56318
+ /**
56319
+ * Type of the credential.
56320
+ * Value that matches the `{type}` path parameter.
56321
+ * For backward compatibility, when this field is absent,
56322
+ * the `{type}` path parameter supplies the credential type.
56323
+ */
56324
+ type: "plaid";
56325
+ };
55961
56326
  PatchServiceCredential: {
55962
56327
  /** Status of the credential. */
55963
56328
  status: "active" | "inactive" | "deactivated";
56329
+ /**
56330
+ * Type of the credential.
56331
+ * Value that matches the `{type}` path parameter.
56332
+ * For backward compatibility, when this field is absent,
56333
+ * the `{type}` path parameter supplies the credential type.
56334
+ */
56335
+ type:
56336
+ | "smtp"
56337
+ | "webhook"
56338
+ | "mailgun"
56339
+ | "sendgrid"
56340
+ | "aws-ses"
56341
+ | "oauth2"
56342
+ | "postmark"
56343
+ | "experian"
56344
+ | "avalara";
55964
56345
  };
55965
56346
  /** Plaid credential. */
55966
56347
  PatchPlaidCredential: {
@@ -55980,6 +56361,13 @@ export interface storefrontComponents {
55980
56361
  * This setting enables the creation of Stripe bank account tokens.
55981
56362
  */
55982
56363
  useStripe?: boolean;
56364
+ /**
56365
+ * Type of the credential.
56366
+ * Value that matches the `{type}` path parameter.
56367
+ * For backward compatibility, when this field is absent,
56368
+ * the `{type}` path parameter supplies the credential type.
56369
+ */
56370
+ type: "plaid";
55983
56371
  };
55984
56372
  /** TaxJar credential. */
55985
56373
  PatchTaxJarCredential: {
@@ -55990,6 +56378,13 @@ export interface storefrontComponents {
55990
56378
  * For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
55991
56379
  */
55992
56380
  omitFromAddress?: boolean;
56381
+ /**
56382
+ * Type of the credential.
56383
+ * Value that matches the `{type}` path parameter.
56384
+ * For backward compatibility, when this field is absent,
56385
+ * the `{type}` path parameter supplies the credential type.
56386
+ */
56387
+ type: "taxjar";
55993
56388
  };
55994
56389
  GoogleSpreadsheet: {
55995
56390
  /** ID of the Google Spreadsheet. */
@@ -57123,6 +57518,10 @@ export interface storefrontComponents {
57123
57518
  riskProfile?: string;
57124
57519
  /** Name of the transaction custom field that holds the Level 2/3 data. */
57125
57520
  levelTwoThreeDataCustomField?: string;
57521
+ /** ID of the Digital Payment Application (DPA) for Mastercard Secure Card on File (SCOF). */
57522
+ mastercardDpaId?: string;
57523
+ /** ID of the Mastercard Secure Card on File (SCOF) service. */
57524
+ mastercardServiceId?: string;
57126
57525
  };
57127
57526
  threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
57128
57527
  };
@@ -59180,6 +59579,8 @@ export interface storefrontComponents {
59180
59579
  tokenApiKey: string;
59181
59580
  /** Paybilt API key. */
59182
59581
  apiKey: string;
59582
+ /** Paybilt HMAC key used to verify webhook signatures. */
59583
+ hmacKey?: string;
59183
59584
  };
59184
59585
  threeDSecureServer?: storefrontComponents["schemas"]["ThreeDSecureIO3dsServer"];
59185
59586
  settings?: {
@@ -61326,6 +61727,11 @@ export interface storefrontComponents {
61326
61727
  | null;
61327
61728
  /** Amount allocated to this payment instrument. */
61328
61729
  amount: number;
61730
+ /**
61731
+ * Total approved sales and captures minus approved payouts for the customer,
61732
+ * gateway account, and payment instrument, in the allocation currency.
61733
+ */
61734
+ exposureAmount?: number;
61329
61735
  /** Currency of the payout request allocation. */
61330
61736
  currency: storefrontComponents["schemas"]["CurrencyCode"];
61331
61737
  /** Status of this payout request allocation. */
@@ -62880,6 +63286,17 @@ export interface storefrontComponents {
62880
63286
  | storefrontComponents["schemas"]["PayoutRequestsDataExport"]
62881
63287
  | storefrontComponents["schemas"]["PayoutRequestAllocationsDataExport"]
62882
63288
  | storefrontComponents["schemas"]["UsersDataExport"];
63289
+ DataExportLimitExceeded: { [key: string]: any } & {
63290
+ /** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
63291
+ type: "data-export-limit-exceeded";
63292
+ /** HTTP status code. */
63293
+ status?: number;
63294
+ } & storefrontComponents["schemas"]["DetailedProblem"] & {
63295
+ /** Number of records that match the export request. */
63296
+ matchedRecords: number;
63297
+ /** Maximum number of records for a single export. */
63298
+ maxRecords: number;
63299
+ };
62883
63300
  OrganizationExport: {
62884
63301
  /** Unique resource ID. */
62885
63302
  id?: string;
@@ -63696,7 +64113,11 @@ export interface storefrontComponents {
63696
64113
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
63697
64114
  /** Tax numbers associated with the account. */
63698
64115
  taxNumbers?: storefrontComponents["schemas"]["TaxNumber"][] | null;
63699
- /** Additional email addresses for notification delivery. */
64116
+ /**
64117
+ * Email addresses for notification delivery in event-based email notifications.
64118
+ * 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.
64119
+ * For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
64120
+ */
63700
64121
  notificationEmails?: string[];
63701
64122
  _links?: storefrontComponents["schemas"]["SelfLink"];
63702
64123
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -65034,8 +65455,10 @@ export interface storefrontComponents {
65034
65455
  /** ID of the quote. */
65035
65456
  id?: string;
65036
65457
  /**
65037
- * Type of the quote.
65458
+ * Type of the quote for modifications to existing recurring orders.
65038
65459
  * When a quote is accepted, quote items and settings are applied to the related order.
65460
+ * Change quotes can only be created for orders with `active` or `trial-ended` status.
65461
+ * For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
65039
65462
  */
65040
65463
  type?: "change";
65041
65464
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -66526,6 +66949,14 @@ export interface storefrontComponents {
66526
66949
  "application/json": storefrontComponents["schemas"]["BadRequest"];
66527
66950
  };
66528
66951
  };
66952
+ /** Invalid data sent, or the export exceeds the maximum record limit. */
66953
+ DataExportValidationError: {
66954
+ content: {
66955
+ "application/json":
66956
+ | storefrontComponents["schemas"]["ValidationError"]
66957
+ | storefrontComponents["schemas"]["DataExportLimitExceeded"];
66958
+ };
66959
+ };
66529
66960
  /**
66530
66961
  * Request accepted.
66531
66962
  * No response body returned.
@@ -67309,13 +67740,29 @@ export interface storefrontComponents {
67309
67740
  };
67310
67741
  };
67311
67742
  /** Service credential resource. */
67743
+ PostCredential: {
67744
+ content: {
67745
+ "application/json":
67746
+ | storefrontComponents["schemas"]["PostSmtpCredential"]
67747
+ | storefrontComponents["schemas"]["PostWebhookCredential"]
67748
+ | storefrontComponents["schemas"]["PostExperianCredential"]
67749
+ | storefrontComponents["schemas"]["PostMailgunCredential"]
67750
+ | storefrontComponents["schemas"]["PostOAuth2Credential"]
67751
+ | storefrontComponents["schemas"]["PostPostmarkCredential"]
67752
+ | storefrontComponents["schemas"]["PostSendGridCredential"]
67753
+ | storefrontComponents["schemas"]["PostAwsSesCredential"]
67754
+ | storefrontComponents["schemas"]["PostTaxJarCredential"]
67755
+ | storefrontComponents["schemas"]["PostAvalaraCredential"]
67756
+ | storefrontComponents["schemas"]["PostPlaidCredential"];
67757
+ };
67758
+ };
67759
+ /** Service credential resource. */
67312
67760
  PatchCredential: {
67313
67761
  content: {
67314
- "application/json": Partial<
67315
- storefrontComponents["schemas"]["PatchServiceCredential"]
67316
- > &
67317
- Partial<storefrontComponents["schemas"]["PatchPlaidCredential"]> &
67318
- Partial<storefrontComponents["schemas"]["PatchTaxJarCredential"]>;
67762
+ "application/json":
67763
+ | storefrontComponents["schemas"]["PatchServiceCredential"]
67764
+ | storefrontComponents["schemas"]["PatchPlaidCredential"]
67765
+ | storefrontComponents["schemas"]["PatchTaxJarCredential"];
67319
67766
  };
67320
67767
  };
67321
67768
  /** Ruleset resource. */
@@ -72620,7 +73067,11 @@ export interface reportsComponents {
72620
73067
  leadSource?: reportsComponents["schemas"]["LeadSourceData"];
72621
73068
  /** ID of the associated person. */
72622
73069
  personId?: string | null;
72623
- /** Additional email addresses for notification delivery. */
73070
+ /**
73071
+ * Email addresses for notification delivery in event-based email notifications.
73072
+ * 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.
73073
+ * For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
73074
+ */
72624
73075
  notificationEmails?: string[];
72625
73076
  /** Related links. */
72626
73077
  _links?: {
@@ -76022,6 +76473,38 @@ export interface reportsComponents {
76022
76473
  | reportsComponents["schemas"]["ProofOfFundsKycDocument"]
76023
76474
  | reportsComponents["schemas"]["ProofOfPurchaseKycDocument"]
76024
76475
  | reportsComponents["schemas"]["ProofOfCreditFileKycDocument"];
76476
+ /** Request body for overwriting identity KYC document matches. */
76477
+ KycIdentityMatchesOverwrite: reportsComponents["schemas"]["KycIdentityMatches"] & {
76478
+ /**
76479
+ * Type of KYC document matches.
76480
+ * If provided, value is `identity-proof` and matches the document type of the KYC document.
76481
+ */
76482
+ type?: "identity-proof";
76483
+ };
76484
+ /** Request body for overwriting address KYC document matches. */
76485
+ KycAddressMatchesOverwrite: reportsComponents["schemas"]["KycAddressMatches"] & {
76486
+ /**
76487
+ * Type of KYC document matches.
76488
+ * If provided, value is `address-proof` and matches the document type of the KYC document.
76489
+ */
76490
+ type?: "address-proof";
76491
+ };
76492
+ /** Request body for overwriting purchase KYC document matches. */
76493
+ KycPurchaseMatchesOverwrite: reportsComponents["schemas"]["PurchaseMatches"] & {
76494
+ /**
76495
+ * Type of KYC document matches.
76496
+ * If provided, value is `purchase-proof` and matches the document type of the KYC document.
76497
+ */
76498
+ type?: "purchase-proof";
76499
+ };
76500
+ /** Request body for overwriting funds KYC document matches. */
76501
+ KycFundsMatchesOverwrite: reportsComponents["schemas"]["FundsMatches"] & {
76502
+ /**
76503
+ * Type of KYC document matches.
76504
+ * If provided, value is `funds-proof` and matches the document type of the KYC document.
76505
+ */
76506
+ type?: "funds-proof";
76507
+ };
76025
76508
  /** Settings for KYC score calculation. */
76026
76509
  KycSettings: {
76027
76510
  identityProof?: reportsComponents["schemas"]["KycSettingsIdentity"];
@@ -77638,8 +78121,10 @@ export interface reportsComponents {
77638
78121
  /** ID of the quote. */
77639
78122
  id?: string;
77640
78123
  /**
77641
- * Type of the quote.
78124
+ * Type of the quote for modifications to existing recurring orders.
77642
78125
  * When a quote is accepted, quote items and settings are applied to the related order.
78126
+ * Change quotes can only be created for orders with `active` or `trial-ended` status.
78127
+ * For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
77643
78128
  */
77644
78129
  type: "change";
77645
78130
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -81990,9 +82475,124 @@ export interface reportsComponents {
81990
82475
  | reportsComponents["schemas"]["TaxJarCredential"]
81991
82476
  | reportsComponents["schemas"]["AvalaraCredential"]
81992
82477
  | reportsComponents["schemas"]["PlaidCredential"];
82478
+ PostSmtpCredential: reportsComponents["schemas"]["SmtpCredential"] & {
82479
+ /**
82480
+ * Type of the credential.
82481
+ * Value that matches the `{type}` path parameter.
82482
+ * For backward compatibility, when this field is absent,
82483
+ * the `{type}` path parameter supplies the credential type.
82484
+ */
82485
+ type: "smtp";
82486
+ };
82487
+ PostWebhookCredential: reportsComponents["schemas"]["WebhookCredential"] & {
82488
+ /**
82489
+ * Type of the credential.
82490
+ * Value that matches the `{type}` path parameter.
82491
+ * For backward compatibility, when this field is absent,
82492
+ * the `{type}` path parameter supplies the credential type.
82493
+ */
82494
+ type: "webhook";
82495
+ };
82496
+ PostExperianCredential: reportsComponents["schemas"]["ExperianCredential"] & {
82497
+ /**
82498
+ * Type of the credential.
82499
+ * Value that matches the `{type}` path parameter.
82500
+ * For backward compatibility, when this field is absent,
82501
+ * the `{type}` path parameter supplies the credential type.
82502
+ */
82503
+ type: "experian";
82504
+ };
82505
+ PostMailgunCredential: reportsComponents["schemas"]["MailgunCredential"] & {
82506
+ /**
82507
+ * Type of the credential.
82508
+ * Value that matches the `{type}` path parameter.
82509
+ * For backward compatibility, when this field is absent,
82510
+ * the `{type}` path parameter supplies the credential type.
82511
+ */
82512
+ type: "mailgun";
82513
+ };
82514
+ PostOAuth2Credential: reportsComponents["schemas"]["OAuth2Credential"] & {
82515
+ /**
82516
+ * Type of the credential.
82517
+ * Value that matches the `{type}` path parameter.
82518
+ * For backward compatibility, when this field is absent,
82519
+ * the `{type}` path parameter supplies the credential type.
82520
+ */
82521
+ type: "oauth2";
82522
+ };
82523
+ PostPostmarkCredential: reportsComponents["schemas"]["PostmarkCredential"] & {
82524
+ /**
82525
+ * Type of the credential.
82526
+ * Value that matches the `{type}` path parameter.
82527
+ * For backward compatibility, when this field is absent,
82528
+ * the `{type}` path parameter supplies the credential type.
82529
+ */
82530
+ type: "postmark";
82531
+ };
82532
+ PostSendGridCredential: reportsComponents["schemas"]["SendGridCredential"] & {
82533
+ /**
82534
+ * Type of the credential.
82535
+ * Value that matches the `{type}` path parameter.
82536
+ * For backward compatibility, when this field is absent,
82537
+ * the `{type}` path parameter supplies the credential type.
82538
+ */
82539
+ type: "sendgrid";
82540
+ };
82541
+ PostAwsSesCredential: reportsComponents["schemas"]["SESCredential"] & {
82542
+ /**
82543
+ * Type of the credential.
82544
+ * Value that matches the `{type}` path parameter.
82545
+ * For backward compatibility, when this field is absent,
82546
+ * the `{type}` path parameter supplies the credential type.
82547
+ */
82548
+ type: "aws-ses";
82549
+ };
82550
+ PostTaxJarCredential: reportsComponents["schemas"]["TaxJarCredential"] & {
82551
+ /**
82552
+ * Type of the credential.
82553
+ * Value that matches the `{type}` path parameter.
82554
+ * For backward compatibility, when this field is absent,
82555
+ * the `{type}` path parameter supplies the credential type.
82556
+ */
82557
+ type: "taxjar";
82558
+ };
82559
+ PostAvalaraCredential: reportsComponents["schemas"]["AvalaraCredential"] & {
82560
+ /**
82561
+ * Type of the credential.
82562
+ * Value that matches the `{type}` path parameter.
82563
+ * For backward compatibility, when this field is absent,
82564
+ * the `{type}` path parameter supplies the credential type.
82565
+ */
82566
+ type: "avalara";
82567
+ };
82568
+ PostPlaidCredential: reportsComponents["schemas"]["PlaidCredential"] & {
82569
+ /**
82570
+ * Type of the credential.
82571
+ * Value that matches the `{type}` path parameter.
82572
+ * For backward compatibility, when this field is absent,
82573
+ * the `{type}` path parameter supplies the credential type.
82574
+ */
82575
+ type: "plaid";
82576
+ };
81993
82577
  PatchServiceCredential: {
81994
82578
  /** Status of the credential. */
81995
82579
  status: "active" | "inactive" | "deactivated";
82580
+ /**
82581
+ * Type of the credential.
82582
+ * Value that matches the `{type}` path parameter.
82583
+ * For backward compatibility, when this field is absent,
82584
+ * the `{type}` path parameter supplies the credential type.
82585
+ */
82586
+ type:
82587
+ | "smtp"
82588
+ | "webhook"
82589
+ | "mailgun"
82590
+ | "sendgrid"
82591
+ | "aws-ses"
82592
+ | "oauth2"
82593
+ | "postmark"
82594
+ | "experian"
82595
+ | "avalara";
81996
82596
  };
81997
82597
  /** Plaid credential. */
81998
82598
  PatchPlaidCredential: {
@@ -82012,6 +82612,13 @@ export interface reportsComponents {
82012
82612
  * This setting enables the creation of Stripe bank account tokens.
82013
82613
  */
82014
82614
  useStripe?: boolean;
82615
+ /**
82616
+ * Type of the credential.
82617
+ * Value that matches the `{type}` path parameter.
82618
+ * For backward compatibility, when this field is absent,
82619
+ * the `{type}` path parameter supplies the credential type.
82620
+ */
82621
+ type: "plaid";
82015
82622
  };
82016
82623
  /** TaxJar credential. */
82017
82624
  PatchTaxJarCredential: {
@@ -82022,6 +82629,13 @@ export interface reportsComponents {
82022
82629
  * For more information, see [TaxJar API guide](https://developers.taxjar.com/api/guides/#when-to-use-from_-address-information).
82023
82630
  */
82024
82631
  omitFromAddress?: boolean;
82632
+ /**
82633
+ * Type of the credential.
82634
+ * Value that matches the `{type}` path parameter.
82635
+ * For backward compatibility, when this field is absent,
82636
+ * the `{type}` path parameter supplies the credential type.
82637
+ */
82638
+ type: "taxjar";
82025
82639
  };
82026
82640
  GoogleSpreadsheet: {
82027
82641
  /** ID of the Google Spreadsheet. */
@@ -83155,6 +83769,10 @@ export interface reportsComponents {
83155
83769
  riskProfile?: string;
83156
83770
  /** Name of the transaction custom field that holds the Level 2/3 data. */
83157
83771
  levelTwoThreeDataCustomField?: string;
83772
+ /** ID of the Digital Payment Application (DPA) for Mastercard Secure Card on File (SCOF). */
83773
+ mastercardDpaId?: string;
83774
+ /** ID of the Mastercard Secure Card on File (SCOF) service. */
83775
+ mastercardServiceId?: string;
83158
83776
  };
83159
83777
  threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
83160
83778
  };
@@ -85212,6 +85830,8 @@ export interface reportsComponents {
85212
85830
  tokenApiKey: string;
85213
85831
  /** Paybilt API key. */
85214
85832
  apiKey: string;
85833
+ /** Paybilt HMAC key used to verify webhook signatures. */
85834
+ hmacKey?: string;
85215
85835
  };
85216
85836
  threeDSecureServer?: reportsComponents["schemas"]["ThreeDSecureIO3dsServer"];
85217
85837
  settings?: {
@@ -87358,6 +87978,11 @@ export interface reportsComponents {
87358
87978
  | null;
87359
87979
  /** Amount allocated to this payment instrument. */
87360
87980
  amount: number;
87981
+ /**
87982
+ * Total approved sales and captures minus approved payouts for the customer,
87983
+ * gateway account, and payment instrument, in the allocation currency.
87984
+ */
87985
+ exposureAmount?: number;
87361
87986
  /** Currency of the payout request allocation. */
87362
87987
  currency: reportsComponents["schemas"]["CurrencyCode"];
87363
87988
  /** Status of this payout request allocation. */
@@ -88912,6 +89537,17 @@ export interface reportsComponents {
88912
89537
  | reportsComponents["schemas"]["PayoutRequestsDataExport"]
88913
89538
  | reportsComponents["schemas"]["PayoutRequestAllocationsDataExport"]
88914
89539
  | reportsComponents["schemas"]["UsersDataExport"];
89540
+ DataExportLimitExceeded: { [key: string]: any } & {
89541
+ /** Machine-readable error code for this problem type, which consumers use to handle the failure programmatically. */
89542
+ type: "data-export-limit-exceeded";
89543
+ /** HTTP status code. */
89544
+ status?: number;
89545
+ } & reportsComponents["schemas"]["DetailedProblem"] & {
89546
+ /** Number of records that match the export request. */
89547
+ matchedRecords: number;
89548
+ /** Maximum number of records for a single export. */
89549
+ maxRecords: number;
89550
+ };
88915
89551
  OrganizationExport: {
88916
89552
  /** Unique resource ID. */
88917
89553
  id?: string;
@@ -89728,7 +90364,11 @@ export interface reportsComponents {
89728
90364
  updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
89729
90365
  /** Tax numbers associated with the account. */
89730
90366
  taxNumbers?: reportsComponents["schemas"]["TaxNumber"][] | null;
89731
- /** Additional email addresses for notification delivery. */
90367
+ /**
90368
+ * Email addresses for notification delivery in event-based email notifications.
90369
+ * 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.
90370
+ * For more information, see [Manage notification emails](https://www.rebilly.com/docs/data-tables/manage-customer-information#manage-notification-emails).
90371
+ */
89732
90372
  notificationEmails?: string[];
89733
90373
  _links?: reportsComponents["schemas"]["SelfLink"];
89734
90374
  /** Embedded objects that are requested by the `expand` query parameter. */
@@ -91066,8 +91706,10 @@ export interface reportsComponents {
91066
91706
  /** ID of the quote. */
91067
91707
  id?: string;
91068
91708
  /**
91069
- * Type of the quote.
91709
+ * Type of the quote for modifications to existing recurring orders.
91070
91710
  * When a quote is accepted, quote items and settings are applied to the related order.
91711
+ * Change quotes can only be created for orders with `active` or `trial-ended` status.
91712
+ * For `trial-ended` orders, use this quote type to convert a trial-only order to a regular recurring order.
91071
91713
  */
91072
91714
  type?: "change";
91073
91715
  /** Conditions that must be met for the quote to be automatically accepted. */
@@ -92558,6 +93200,14 @@ export interface reportsComponents {
92558
93200
  "application/json": reportsComponents["schemas"]["BadRequest"];
92559
93201
  };
92560
93202
  };
93203
+ /** Invalid data sent, or the export exceeds the maximum record limit. */
93204
+ DataExportValidationError: {
93205
+ content: {
93206
+ "application/json":
93207
+ | reportsComponents["schemas"]["ValidationError"]
93208
+ | reportsComponents["schemas"]["DataExportLimitExceeded"];
93209
+ };
93210
+ };
92561
93211
  /**
92562
93212
  * Request accepted.
92563
93213
  * No response body returned.
@@ -93341,13 +93991,29 @@ export interface reportsComponents {
93341
93991
  };
93342
93992
  };
93343
93993
  /** Service credential resource. */
93994
+ PostCredential: {
93995
+ content: {
93996
+ "application/json":
93997
+ | reportsComponents["schemas"]["PostSmtpCredential"]
93998
+ | reportsComponents["schemas"]["PostWebhookCredential"]
93999
+ | reportsComponents["schemas"]["PostExperianCredential"]
94000
+ | reportsComponents["schemas"]["PostMailgunCredential"]
94001
+ | reportsComponents["schemas"]["PostOAuth2Credential"]
94002
+ | reportsComponents["schemas"]["PostPostmarkCredential"]
94003
+ | reportsComponents["schemas"]["PostSendGridCredential"]
94004
+ | reportsComponents["schemas"]["PostAwsSesCredential"]
94005
+ | reportsComponents["schemas"]["PostTaxJarCredential"]
94006
+ | reportsComponents["schemas"]["PostAvalaraCredential"]
94007
+ | reportsComponents["schemas"]["PostPlaidCredential"];
94008
+ };
94009
+ };
94010
+ /** Service credential resource. */
93344
94011
  PatchCredential: {
93345
94012
  content: {
93346
- "application/json": Partial<
93347
- reportsComponents["schemas"]["PatchServiceCredential"]
93348
- > &
93349
- Partial<reportsComponents["schemas"]["PatchPlaidCredential"]> &
93350
- Partial<reportsComponents["schemas"]["PatchTaxJarCredential"]>;
94013
+ "application/json":
94014
+ | reportsComponents["schemas"]["PatchServiceCredential"]
94015
+ | reportsComponents["schemas"]["PatchPlaidCredential"]
94016
+ | reportsComponents["schemas"]["PatchTaxJarCredential"];
93351
94017
  };
93352
94018
  };
93353
94019
  /** Ruleset resource. */
@@ -94885,7 +95551,7 @@ export interface operations {
94885
95551
  };
94886
95552
  401: reportsComponents["responses"]["Unauthorized"];
94887
95553
  403: reportsComponents["responses"]["Forbidden"];
94888
- 422: reportsComponents["responses"]["ValidationError"];
95554
+ 422: reportsComponents["responses"]["DataExportValidationError"];
94889
95555
  429: reportsComponents["responses"]["TooManyRequests"];
94890
95556
  };
94891
95557
  requestBody: reportsComponents["requestBodies"]["DataExport"];
@@ -94956,7 +95622,7 @@ export interface operations {
94956
95622
  };
94957
95623
  401: reportsComponents["responses"]["Unauthorized"];
94958
95624
  403: reportsComponents["responses"]["Forbidden"];
94959
- 422: reportsComponents["responses"]["ValidationError"];
95625
+ 422: reportsComponents["responses"]["DataExportValidationError"];
94960
95626
  429: reportsComponents["responses"]["TooManyRequests"];
94961
95627
  };
94962
95628
  requestBody: reportsComponents["requestBodies"]["DataExport"];
@@ -96666,9 +97332,8 @@ declare module "rebilly-js-sdk" {
96666
97332
  export type GetCustomerCreditBalanceRequest = rebilly.GetCustomerCreditBalanceRequest;
96667
97333
  export type GetCustomerCreditBalanceResponse = rebilly.GetCustomerCreditBalanceResponse;
96668
97334
  export type GetCustomerCreditBalanceResponsePromise = rebilly.GetCustomerCreditBalanceResponsePromise;
96669
- export type GetCustomerComplianceScreeningReportRequest = rebilly.GetCustomerComplianceScreeningReportRequest;
96670
- export type GetCustomerComplianceScreeningReportResponse = rebilly.GetCustomerComplianceScreeningReportResponse;
96671
- export type GetCustomerComplianceScreeningReportResponsePromise = rebilly.GetCustomerComplianceScreeningReportResponsePromise;
97335
+ export type PostCustomerComplianceScreeningReportResponse = rebilly.PostCustomerComplianceScreeningReportResponse;
97336
+ export type PostCustomerComplianceScreeningReportResponsePromise = rebilly.PostCustomerComplianceScreeningReportResponsePromise;
96672
97337
  export type GetDisputeCollectionRequest = rebilly.GetDisputeCollectionRequest;
96673
97338
  export type GetDisputeCollectionResponse = rebilly.GetDisputeCollectionResponse;
96674
97339
  export type GetDisputeCollectionResponsePromise = rebilly.GetDisputeCollectionResponsePromise;
@@ -98986,6 +99651,9 @@ declare module "resources/customers-resource" {
98986
99651
  getCustomerCreditBalance({ id }: {
98987
99652
  id: any;
98988
99653
  }): rebilly.GetCustomerCreditBalanceResponsePromise;
99654
+ generateComplianceScreeningReport({ id }: {
99655
+ id: any;
99656
+ }): any;
98989
99657
  downloadComplianceScreeningReport({ id }: {
98990
99658
  id: any;
98991
99659
  }): any;
@@ -100932,6 +101600,9 @@ declare module "resources/api-instance" {
100932
101600
  getCustomerCreditBalance({ id }: {
100933
101601
  id: any;
100934
101602
  }): rebilly.GetCustomerCreditBalanceResponsePromise;
101603
+ generateComplianceScreeningReport({ id }: {
101604
+ id: any;
101605
+ }): any;
100935
101606
  downloadComplianceScreeningReport({ id }: {
100936
101607
  id: any;
100937
101608
  }): any;