rebilly-js-sdk 62.158.3 → 62.160.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1 +1,6 @@
1
- ## [62.158.3](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.158.2...rebilly-js-sdk-v62.158.3) (2026-08-12)
1
+ ## [62.160.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v62.159.0...rebilly-js-sdk-v62.160.0) (2026-08-18)
2
+
3
+
4
+ ### Features
5
+
6
+ * **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#24925](https://github.com/Rebilly/rebilly/issues/24925)) ([7d8ac25](https://github.com/Rebilly/rebilly/commit/7d8ac250ada869a4191a53f57f43dbcb8a6626fe))
@@ -3137,7 +3137,10 @@ export interface corePaths {
3137
3137
  "/invoices/{id}": {
3138
3138
  /** Retrieves an invoice with a specified ID. */
3139
3139
  get: operations["GetInvoice"];
3140
- /** Creates or updates (upserts) an invoice with a specified ID. */
3140
+ /**
3141
+ * Creates or updates (upserts) an invoice with a specified ID.
3142
+ * Returns a conflict error if the specified ID belongs to an upcoming invoice.
3143
+ */
3141
3144
  put: operations["PutInvoice"];
3142
3145
  parameters: {
3143
3146
  path: {
@@ -7496,6 +7499,7 @@ export interface coreComponents {
7496
7499
  | "Perfect-money"
7497
7500
  | "Piastrix"
7498
7501
  | "PIX"
7502
+ | "PIX-Automatico"
7499
7503
  | "PinPay"
7500
7504
  | "phone"
7501
7505
  | "PhonePe"
@@ -11702,6 +11706,7 @@ export interface coreComponents {
11702
11706
  | "Perfect-money"
11703
11707
  | "Piastrix"
11704
11708
  | "PIX"
11709
+ | "PIX-Automatico"
11705
11710
  | "plaid-account"
11706
11711
  | "PayTabs"
11707
11712
  | "Paysafecard"
@@ -13396,6 +13401,13 @@ export interface coreComponents {
13396
13401
  * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
13397
13402
  */
13398
13403
  Country: string;
13404
+ /**
13405
+ * ISO 3166 alpha-2 country code where the payment is processed.
13406
+ * This is often the location for settling the payment.
13407
+ * Consult with your Payment Service Provider (PSP) to determine the
13408
+ * appropriate country code.
13409
+ */
13410
+ DigitalWalletCountry: coreComponents["schemas"]["Country"];
13399
13411
  ApplePayFeature: {
13400
13412
  /** Name of the feature. */
13401
13413
  name?: "Apple Pay";
@@ -13405,7 +13417,7 @@ export interface coreComponents {
13405
13417
  * Do not localize the name.
13406
13418
  */
13407
13419
  displayName?: string;
13408
- country?: coreComponents["schemas"]["Country"];
13420
+ country?: coreComponents["schemas"]["DigitalWalletCountry"];
13409
13421
  };
13410
13422
  GooglePayFeature: {
13411
13423
  /** Name of the feature. */
@@ -13417,7 +13429,7 @@ export interface coreComponents {
13417
13429
  * The fully qualified domain name.
13418
13430
  */
13419
13431
  merchantOrigin?: string;
13420
- country?: coreComponents["schemas"]["Country"];
13432
+ country?: coreComponents["schemas"]["DigitalWalletCountry"];
13421
13433
  };
13422
13434
  SamsungPayFeature: {
13423
13435
  /** Name of the feature. */
@@ -18404,6 +18416,14 @@ export interface coreComponents {
18404
18416
  | "covered-payout"
18405
18417
  | "approved-payment"
18406
18418
  | "none";
18419
+ /**
18420
+ * Payout limits for the gateway account applied during payout request auto-allocation.
18421
+ * These limits do not apply to manual allocations.
18422
+ *
18423
+ * This field is distinct from deposit and sale
18424
+ * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
18425
+ */
18426
+ payoutLimits?: coreComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
18407
18427
  /**
18408
18428
  * Email address template used in place of a customer's real email address when sending transaction data to a processor.
18409
18429
  * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -21801,6 +21821,8 @@ export interface coreComponents {
21801
21821
  merchantId: string;
21802
21822
  /** API key for Viva basic authentication. */
21803
21823
  apiKey: string;
21824
+ /** Key of the Viva IPN validation. */
21825
+ ipnKey: string;
21804
21826
  };
21805
21827
  /** Viva settings object. */
21806
21828
  settings?: {
@@ -22100,7 +22122,7 @@ export interface coreComponents {
22100
22122
  * Do not localize this name.
22101
22123
  */
22102
22124
  displayName?: string | null;
22103
- country?: coreComponents["schemas"]["Country"];
22125
+ country?: coreComponents["schemas"]["DigitalWalletCountry"];
22104
22126
  };
22105
22127
  /**
22106
22128
  * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -22116,9 +22138,40 @@ export interface coreComponents {
22116
22138
  * This uses the fully qualified domain name.
22117
22139
  */
22118
22140
  merchantOrigin?: string | null;
22119
- country?: coreComponents["schemas"]["Country"];
22141
+ country?: coreComponents["schemas"]["DigitalWalletCountry"];
22120
22142
  };
22121
22143
  };
22144
+ /**
22145
+ * Payout method limits for payout request auto-allocation.
22146
+ * Limits apply to auto-allocation only.
22147
+ * Manual allocations are uncapped.
22148
+ */
22149
+ GatewayAccountPayoutLimits: {
22150
+ /**
22151
+ * Maximum amount limit for single allocation.
22152
+ * At most one entry per each currency that this gateway account supports.
22153
+ */
22154
+ maxPerTransaction?:
22155
+ | {
22156
+ /** Limit amount. */
22157
+ amount: number;
22158
+ currency: coreComponents["schemas"]["CurrencyCode"];
22159
+ }[]
22160
+ | null;
22161
+ /**
22162
+ * Maximum amount limit for a rolling period.
22163
+ * At most one entry per each currency that this gateway account supports.
22164
+ */
22165
+ maxPerPeriod?:
22166
+ | {
22167
+ /** Limit amount. */
22168
+ amount: number;
22169
+ currency: coreComponents["schemas"]["CurrencyCode"];
22170
+ /** Rolling period for the amount limit. */
22171
+ period: "24-hours";
22172
+ }[]
22173
+ | null;
22174
+ };
22122
22175
  ValidationErrorExtensions: {
22123
22176
  /** Invalid field details. */
22124
22177
  invalidFields?: {
@@ -22503,6 +22556,21 @@ export interface coreComponents {
22503
22556
  /** List of email addresses to send notifications to. */
22504
22557
  notificationEmailAddresses?: string[];
22505
22558
  };
22559
+ /**
22560
+ * Settings for annual compliance screening of all active customers.
22561
+ * When enabled, a compliance screening report is generated for every active customer
22562
+ * on the configured month and day each year.
22563
+ */
22564
+ annualComplianceScreening?: {
22565
+ /** Specifies whether annual compliance screening is enabled for the organization. */
22566
+ enabled?: boolean;
22567
+ /**
22568
+ * Month and day when annual compliance screening runs, in `MM-DD` format.
22569
+ * Required when `enabled` is `true`.
22570
+ * Valid calendar date only. Leap day `02-29` is not allowed.
22571
+ */
22572
+ monthDay?: string | null;
22573
+ };
22506
22574
  /**
22507
22575
  * Default order for auto-allocation of payout requests.
22508
22576
  * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -25062,17 +25130,36 @@ export interface coreComponents {
25062
25130
  TimeSeriesTransaction: {
25063
25131
  /** Time series data. */
25064
25132
  data?: {
25065
- /** Date in `YYYY-MM-DD` format . */
25133
+ /** Date in `YYYY-MM-DD` format. */
25066
25134
  date?: string;
25067
- /** Total number of all transactions within the aggregation. */
25135
+ /**
25136
+ * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
25137
+ * - `count`: Total number of transactions.
25138
+ * - `amount`: Total amount of approved transactions in the merchant reporting currency.
25139
+ * - `approval-rate`: Ratio of approved transactions to all transactions.
25140
+ * - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
25141
+ *
25142
+ * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
25143
+ * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
25144
+ * Transactions with no value for the `subaggregate` field are also included.
25145
+ */
25068
25146
  total?: number;
25069
- /** Subaggregates that have transactions within the range. */
25147
+ /**
25148
+ * Breakdown by the `subaggregate` field for the day.
25149
+ * Each element contains one `subaggregate` value and its aggregated value.
25150
+ * Each `subaggregate` value found in the report has an element,
25151
+ * in the same order for each day.
25152
+ */
25070
25153
  subaggregates?: {
25071
- /** ID of the subaggregate. */
25154
+ /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
25072
25155
  subaggregate?: string;
25073
- /** Total number of all subaggregate transactions within the aggregation. */
25156
+ /**
25157
+ * Aggregated value for transactions that have this `subaggregate` value,
25158
+ * in the same unit as `total`.
25159
+ * This value is `0` if no transactions have this `subaggregate` value.
25160
+ */
25074
25161
  value?: number;
25075
- };
25162
+ }[];
25076
25163
  }[];
25077
25164
  };
25078
25165
  ReportDisputeDelays: {
@@ -30199,6 +30286,18 @@ export interface coreComponents {
30199
30286
  * This value is `null` if the export failed.
30200
30287
  */
30201
30288
  fileId?: string | null;
30289
+ /**
30290
+ * Total number of records in the export, excluding the header row.
30291
+ * This value is `0` if the export failed.
30292
+ */
30293
+ recordCount?: number;
30294
+ /**
30295
+ * Status of the data export.
30296
+ * This webhook is sent only when the data export reaches a terminal status.
30297
+ * This value is never `pending`, `queued`, or `processing`.
30298
+ */
30299
+ status?: "completed" | "failed";
30300
+ failureReason?: coreComponents["schemas"]["DataExportFailureReason"];
30202
30301
  /** Type of event that triggered the webhook. */
30203
30302
  eventType?: "data-export-completed" | "data-export-failed";
30204
30303
  /** Embedded objects related to the data export event. */
@@ -32799,7 +32898,10 @@ export interface operations {
32799
32898
  404: coreComponents["responses"]["NotFound"];
32800
32899
  };
32801
32900
  };
32802
- /** Creates or updates (upserts) an invoice with a specified ID. */
32901
+ /**
32902
+ * Creates or updates (upserts) an invoice with a specified ID.
32903
+ * Returns a conflict error if the specified ID belongs to an upcoming invoice.
32904
+ */
32803
32905
  PutInvoice: {
32804
32906
  parameters: {
32805
32907
  path: {
@@ -32825,6 +32927,7 @@ export interface operations {
32825
32927
  401: coreComponents["responses"]["Unauthorized"];
32826
32928
  403: coreComponents["responses"]["Forbidden"];
32827
32929
  404: coreComponents["responses"]["NotFound"];
32930
+ 409: coreComponents["responses"]["Conflict"];
32828
32931
  422: coreComponents["responses"]["ValidationError"];
32829
32932
  429: coreComponents["responses"]["TooManyRequests"];
32830
32933
  };
@@ -46534,6 +46637,7 @@ export interface storefrontComponents {
46534
46637
  | "Perfect-money"
46535
46638
  | "Piastrix"
46536
46639
  | "PIX"
46640
+ | "PIX-Automatico"
46537
46641
  | "PinPay"
46538
46642
  | "phone"
46539
46643
  | "PhonePe"
@@ -50740,6 +50844,7 @@ export interface storefrontComponents {
50740
50844
  | "Perfect-money"
50741
50845
  | "Piastrix"
50742
50846
  | "PIX"
50847
+ | "PIX-Automatico"
50743
50848
  | "plaid-account"
50744
50849
  | "PayTabs"
50745
50850
  | "Paysafecard"
@@ -52434,6 +52539,13 @@ export interface storefrontComponents {
52434
52539
  * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
52435
52540
  */
52436
52541
  Country: string;
52542
+ /**
52543
+ * ISO 3166 alpha-2 country code where the payment is processed.
52544
+ * This is often the location for settling the payment.
52545
+ * Consult with your Payment Service Provider (PSP) to determine the
52546
+ * appropriate country code.
52547
+ */
52548
+ DigitalWalletCountry: storefrontComponents["schemas"]["Country"];
52437
52549
  ApplePayFeature: {
52438
52550
  /** Name of the feature. */
52439
52551
  name?: "Apple Pay";
@@ -52443,7 +52555,7 @@ export interface storefrontComponents {
52443
52555
  * Do not localize the name.
52444
52556
  */
52445
52557
  displayName?: string;
52446
- country?: storefrontComponents["schemas"]["Country"];
52558
+ country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
52447
52559
  };
52448
52560
  GooglePayFeature: {
52449
52561
  /** Name of the feature. */
@@ -52455,7 +52567,7 @@ export interface storefrontComponents {
52455
52567
  * The fully qualified domain name.
52456
52568
  */
52457
52569
  merchantOrigin?: string;
52458
- country?: storefrontComponents["schemas"]["Country"];
52570
+ country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
52459
52571
  };
52460
52572
  SamsungPayFeature: {
52461
52573
  /** Name of the feature. */
@@ -57442,6 +57554,14 @@ export interface storefrontComponents {
57442
57554
  | "covered-payout"
57443
57555
  | "approved-payment"
57444
57556
  | "none";
57557
+ /**
57558
+ * Payout limits for the gateway account applied during payout request auto-allocation.
57559
+ * These limits do not apply to manual allocations.
57560
+ *
57561
+ * This field is distinct from deposit and sale
57562
+ * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
57563
+ */
57564
+ payoutLimits?: storefrontComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
57445
57565
  /**
57446
57566
  * Email address template used in place of a customer's real email address when sending transaction data to a processor.
57447
57567
  * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -60839,6 +60959,8 @@ export interface storefrontComponents {
60839
60959
  merchantId: string;
60840
60960
  /** API key for Viva basic authentication. */
60841
60961
  apiKey: string;
60962
+ /** Key of the Viva IPN validation. */
60963
+ ipnKey: string;
60842
60964
  };
60843
60965
  /** Viva settings object. */
60844
60966
  settings?: {
@@ -61138,7 +61260,7 @@ export interface storefrontComponents {
61138
61260
  * Do not localize this name.
61139
61261
  */
61140
61262
  displayName?: string | null;
61141
- country?: storefrontComponents["schemas"]["Country"];
61263
+ country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
61142
61264
  };
61143
61265
  /**
61144
61266
  * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -61154,9 +61276,40 @@ export interface storefrontComponents {
61154
61276
  * This uses the fully qualified domain name.
61155
61277
  */
61156
61278
  merchantOrigin?: string | null;
61157
- country?: storefrontComponents["schemas"]["Country"];
61279
+ country?: storefrontComponents["schemas"]["DigitalWalletCountry"];
61158
61280
  };
61159
61281
  };
61282
+ /**
61283
+ * Payout method limits for payout request auto-allocation.
61284
+ * Limits apply to auto-allocation only.
61285
+ * Manual allocations are uncapped.
61286
+ */
61287
+ GatewayAccountPayoutLimits: {
61288
+ /**
61289
+ * Maximum amount limit for single allocation.
61290
+ * At most one entry per each currency that this gateway account supports.
61291
+ */
61292
+ maxPerTransaction?:
61293
+ | {
61294
+ /** Limit amount. */
61295
+ amount: number;
61296
+ currency: storefrontComponents["schemas"]["CurrencyCode"];
61297
+ }[]
61298
+ | null;
61299
+ /**
61300
+ * Maximum amount limit for a rolling period.
61301
+ * At most one entry per each currency that this gateway account supports.
61302
+ */
61303
+ maxPerPeriod?:
61304
+ | {
61305
+ /** Limit amount. */
61306
+ amount: number;
61307
+ currency: storefrontComponents["schemas"]["CurrencyCode"];
61308
+ /** Rolling period for the amount limit. */
61309
+ period: "24-hours";
61310
+ }[]
61311
+ | null;
61312
+ };
61160
61313
  ValidationErrorExtensions: {
61161
61314
  /** Invalid field details. */
61162
61315
  invalidFields?: {
@@ -61541,6 +61694,21 @@ export interface storefrontComponents {
61541
61694
  /** List of email addresses to send notifications to. */
61542
61695
  notificationEmailAddresses?: string[];
61543
61696
  };
61697
+ /**
61698
+ * Settings for annual compliance screening of all active customers.
61699
+ * When enabled, a compliance screening report is generated for every active customer
61700
+ * on the configured month and day each year.
61701
+ */
61702
+ annualComplianceScreening?: {
61703
+ /** Specifies whether annual compliance screening is enabled for the organization. */
61704
+ enabled?: boolean;
61705
+ /**
61706
+ * Month and day when annual compliance screening runs, in `MM-DD` format.
61707
+ * Required when `enabled` is `true`.
61708
+ * Valid calendar date only. Leap day `02-29` is not allowed.
61709
+ */
61710
+ monthDay?: string | null;
61711
+ };
61544
61712
  /**
61545
61713
  * Default order for auto-allocation of payout requests.
61546
61714
  * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -64100,17 +64268,36 @@ export interface storefrontComponents {
64100
64268
  TimeSeriesTransaction: {
64101
64269
  /** Time series data. */
64102
64270
  data?: {
64103
- /** Date in `YYYY-MM-DD` format . */
64271
+ /** Date in `YYYY-MM-DD` format. */
64104
64272
  date?: string;
64105
- /** Total number of all transactions within the aggregation. */
64273
+ /**
64274
+ * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
64275
+ * - `count`: Total number of transactions.
64276
+ * - `amount`: Total amount of approved transactions in the merchant reporting currency.
64277
+ * - `approval-rate`: Ratio of approved transactions to all transactions.
64278
+ * - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
64279
+ *
64280
+ * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
64281
+ * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
64282
+ * Transactions with no value for the `subaggregate` field are also included.
64283
+ */
64106
64284
  total?: number;
64107
- /** Subaggregates that have transactions within the range. */
64285
+ /**
64286
+ * Breakdown by the `subaggregate` field for the day.
64287
+ * Each element contains one `subaggregate` value and its aggregated value.
64288
+ * Each `subaggregate` value found in the report has an element,
64289
+ * in the same order for each day.
64290
+ */
64108
64291
  subaggregates?: {
64109
- /** ID of the subaggregate. */
64292
+ /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
64110
64293
  subaggregate?: string;
64111
- /** Total number of all subaggregate transactions within the aggregation. */
64294
+ /**
64295
+ * Aggregated value for transactions that have this `subaggregate` value,
64296
+ * in the same unit as `total`.
64297
+ * This value is `0` if no transactions have this `subaggregate` value.
64298
+ */
64112
64299
  value?: number;
64113
- };
64300
+ }[];
64114
64301
  }[];
64115
64302
  };
64116
64303
  ReportDisputeDelays: {
@@ -69237,6 +69424,18 @@ export interface storefrontComponents {
69237
69424
  * This value is `null` if the export failed.
69238
69425
  */
69239
69426
  fileId?: string | null;
69427
+ /**
69428
+ * Total number of records in the export, excluding the header row.
69429
+ * This value is `0` if the export failed.
69430
+ */
69431
+ recordCount?: number;
69432
+ /**
69433
+ * Status of the data export.
69434
+ * This webhook is sent only when the data export reaches a terminal status.
69435
+ * This value is never `pending`, `queued`, or `processing`.
69436
+ */
69437
+ status?: "completed" | "failed";
69438
+ failureReason?: storefrontComponents["schemas"]["DataExportFailureReason"];
69240
69439
  /** Type of event that triggered the webhook. */
69241
69440
  eventType?: "data-export-completed" | "data-export-failed";
69242
69441
  /** Embedded objects related to the data export event. */
@@ -71297,7 +71496,12 @@ export interface reportsPaths {
71297
71496
  get: operations["GetTaxReport"];
71298
71497
  };
71299
71498
  "/reports/time-series-transaction": {
71300
- /** Retrieves a transactions report that is aggregated by time periods. */
71499
+ /**
71500
+ * Retrieves a report of sale and capture transactions, with one row for each day of the period.
71501
+ * Each row holds an aggregation of every transaction of the day,
71502
+ * and a breakdown of that day by the `subaggregate` field.
71503
+ * Transactions occur on the day of the `processedTime` value.
71504
+ */
71301
71505
  get: operations["GetTimeSeriesTransactionReport"];
71302
71506
  };
71303
71507
  "/reports/transactions-time-dispute": {
@@ -72824,6 +73028,7 @@ export interface reportsComponents {
72824
73028
  | "Perfect-money"
72825
73029
  | "Piastrix"
72826
73030
  | "PIX"
73031
+ | "PIX-Automatico"
72827
73032
  | "PinPay"
72828
73033
  | "phone"
72829
73034
  | "PhonePe"
@@ -77030,6 +77235,7 @@ export interface reportsComponents {
77030
77235
  | "Perfect-money"
77031
77236
  | "Piastrix"
77032
77237
  | "PIX"
77238
+ | "PIX-Automatico"
77033
77239
  | "plaid-account"
77034
77240
  | "PayTabs"
77035
77241
  | "Paysafecard"
@@ -78724,6 +78930,13 @@ export interface reportsComponents {
78724
78930
  * For examples, see [ISO.org](https://www.iso.org/obp/ui/#search/code/).
78725
78931
  */
78726
78932
  Country: string;
78933
+ /**
78934
+ * ISO 3166 alpha-2 country code where the payment is processed.
78935
+ * This is often the location for settling the payment.
78936
+ * Consult with your Payment Service Provider (PSP) to determine the
78937
+ * appropriate country code.
78938
+ */
78939
+ DigitalWalletCountry: reportsComponents["schemas"]["Country"];
78727
78940
  ApplePayFeature: {
78728
78941
  /** Name of the feature. */
78729
78942
  name?: "Apple Pay";
@@ -78733,7 +78946,7 @@ export interface reportsComponents {
78733
78946
  * Do not localize the name.
78734
78947
  */
78735
78948
  displayName?: string;
78736
- country?: reportsComponents["schemas"]["Country"];
78949
+ country?: reportsComponents["schemas"]["DigitalWalletCountry"];
78737
78950
  };
78738
78951
  GooglePayFeature: {
78739
78952
  /** Name of the feature. */
@@ -78745,7 +78958,7 @@ export interface reportsComponents {
78745
78958
  * The fully qualified domain name.
78746
78959
  */
78747
78960
  merchantOrigin?: string;
78748
- country?: reportsComponents["schemas"]["Country"];
78961
+ country?: reportsComponents["schemas"]["DigitalWalletCountry"];
78749
78962
  };
78750
78963
  SamsungPayFeature: {
78751
78964
  /** Name of the feature. */
@@ -83732,6 +83945,14 @@ export interface reportsComponents {
83732
83945
  | "covered-payout"
83733
83946
  | "approved-payment"
83734
83947
  | "none";
83948
+ /**
83949
+ * Payout limits for the gateway account applied during payout request auto-allocation.
83950
+ * These limits do not apply to manual allocations.
83951
+ *
83952
+ * This field is distinct from deposit and sale
83953
+ * [volume limits](https://www.rebilly.com/catalog/all/gateway-accounts/getgatewayaccountlimitcollection/).
83954
+ */
83955
+ payoutLimits?: reportsComponents["schemas"]["GatewayAccountPayoutLimits"] | null;
83735
83956
  /**
83736
83957
  * Email address template used in place of a customer's real email address when sending transaction data to a processor.
83737
83958
  * Use `{{customerId}}` as a placeholder for the customer's ID.
@@ -87129,6 +87350,8 @@ export interface reportsComponents {
87129
87350
  merchantId: string;
87130
87351
  /** API key for Viva basic authentication. */
87131
87352
  apiKey: string;
87353
+ /** Key of the Viva IPN validation. */
87354
+ ipnKey: string;
87132
87355
  };
87133
87356
  /** Viva settings object. */
87134
87357
  settings?: {
@@ -87428,7 +87651,7 @@ export interface reportsComponents {
87428
87651
  * Do not localize this name.
87429
87652
  */
87430
87653
  displayName?: string | null;
87431
- country?: reportsComponents["schemas"]["Country"];
87654
+ country?: reportsComponents["schemas"]["DigitalWalletCountry"];
87432
87655
  };
87433
87656
  /**
87434
87657
  * Google Pay™ digital wallet configuration. If not using Google Pay™,
@@ -87444,9 +87667,40 @@ export interface reportsComponents {
87444
87667
  * This uses the fully qualified domain name.
87445
87668
  */
87446
87669
  merchantOrigin?: string | null;
87447
- country?: reportsComponents["schemas"]["Country"];
87670
+ country?: reportsComponents["schemas"]["DigitalWalletCountry"];
87448
87671
  };
87449
87672
  };
87673
+ /**
87674
+ * Payout method limits for payout request auto-allocation.
87675
+ * Limits apply to auto-allocation only.
87676
+ * Manual allocations are uncapped.
87677
+ */
87678
+ GatewayAccountPayoutLimits: {
87679
+ /**
87680
+ * Maximum amount limit for single allocation.
87681
+ * At most one entry per each currency that this gateway account supports.
87682
+ */
87683
+ maxPerTransaction?:
87684
+ | {
87685
+ /** Limit amount. */
87686
+ amount: number;
87687
+ currency: reportsComponents["schemas"]["CurrencyCode"];
87688
+ }[]
87689
+ | null;
87690
+ /**
87691
+ * Maximum amount limit for a rolling period.
87692
+ * At most one entry per each currency that this gateway account supports.
87693
+ */
87694
+ maxPerPeriod?:
87695
+ | {
87696
+ /** Limit amount. */
87697
+ amount: number;
87698
+ currency: reportsComponents["schemas"]["CurrencyCode"];
87699
+ /** Rolling period for the amount limit. */
87700
+ period: "24-hours";
87701
+ }[]
87702
+ | null;
87703
+ };
87450
87704
  ValidationErrorExtensions: {
87451
87705
  /** Invalid field details. */
87452
87706
  invalidFields?: {
@@ -87831,6 +88085,21 @@ export interface reportsComponents {
87831
88085
  /** List of email addresses to send notifications to. */
87832
88086
  notificationEmailAddresses?: string[];
87833
88087
  };
88088
+ /**
88089
+ * Settings for annual compliance screening of all active customers.
88090
+ * When enabled, a compliance screening report is generated for every active customer
88091
+ * on the configured month and day each year.
88092
+ */
88093
+ annualComplianceScreening?: {
88094
+ /** Specifies whether annual compliance screening is enabled for the organization. */
88095
+ enabled?: boolean;
88096
+ /**
88097
+ * Month and day when annual compliance screening runs, in `MM-DD` format.
88098
+ * Required when `enabled` is `true`.
88099
+ * Valid calendar date only. Leap day `02-29` is not allowed.
88100
+ */
88101
+ monthDay?: string | null;
88102
+ };
87834
88103
  /**
87835
88104
  * Default order for auto-allocation of payout requests.
87836
88105
  * When set, this value is used when a payout request batch does not specify its own allocation order.
@@ -90390,17 +90659,36 @@ export interface reportsComponents {
90390
90659
  TimeSeriesTransaction: {
90391
90660
  /** Time series data. */
90392
90661
  data?: {
90393
- /** Date in `YYYY-MM-DD` format . */
90662
+ /** Date in `YYYY-MM-DD` format. */
90394
90663
  date?: string;
90395
- /** Total number of all transactions within the aggregation. */
90664
+ /**
90665
+ * Aggregated value for all transactions for the day, in the unit specified by the `type` parameter:
90666
+ * - `count`: Total number of transactions.
90667
+ * - `amount`: Total amount of approved transactions in the merchant reporting currency.
90668
+ * - `approval-rate`: Ratio of approved transactions to all transactions.
90669
+ * - `incomplete-rate`: Ratio of incomplete transactions to all transactions.
90670
+ *
90671
+ * This value does not depend on the `subaggregate` parameter and is not the sum of the values in `subaggregates`.
90672
+ * Each transaction is included once, even if the `subaggregate` field contains multiple values for the transaction.
90673
+ * Transactions with no value for the `subaggregate` field are also included.
90674
+ */
90396
90675
  total?: number;
90397
- /** Subaggregates that have transactions within the range. */
90676
+ /**
90677
+ * Breakdown by the `subaggregate` field for the day.
90678
+ * Each element contains one `subaggregate` value and its aggregated value.
90679
+ * Each `subaggregate` value found in the report has an element,
90680
+ * in the same order for each day.
90681
+ */
90398
90682
  subaggregates?: {
90399
- /** ID of the subaggregate. */
90683
+ /** One value of the `subaggregate` field, such as a website ID, a currency code, or a lead source. */
90400
90684
  subaggregate?: string;
90401
- /** Total number of all subaggregate transactions within the aggregation. */
90685
+ /**
90686
+ * Aggregated value for transactions that have this `subaggregate` value,
90687
+ * in the same unit as `total`.
90688
+ * This value is `0` if no transactions have this `subaggregate` value.
90689
+ */
90402
90690
  value?: number;
90403
- };
90691
+ }[];
90404
90692
  }[];
90405
90693
  };
90406
90694
  ReportDisputeDelays: {
@@ -95527,6 +95815,18 @@ export interface reportsComponents {
95527
95815
  * This value is `null` if the export failed.
95528
95816
  */
95529
95817
  fileId?: string | null;
95818
+ /**
95819
+ * Total number of records in the export, excluding the header row.
95820
+ * This value is `0` if the export failed.
95821
+ */
95822
+ recordCount?: number;
95823
+ /**
95824
+ * Status of the data export.
95825
+ * This webhook is sent only when the data export reaches a terminal status.
95826
+ * This value is never `pending`, `queued`, or `processing`.
95827
+ */
95828
+ status?: "completed" | "failed";
95829
+ failureReason?: reportsComponents["schemas"]["DataExportFailureReason"];
95530
95830
  /** Type of event that triggered the webhook. */
95531
95831
  eventType?: "data-export-completed" | "data-export-failed";
95532
95832
  /** Embedded objects related to the data export event. */
@@ -97098,13 +97398,18 @@ export interface operations {
97098
97398
  403: reportsComponents["responses"]["Forbidden"];
97099
97399
  };
97100
97400
  };
97101
- /** Retrieves a transactions report that is aggregated by time periods. */
97401
+ /**
97402
+ * Retrieves a report of sale and capture transactions, with one row for each day of the period.
97403
+ * Each row holds an aggregation of every transaction of the day,
97404
+ * and a breakdown of that day by the `subaggregate` field.
97405
+ * Transactions occur on the day of the `processedTime` value.
97406
+ */
97102
97407
  GetTimeSeriesTransactionReport: {
97103
97408
  parameters: {
97104
97409
  query: {
97105
- /** Type of report aggregation. */
97410
+ /** Aggregate the transactions of each day by count, sum of amounts, approval rate, or incomplete rate. */
97106
97411
  type?: "count" | "amount" | "approval-rate" | "incomplete-rate";
97107
- /** Report subaggregate. */
97412
+ /** Group the transactions of each day by this field, one subaggregate for each value. */
97108
97413
  subaggregate?:
97109
97414
  | "website"
97110
97415
  | "gateway-account"