rebilly-js-sdk 47.11.2 → 47.12.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.
@@ -1900,6 +1900,11 @@ declare module rebilly {
1900
1900
  type GetFutureRenewalReportResponse = operations['GetFutureRenewalReport']['responses']['200']['content']['application/json']
1901
1901
  type GetFutureRenewalReportResponsePromise = Promise<{fields: GetFutureRenewalReportResponse}>
1902
1902
 
1903
+ type GetJournalReportRequest = operations['GetJournalReport']['parameters']
1904
+
1905
+ type GetJournalReportResponse = operations['GetJournalReport']['responses']['200']['content']['application/json']
1906
+ type GetJournalReportResponsePromise = Promise<{fields: GetJournalReportResponse}>
1907
+
1903
1908
  type GetKycAcceptanceSummaryReportRequest = operations['GetKycAcceptanceSummaryReport']['parameters']
1904
1909
 
1905
1910
  type GetKycAcceptanceSummaryReportResponse = operations['GetKycAcceptanceSummaryReport']['responses']['200']['content']['application/json']
@@ -1991,7 +1996,7 @@ export interface corePaths {
1991
1996
  "/attachments": {
1992
1997
  /**
1993
1998
  * Retrieve a list of attachments.
1994
- * You may sort by the id, name, relatedId, relatedType, fileId, createdTime, and updatedTime.
1999
+ * You may sort by the `id`, `name`, `relatedId`, `relatedType`, `fileId`, `createdTime`, and `updatedTime`.
1995
2000
  */
1996
2001
  get: operations["GetAttachmentCollection"];
1997
2002
  /** Create an Attachment. */
@@ -3306,13 +3311,11 @@ export interface coreComponents {
3306
3311
  schemas: {
3307
3312
  /** The ISO 3166 alpha-2 country code. */
3308
3313
  Country: string;
3309
- Link: {
3310
- /** The link URL. */
3311
- href: string;
3312
- };
3313
- SelfLink: coreComponents["schemas"]["Link"] & {
3314
+ SelfLink: {
3314
3315
  /** The link type. */
3315
3316
  rel: "self";
3317
+ /** The link URL. */
3318
+ href: string;
3316
3319
  };
3317
3320
  AML: {
3318
3321
  /** First Name. */
@@ -3379,6 +3382,12 @@ export interface coreComponents {
3379
3382
  ResourceId: string;
3380
3383
  /** Read-only timestamp, automatically assigned on back-end. */
3381
3384
  ServerTimestamp: string;
3385
+ /** Read-only timestamp updates when the resource is updated. */
3386
+ UpdatedTime: string;
3387
+ Link: {
3388
+ /** The link URL. */
3389
+ href: string;
3390
+ };
3382
3391
  FileLink: coreComponents["schemas"]["Link"] & {
3383
3392
  /** The link type. */
3384
3393
  rel: "file";
@@ -3436,8 +3445,7 @@ export interface coreComponents {
3436
3445
  sha1?: string;
3437
3446
  /** The upload date/time. */
3438
3447
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
3439
- /** The latest update date/time. */
3440
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
3448
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
3441
3449
  /** Is the file available publicly (without authentication). If true, the permalink in the _links section contains the public URL. */
3442
3450
  isPublic?: boolean;
3443
3451
  /** The links related to resource. */
@@ -3479,8 +3487,7 @@ export interface coreComponents {
3479
3487
  description?: string;
3480
3488
  /** Creation date/time. */
3481
3489
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
3482
- /** Latest update date/time. */
3483
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
3490
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
3484
3491
  /** The links related to resource. */
3485
3492
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
3486
3493
  Partial<coreComponents["schemas"]["FileLink"]> &
@@ -3547,6 +3554,8 @@ export interface coreComponents {
3547
3554
  /** The credential's ID. */
3548
3555
  credentialId?: coreComponents["schemas"]["ResourceId"];
3549
3556
  };
3557
+ /** The customer resource ID. Defaults to UUID v4. */
3558
+ CustomerId: string;
3550
3559
  AuthenticationTokenMetadata: {
3551
3560
  /** Token's expired time. */
3552
3561
  expiredTime?: string;
@@ -3558,12 +3567,10 @@ export interface coreComponents {
3558
3567
  username?: string;
3559
3568
  /** The token's password. */
3560
3569
  password?: string;
3561
- /** The token's customer ID. */
3562
- customerId?: coreComponents["schemas"]["ResourceId"];
3570
+ customerId?: coreComponents["schemas"]["CustomerId"];
3563
3571
  } & coreComponents["schemas"]["AuthenticationTokenMetadata"];
3564
3572
  passwordless: coreComponents["schemas"]["AuthenticationToken"] & {
3565
- /** The token's customer ID. */
3566
- customerId?: coreComponents["schemas"]["ResourceId"];
3573
+ customerId?: coreComponents["schemas"]["CustomerId"];
3567
3574
  } & coreComponents["schemas"]["AuthenticationTokenMetadata"];
3568
3575
  ApiKeyScope: {
3569
3576
  /** The array of account identifier strings. */
@@ -3597,14 +3604,12 @@ export interface coreComponents {
3597
3604
  invalidate: boolean;
3598
3605
  /** The one time password sent via an email. Should contain digits only. */
3599
3606
  oneTimePassword?: string;
3600
- /** The customer's ID. */
3601
- customerId?: coreComponents["schemas"]["ResourceId"];
3607
+ customerId?: coreComponents["schemas"]["CustomerId"];
3602
3608
  acl?: coreComponents["schemas"]["Acl"];
3603
3609
  customClaims?: { [key: string]: any };
3604
3610
  /** Session created time. */
3605
3611
  createdTime?: string;
3606
- /** Session updated time. */
3607
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
3612
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
3608
3613
  /** Session expired time. Defaults to one hour. */
3609
3614
  expiredTime?: string;
3610
3615
  /** The links related to resource. */
@@ -3631,8 +3636,7 @@ export interface coreComponents {
3631
3636
  expirationTime?: string;
3632
3637
  /** The blocklist created time. */
3633
3638
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
3634
- /** The blocklist updated time. */
3635
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
3639
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
3636
3640
  /** The links related to resource. */
3637
3641
  _links?: coreComponents["schemas"]["SelfLink"][];
3638
3642
  };
@@ -3751,8 +3755,7 @@ export interface coreComponents {
3751
3755
  id?: coreComponents["schemas"]["ResourceId"];
3752
3756
  /** Coupon's ID. */
3753
3757
  couponId?: coreComponents["schemas"]["ResourceId"];
3754
- /** Customer's ID. */
3755
- customerId?: coreComponents["schemas"]["ResourceId"];
3758
+ customerId?: coreComponents["schemas"]["CustomerId"];
3756
3759
  /** Additional restrictions for coupon's redemptions. */
3757
3760
  additionalRestrictions?: coreComponents["schemas"]["RedemptionRestriction"][];
3758
3761
  /** Coupon redeem time. */
@@ -3799,8 +3802,7 @@ export interface coreComponents {
3799
3802
  expiredTime?: string;
3800
3803
  /** Coupon created time. */
3801
3804
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
3802
- /** Coupon updated time. */
3803
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
3805
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
3804
3806
  /** The links related to resource. */
3805
3807
  _links?: coreComponents["schemas"]["SelfLink"][];
3806
3808
  };
@@ -3835,8 +3837,7 @@ export interface coreComponents {
3835
3837
  username: string;
3836
3838
  /** The credential's password. */
3837
3839
  password: string;
3838
- /** The credential's customer ID. */
3839
- customerId: string;
3840
+ customerId: coreComponents["schemas"]["CustomerId"];
3840
3841
  /** The credential's expired time. */
3841
3842
  expiredTime?: string;
3842
3843
  /** The links related to resource. */
@@ -4066,7 +4067,7 @@ export interface coreComponents {
4066
4067
  };
4067
4068
  /** Check payment instrument object. */
4068
4069
  CheckInstrument: {
4069
- method: "cash";
4070
+ method: "check";
4070
4071
  /** Reference data. */
4071
4072
  reference?: string;
4072
4073
  };
@@ -4150,8 +4151,7 @@ export interface coreComponents {
4150
4151
  type: "customer" | "kyc-document";
4151
4152
  /** The tag's created time. */
4152
4153
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
4153
- /** The tag's updated time. */
4154
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
4154
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4155
4155
  /** The links related to resource. */
4156
4156
  _links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
4157
4157
  };
@@ -4225,8 +4225,7 @@ export interface coreComponents {
4225
4225
  defaultPaymentInstrument?: coreComponents["schemas"]["PaymentInstrumentValueObject"];
4226
4226
  /** The customer created time. */
4227
4227
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
4228
- /** The customer updated time. */
4229
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
4228
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4230
4229
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
4231
4230
  primaryAddress?: coreComponents["schemas"]["ContactObject"];
4232
4231
  averageValue?: coreComponents["schemas"]["CustomerAverageValue"];
@@ -4246,7 +4245,7 @@ export interface coreComponents {
4246
4245
  revision?: number;
4247
4246
  /** Indicates if EDD is enabled for this customer. */
4248
4247
  isEddRequired: boolean;
4249
- /** Whether the customer has fulfilled a KYC request by providing valid identity and address documents. */
4248
+ /** Specifies whether the customer has accepted and reviewed identity and address documents, or an accepted credit file document. */
4250
4249
  hasFulfilledKyc?: boolean;
4251
4250
  /** The links related to resource. */
4252
4251
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
@@ -4263,8 +4262,7 @@ export interface coreComponents {
4263
4262
  name: string;
4264
4263
  /** Customer Timeline Custom event created time. */
4265
4264
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
4266
- /** Customer Timeline Custom event updated time. */
4267
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
4265
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4268
4266
  /** The links related to resource. */
4269
4267
  _links?: coreComponents["schemas"]["SelfLink"][];
4270
4268
  };
@@ -4448,11 +4446,6 @@ export interface coreComponents {
4448
4446
  /** The link type. */
4449
4447
  rel: "transaction";
4450
4448
  };
4451
- InstrumentReference: {
4452
- method: coreComponents["schemas"]["PaymentMethod"];
4453
- /** The payment instrument ID. */
4454
- paymentInstrumentId?: coreComponents["schemas"]["ResourceId"];
4455
- };
4456
4449
  ThreeDSecureResult: {
4457
4450
  /** 3D Secure server name. */
4458
4451
  server?: string;
@@ -4651,8 +4644,7 @@ export interface coreComponents {
4651
4644
  id?: coreComponents["schemas"]["ResourceId"];
4652
4645
  /** The website ID. */
4653
4646
  websiteId?: coreComponents["schemas"]["ResourceId"];
4654
- /** The customer ID. */
4655
- customerId?: coreComponents["schemas"]["ResourceId"];
4647
+ customerId?: coreComponents["schemas"]["CustomerId"];
4656
4648
  /** Transaction type. */
4657
4649
  type?:
4658
4650
  | "3ds-authentication"
@@ -4705,7 +4697,6 @@ export interface coreComponents {
4705
4697
  isRebill?: boolean;
4706
4698
  /** The transaction's rebill number. */
4707
4699
  rebillNumber?: number;
4708
- paymentInstrument?: coreComponents["schemas"]["InstrumentReference"];
4709
4700
  /** Billing address. */
4710
4701
  billingAddress?: coreComponents["schemas"]["ContactObject"];
4711
4702
  has3ds?: boolean;
@@ -4734,8 +4725,7 @@ export interface coreComponents {
4734
4725
  processedTime?: coreComponents["schemas"]["ServerTimestamp"];
4735
4726
  /** Transaction created time. */
4736
4727
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
4737
- /** Transaction updated time. */
4738
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
4728
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
4739
4729
  };
4740
4730
  /** The acquirer name. */
4741
4731
  AcquirerName:
@@ -5309,8 +5299,7 @@ export interface coreComponents {
5309
5299
  | "do-nothing";
5310
5300
  /** Gateway Account created time. */
5311
5301
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
5312
- /** Gateway Account updated time. */
5313
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
5302
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
5314
5303
  /** Organization ID. */
5315
5304
  organizationId?: coreComponents["schemas"]["ResourceId"];
5316
5305
  /** The links related to resource. */
@@ -8130,9 +8119,55 @@ export interface coreComponents {
8130
8119
  CustomerEmbed: {
8131
8120
  customer?: coreComponents["schemas"]["Customer"];
8132
8121
  };
8122
+ /** Website settings. */
8123
+ WebsiteSettings: {
8124
+ /** Payment form settings. */
8125
+ paymentForm?: {
8126
+ /**
8127
+ * Hosted payment form
8128
+ * [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
8129
+ */
8130
+ css?: string;
8131
+ /**
8132
+ * Hosted payment form
8133
+ * [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
8134
+ */
8135
+ theme?: { [key: string]: string };
8136
+ /** Hosted payment form features. */
8137
+ features?: {
8138
+ showCoupons?: string[] | null;
8139
+ };
8140
+ };
8141
+ };
8142
+ OrganizationLink: coreComponents["schemas"]["Link"] & {
8143
+ /** The link type. */
8144
+ rel: "organization";
8145
+ };
8146
+ Website: {
8147
+ /** The website identifier string. */
8148
+ id?: coreComponents["schemas"]["ResourceId"];
8149
+ /** The website name. */
8150
+ name: string;
8151
+ /** The website domain address. */
8152
+ url: string;
8153
+ /** The website customer service phone number. */
8154
+ servicePhone: string;
8155
+ /** The website customer service email address. */
8156
+ serviceEmail: string;
8157
+ /** Website created time. */
8158
+ createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8159
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8160
+ customFields?: coreComponents["schemas"]["ResourceCustomFields"];
8161
+ settings?: coreComponents["schemas"]["WebsiteSettings"];
8162
+ /** Organization ID. */
8163
+ organizationId?: coreComponents["schemas"]["ResourceId"];
8164
+ /** The links related to resource. */
8165
+ _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
8166
+ Partial<coreComponents["schemas"]["OrganizationLink"]>)[];
8167
+ };
8133
8168
  /** Website object. */
8134
8169
  WebsiteEmbed: {
8135
- website?: { [key: string]: any };
8170
+ website?: coreComponents["schemas"]["Website"];
8136
8171
  };
8137
8172
  CommonPaymentCard: {
8138
8173
  /** The payment instrument ID. */
@@ -8176,8 +8211,7 @@ export interface coreComponents {
8176
8211
  billingPortalUrl?: string;
8177
8212
  /** Payment instrument created time. */
8178
8213
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8179
- /** Payment instrument updated time. */
8180
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8214
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8181
8215
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
8182
8216
  };
8183
8217
  AuthTransactionLink: coreComponents["schemas"]["Link"] & {
@@ -8189,8 +8223,7 @@ export interface coreComponents {
8189
8223
  authTransaction?: coreComponents["schemas"]["Transaction"];
8190
8224
  };
8191
8225
  PaymentCard: coreComponents["schemas"]["CommonPaymentCard"] & {
8192
- /** The customer ID. */
8193
- customerId?: coreComponents["schemas"]["ResourceId"];
8226
+ customerId?: coreComponents["schemas"]["CustomerId"];
8194
8227
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
8195
8228
  stickyGatewayAccountId?: string | null;
8196
8229
  /** Time expiration reminder event will be triggered. */
@@ -8242,13 +8275,11 @@ export interface coreComponents {
8242
8275
  useAsBackup: boolean;
8243
8276
  /** Bank account created time. */
8244
8277
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8245
- /** Bank account updated time. */
8246
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8278
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8247
8279
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
8248
8280
  };
8249
8281
  BankAccount: coreComponents["schemas"]["CommonBankAccount"] & {
8250
- /** The customer's ID. */
8251
- customerId?: coreComponents["schemas"]["ResourceId"];
8282
+ customerId?: coreComponents["schemas"]["CustomerId"];
8252
8283
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
8253
8284
  stickyGatewayAccountId?: string | null;
8254
8285
  riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
@@ -8353,8 +8384,7 @@ export interface coreComponents {
8353
8384
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
8354
8385
  /** The product created time. */
8355
8386
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8356
- /** The product updated time. */
8357
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8387
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8358
8388
  };
8359
8389
  Product: coreComponents["schemas"]["CommonProduct"] & {
8360
8390
  /** The product's tax category identifier string. */
@@ -8547,8 +8577,7 @@ export interface coreComponents {
8547
8577
  revision?: number;
8548
8578
  /** Plan created time. */
8549
8579
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8550
- /** Plan updated time. */
8551
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8580
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8552
8581
  };
8553
8582
  TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
8554
8583
  TimePluralUnit:
@@ -8632,8 +8661,7 @@ export interface coreComponents {
8632
8661
  periodNumber?: number;
8633
8662
  /** Invoice item created time. */
8634
8663
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8635
- /** Invoice item updated time. */
8636
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8664
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8637
8665
  /** Invoice item tax. */
8638
8666
  tax?: coreComponents["schemas"]["InvoiceTaxItem"];
8639
8667
  /** The links related to resource. */
@@ -8718,8 +8746,7 @@ export interface coreComponents {
8718
8746
  issuedTime?: coreComponents["schemas"]["ServerTimestamp"];
8719
8747
  /** Invoice created time. */
8720
8748
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8721
- /** Invoice updated time. */
8722
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8749
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8723
8750
  /**
8724
8751
  * URL where the customer can be redirected to pay for the invoice
8725
8752
  * with one of the methods which are available for this customer.
@@ -8731,6 +8758,7 @@ export interface coreComponents {
8731
8758
  CommonScheduleInstruction: {
8732
8759
  method:
8733
8760
  | "auto"
8761
+ | "intelligent"
8734
8762
  | "immediately"
8735
8763
  | "date-interval"
8736
8764
  | "day-of-month"
@@ -8779,7 +8807,12 @@ export interface coreComponents {
8779
8807
  };
8780
8808
  /** The calculation instruction of scheduled time. */
8781
8809
  InvoiceRetryScheduleInstruction: {
8782
- method: "immediately" | "date-interval" | "day-of-month" | "day-of-week";
8810
+ method:
8811
+ | "intelligent"
8812
+ | "immediately"
8813
+ | "date-interval"
8814
+ | "day-of-month"
8815
+ | "day-of-week";
8783
8816
  };
8784
8817
  immediately: coreComponents["schemas"]["CommonScheduleInstruction"] &
8785
8818
  coreComponents["schemas"]["ServicePeriodAnchorInstruction"] &
@@ -8794,6 +8827,15 @@ export interface coreComponents {
8794
8827
  | "Saturday";
8795
8828
  /** Extended ISO-8601 format of time. */
8796
8829
  TimeIso8601Extended: string;
8830
+ intelligent: coreComponents["schemas"]["CommonScheduleInstruction"] &
8831
+ coreComponents["schemas"]["CustomEventScheduleInstruction"] &
8832
+ coreComponents["schemas"]["InvoiceRetryScheduleInstruction"] & {
8833
+ /** The number of the units. */
8834
+ duration: number;
8835
+ unit:
8836
+ | coreComponents["schemas"]["TimeUnit"]
8837
+ | coreComponents["schemas"]["TimePluralUnit"];
8838
+ };
8797
8839
  AmountAdjustment: {
8798
8840
  method: "none" | "partial";
8799
8841
  };
@@ -8818,10 +8860,6 @@ export interface coreComponents {
8818
8860
  InvoiceRetryAmountAdjustmentInstruction: {
8819
8861
  method: "none" | "partial";
8820
8862
  };
8821
- OrganizationLink: coreComponents["schemas"]["Link"] & {
8822
- /** The link type. */
8823
- rel: "organization";
8824
- };
8825
8863
  TransactionAllocationsLink: coreComponents["schemas"]["Link"] & {
8826
8864
  /** The link type. */
8827
8865
  rel: "transactionAllocations";
@@ -8903,8 +8941,7 @@ export interface coreComponents {
8903
8941
  settings?: coreComponents["schemas"]["OrganizationSettings"];
8904
8942
  /** The organization created time. */
8905
8943
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8906
- /** The organization updated time. */
8907
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8944
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8908
8945
  /** The links related to resource. */
8909
8946
  _links?: coreComponents["schemas"]["SelfLink"][];
8910
8947
  };
@@ -8932,16 +8969,14 @@ export interface coreComponents {
8932
8969
  status: "active" | "inactive";
8933
8970
  /** The shipping rate created time. */
8934
8971
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
8935
- /** The shipping rate updated time. */
8936
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
8972
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
8937
8973
  };
8938
8974
  /** Shipping rate object. */
8939
8975
  ShippingRateEmbed: {
8940
8976
  shippingRate?: coreComponents["schemas"]["ShippingRate"];
8941
8977
  };
8942
8978
  Invoice: coreComponents["schemas"]["CommonInvoice"] & { [key: string]: any } & {
8943
- /** The customer ID. */
8944
- customerId?: coreComponents["schemas"]["ResourceId"];
8979
+ customerId?: coreComponents["schemas"]["CustomerId"];
8945
8980
  /** Invoice transactions array. */
8946
8981
  transactions?: coreComponents["schemas"]["Transaction"][];
8947
8982
  /** The invoice retry instruction. */
@@ -9223,8 +9258,7 @@ export interface coreComponents {
9223
9258
  resolvedTime?: coreComponents["schemas"]["ServerTimestamp"];
9224
9259
  /** Dispute created time. */
9225
9260
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9226
- /** Dispute updated time. */
9227
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9261
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9228
9262
  /** The links related to resource. */
9229
9263
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9230
9264
  Partial<coreComponents["schemas"]["TransactionLink"]>)[];
@@ -9339,8 +9373,7 @@ export interface coreComponents {
9339
9373
  id?: coreComponents["schemas"]["ResourceId"];
9340
9374
  /** ID of the invoice which the credit memo is issued upon. */
9341
9375
  invoiceId?: coreComponents["schemas"]["ResourceId"] | null;
9342
- /** Customer's ID. */
9343
- customerId: coreComponents["schemas"]["ResourceId"];
9376
+ customerId: coreComponents["schemas"]["CustomerId"];
9344
9377
  /** An auto-incrementing number based on the sequence of credit memos for any particular customer. */
9345
9378
  number?: number;
9346
9379
  items?: {
@@ -9389,8 +9422,7 @@ export interface coreComponents {
9389
9422
  revision?: number;
9390
9423
  /** Credit memo created time. */
9391
9424
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9392
- /** Credit memo updated time. */
9393
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9425
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9394
9426
  /** The links related to resource. */
9395
9427
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
9396
9428
  Partial<coreComponents["schemas"]["CustomerLink"]> &
@@ -9429,8 +9461,7 @@ export interface coreComponents {
9429
9461
  currency?: coreComponents["schemas"]["CurrencyCode"];
9430
9462
  /** Credit memo allocation time. */
9431
9463
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9432
- /** Credit memo allocation update time. */
9433
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9464
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9434
9465
  /** The links related to the resource. */
9435
9466
  _links?: (Partial<coreComponents["schemas"]["InvoiceLink"]> &
9436
9467
  Partial<coreComponents["schemas"]["CreditMemoLink"]>)[];
@@ -9502,8 +9533,7 @@ export interface coreComponents {
9502
9533
  expirationTime?: string;
9503
9534
  /** Creation date-time. */
9504
9535
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9505
- /** Latest update date-time. */
9506
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9536
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9507
9537
  };
9508
9538
  KycDocumentsLink: coreComponents["schemas"]["Link"] & {
9509
9539
  /** The link type. */
@@ -9557,16 +9587,14 @@ export interface coreComponents {
9557
9587
  requestId?: coreComponents["schemas"]["ResourceId"] | null;
9558
9588
  /** Creation date/time. */
9559
9589
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9560
- /** Latest update date/time. */
9561
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9590
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9562
9591
  /** Processing date/time. */
9563
9592
  processedTime?: coreComponents["schemas"]["ServerTimestamp"];
9564
9593
  /** The links related to resource. */
9565
9594
  _links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
9566
9595
  };
9567
9596
  BaseKycDocument: coreComponents["schemas"]["CommonKycDocument"] & {
9568
- /** The customer ID. */
9569
- customerId?: coreComponents["schemas"]["ResourceId"];
9597
+ customerId?: coreComponents["schemas"]["CustomerId"];
9570
9598
  /** Reviewer's user ID. */
9571
9599
  reviewerId?: string | null;
9572
9600
  /** Reviewer's first and last name. */
@@ -9822,8 +9850,7 @@ export interface coreComponents {
9822
9850
  | coreComponents["schemas"]["ProofOfPurchaseKycDocument"]
9823
9851
  | coreComponents["schemas"]["ProofOfCreditFileKycDocument"];
9824
9852
  KycRequest: coreComponents["schemas"]["CommonKycRequest"] & {
9825
- /** The customer ID. */
9826
- customerId: coreComponents["schemas"]["ResourceId"];
9853
+ customerId: coreComponents["schemas"]["CustomerId"];
9827
9854
  /** Reason for uploading. */
9828
9855
  reason?: string;
9829
9856
  /**
@@ -9874,13 +9901,11 @@ export interface coreComponents {
9874
9901
  useAsBackup: boolean;
9875
9902
  /** PayPal account created time. */
9876
9903
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9877
- /** PayPal account updated time. */
9878
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9904
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9879
9905
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
9880
9906
  };
9881
9907
  PayPalAccount: coreComponents["schemas"]["CommonPayPalAccount"] & {
9882
- /** The customer's ID. */
9883
- customerId?: coreComponents["schemas"]["ResourceId"];
9908
+ customerId?: coreComponents["schemas"]["CustomerId"];
9884
9909
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
9885
9910
  stickyGatewayAccountId?: string | null;
9886
9911
  riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
@@ -9916,13 +9941,11 @@ export interface coreComponents {
9916
9941
  useAsBackup: boolean;
9917
9942
  /** The payment instrument created time. */
9918
9943
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
9919
- /** The payment instrument updated time. */
9920
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
9944
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
9921
9945
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
9922
9946
  };
9923
9947
  KhelocardCard: coreComponents["schemas"]["CommonKhelocardCard"] & {
9924
- /** Customer's ID. */
9925
- customerId?: coreComponents["schemas"]["ResourceId"];
9948
+ customerId?: coreComponents["schemas"]["CustomerId"];
9926
9949
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
9927
9950
  stickyGatewayAccountId?: string | null;
9928
9951
  riskMetadata?: coreComponents["schemas"]["RiskMetadata"];
@@ -10086,13 +10109,11 @@ export interface coreComponents {
10086
10109
  useAsBackup: boolean;
10087
10110
  /** The payment instrument created time. */
10088
10111
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
10089
- /** The payment instrument updated time. */
10090
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
10112
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10091
10113
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
10092
10114
  };
10093
10115
  AlternativeInstrument: coreComponents["schemas"]["CommonAlternativeInstrument"] & {
10094
- /** Customer's ID. */
10095
- customerId?: coreComponents["schemas"]["ResourceId"];
10116
+ customerId?: coreComponents["schemas"]["CustomerId"];
10096
10117
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
10097
10118
  stickyGatewayAccountId?: string | null;
10098
10119
  /** Payment instrument reference data. */
@@ -10111,8 +10132,7 @@ export interface coreComponents {
10111
10132
  | coreComponents["schemas"]["KhelocardCard"]
10112
10133
  | coreComponents["schemas"]["AlternativeInstrument"];
10113
10134
  PaymentInstrumentCreateToken: {
10114
- /** The customer's ID. */
10115
- customerId: coreComponents["schemas"]["ResourceId"];
10135
+ customerId: coreComponents["schemas"]["CustomerId"];
10116
10136
  /** Payment token ID. */
10117
10137
  token: string;
10118
10138
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
@@ -10122,8 +10142,7 @@ export interface coreComponents {
10122
10142
  PaymentCardCreatePlain: {
10123
10143
  /** The method of payment instrument. */
10124
10144
  method: "payment-card";
10125
- /** The Customer's ID. */
10126
- customerId: coreComponents["schemas"]["ResourceId"];
10145
+ customerId: coreComponents["schemas"]["CustomerId"];
10127
10146
  /** The card PAN (Primary Account Number). */
10128
10147
  pan: string;
10129
10148
  /** Card's expiration year. */
@@ -10146,8 +10165,7 @@ export interface coreComponents {
10146
10165
  BBANType: coreComponents["schemas"]["BankAccountCreatePlain"] & {
10147
10166
  /** Payment method of the payment instrument. */
10148
10167
  method?: "ach";
10149
- /** ID of the customer who is initiating the payment. */
10150
- customerId?: coreComponents["schemas"]["ResourceId"];
10168
+ customerId?: coreComponents["schemas"]["CustomerId"];
10151
10169
  /**
10152
10170
  * Bank account number type. A valid value is Basic Bank Account Number (BBAN) or International Bank Account Number (IBAN).
10153
10171
  * BBAN object.
@@ -10172,8 +10190,7 @@ export interface coreComponents {
10172
10190
  IBANType: coreComponents["schemas"]["BankAccountCreatePlain"] & {
10173
10191
  /** Payment method of the payment instrument. */
10174
10192
  method?: "ach";
10175
- /** ID of the customer who is initiating a payment. */
10176
- customerId?: coreComponents["schemas"]["ResourceId"];
10193
+ customerId?: coreComponents["schemas"]["CustomerId"];
10177
10194
  /**
10178
10195
  * Customer's bank account number type. A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
10179
10196
  * IBAN object.
@@ -10253,8 +10270,7 @@ export interface coreComponents {
10253
10270
  riskMetadata: coreComponents["schemas"]["RiskMetadata"];
10254
10271
  };
10255
10272
  CoreReadyToPay: {
10256
- /** The customer identifier string. */
10257
- customerId?: coreComponents["schemas"]["ResourceId"];
10273
+ customerId?: coreComponents["schemas"]["CustomerId"];
10258
10274
  } & coreComponents["schemas"]["ReadyToPay"];
10259
10275
  /** The feature name. */
10260
10276
  ApplePayFeatureName: "Apple Pay";
@@ -10582,8 +10598,7 @@ export interface coreComponents {
10582
10598
  customFields?: coreComponents["schemas"]["ResourceCustomFields"];
10583
10599
  /** Order created time. */
10584
10600
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
10585
- /** Order updated time. */
10586
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
10601
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10587
10602
  /** The links related to resource. */
10588
10603
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
10589
10604
  Partial<coreComponents["schemas"]["CustomerLink"]> &
@@ -10603,8 +10618,7 @@ export interface coreComponents {
10603
10618
  };
10604
10619
  SubscriptionOrder: coreComponents["schemas"]["Subscription"] &
10605
10620
  coreComponents["schemas"]["CommonSubscriptionOrder"] & {
10606
- /** The customer identifier string. */
10607
- customerId?: coreComponents["schemas"]["ResourceId"];
10621
+ customerId?: coreComponents["schemas"]["CustomerId"];
10608
10622
  /** Time renewal reminder event will be triggered. */
10609
10623
  renewalReminderTime?: coreComponents["schemas"]["ServerTimestamp"] | null;
10610
10624
  /** Number of renewal reminder events triggered. */
@@ -10623,8 +10637,7 @@ export interface coreComponents {
10623
10637
  };
10624
10638
  OneTimeOrder: coreComponents["schemas"]["Subscription"] &
10625
10639
  coreComponents["schemas"]["CommonOneTimeOrder"] & {
10626
- /** The customer identifier string. */
10627
- customerId?: coreComponents["schemas"]["ResourceId"];
10640
+ customerId?: coreComponents["schemas"]["CustomerId"];
10628
10641
  /** Organization ID. */
10629
10642
  organizationId?: coreComponents["schemas"]["ResourceId"];
10630
10643
  } & coreComponents["schemas"]["SubscriptionMetadata"];
@@ -10696,8 +10709,7 @@ export interface coreComponents {
10696
10709
  timeRemaining?: string;
10697
10710
  /** The time of resource creation (when it is posted). */
10698
10711
  createdTime?: string;
10699
- /** The time of resource update. */
10700
- updatedTime?: string;
10712
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10701
10713
  /** The links related to resource. */
10702
10714
  _links?: coreComponents["schemas"]["SelfLink"][];
10703
10715
  };
@@ -10842,8 +10854,7 @@ export interface coreComponents {
10842
10854
  leadSource?: coreComponents["schemas"]["LeadSource"];
10843
10855
  /** Token created time. */
10844
10856
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
10845
- /** Token updated time. */
10846
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
10857
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
10847
10858
  /** Token usage time. */
10848
10859
  usageTime?: coreComponents["schemas"]["ServerTimestamp"];
10849
10860
  /** Token expiration time. */
@@ -11086,8 +11097,7 @@ export interface coreComponents {
11086
11097
  CommonTransactionRequest: {
11087
11098
  /** The website identifier string. */
11088
11099
  websiteId: coreComponents["schemas"]["ResourceId"];
11089
- /** The customer identifier string. */
11090
- customerId: coreComponents["schemas"]["ResourceId"];
11100
+ customerId: coreComponents["schemas"]["CustomerId"];
11091
11101
  currency: coreComponents["schemas"]["CurrencyCode"];
11092
11102
  /** The transaction amount. */
11093
11103
  amount: number;
@@ -11129,6 +11139,9 @@ export interface coreComponents {
11129
11139
  type?: "sale" | "authorize" | "setup";
11130
11140
  limits?: coreComponents["schemas"]["TransactionLimitAmount"];
11131
11141
  } & coreComponents["schemas"]["CommonTransactionRequest"];
11142
+ PatchTransactionRequest: {
11143
+ customFields?: coreComponents["schemas"]["ResourceCustomFields"];
11144
+ };
11132
11145
  PayoutRequest: coreComponents["schemas"]["CommonTransactionRequest"];
11133
11146
  TransactionQuery: {
11134
11147
  /** Transaction result. */
@@ -11273,8 +11286,7 @@ export interface coreComponents {
11273
11286
  formula?: coreComponents["schemas"]["FeeFormula"];
11274
11287
  /** Fee created time. */
11275
11288
  createdTime?: coreComponents["schemas"]["ServerTimestamp"];
11276
- /** Fee updated time. */
11277
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
11289
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
11278
11290
  /** The links related to resource. */
11279
11291
  _links?: Partial<coreComponents["schemas"]["SelfLink"]>[];
11280
11292
  };
@@ -11472,8 +11484,7 @@ export interface coreComponents {
11472
11484
  score?: coreComponents["schemas"]["EddData"];
11473
11485
  /** The EDD score next update time. */
11474
11486
  nextUpdateTime?: string | null;
11475
- /** The EDD score updated time. */
11476
- updatedTime?: coreComponents["schemas"]["ServerTimestamp"];
11487
+ updatedTime?: coreComponents["schemas"]["UpdatedTime"];
11477
11488
  /** The links related to resource. */
11478
11489
  _links?: (Partial<coreComponents["schemas"]["SelfLink"]> &
11479
11490
  Partial<coreComponents["schemas"]["EddOccupationSearchResultLink"]> &
@@ -11733,9 +11744,7 @@ export interface coreComponents {
11733
11744
  /** Use the patch transaction request to modify custom fields. */
11734
11745
  PatchTransactionRequest: {
11735
11746
  content: {
11736
- "application/json": {
11737
- customFields?: coreComponents["schemas"]["ResourceCustomFields"];
11738
- };
11747
+ "application/json": coreComponents["schemas"]["PatchTransactionRequest"];
11739
11748
  };
11740
11749
  };
11741
11750
  /** Transaction resource. */
@@ -11748,8 +11757,7 @@ export interface coreComponents {
11748
11757
  CustomerWebhook: {
11749
11758
  content: {
11750
11759
  "application/json": {
11751
- /** The customer ID. */
11752
- customerId?: string;
11760
+ customerId?: coreComponents["schemas"]["CustomerId"];
11753
11761
  eventType?: coreComponents["schemas"]["GlobalWebhookEventType"];
11754
11762
  _embedded?: {
11755
11763
  customer?: coreComponents["schemas"]["Customer"];
@@ -11839,7 +11847,7 @@ export interface coreComponents {
11839
11847
  content: {
11840
11848
  "application/json": {
11841
11849
  /** The ID of the checked customer. */
11842
- customerId?: string;
11850
+ customerId?: coreComponents["schemas"]["CustomerId"];
11843
11851
  /** The check decision where `1` - record matches, `0` - no matches found, `-1` - record mismatches. */
11844
11852
  outcome?: -1 | 0 | 1;
11845
11853
  /** The text representation of the outcome. */
@@ -11910,8 +11918,7 @@ export interface coreComponents {
11910
11918
  KycDocumentWebhook: {
11911
11919
  content: {
11912
11920
  "application/json": {
11913
- /** The customer ID. */
11914
- customerId?: string;
11921
+ customerId?: coreComponents["schemas"]["CustomerId"];
11915
11922
  /** The KYC document ID. */
11916
11923
  kycDocumentId?: string;
11917
11924
  /** The file ID. */
@@ -11932,8 +11939,7 @@ export interface coreComponents {
11932
11939
  KycRequestWebhook: {
11933
11940
  content: {
11934
11941
  "application/json": {
11935
- /** The customer ID. */
11936
- customerId?: string;
11942
+ customerId?: coreComponents["schemas"]["CustomerId"];
11937
11943
  /** The KYC request ID. */
11938
11944
  kycRequestId?: string;
11939
11945
  /** Rebilly webhooks event type. */
@@ -12088,7 +12094,7 @@ export interface operations {
12088
12094
  };
12089
12095
  /**
12090
12096
  * Retrieve a list of attachments.
12091
- * You may sort by the id, name, relatedId, relatedType, fileId, createdTime, and updatedTime.
12097
+ * You may sort by the `id`, `name`, `relatedId`, `relatedType`, `fileId`, `createdTime`, and `updatedTime`.
12092
12098
  */
12093
12099
  GetAttachmentCollection: {
12094
12100
  parameters: {
@@ -12134,6 +12140,7 @@ export interface operations {
12134
12140
  responses: {
12135
12141
  /** Attachment was created. */
12136
12142
  201: {
12143
+ headers: {};
12137
12144
  content: {
12138
12145
  "application/json": coreComponents["schemas"]["Attachment"];
12139
12146
  };
@@ -12182,6 +12189,7 @@ export interface operations {
12182
12189
  };
12183
12190
  /** Attachment was created. */
12184
12191
  201: {
12192
+ headers: {};
12185
12193
  content: {
12186
12194
  "application/json": coreComponents["schemas"]["Attachment"];
12187
12195
  };
@@ -12269,6 +12277,7 @@ export interface operations {
12269
12277
  responses: {
12270
12278
  /** Login successful. */
12271
12279
  201: {
12280
+ headers: {};
12272
12281
  content: {
12273
12282
  "application/json": coreComponents["schemas"]["AuthenticationToken"];
12274
12283
  };
@@ -12334,6 +12343,7 @@ export interface operations {
12334
12343
  responses: {
12335
12344
  /** Authentication Token exchanged for JWT. */
12336
12345
  201: {
12346
+ headers: {};
12337
12347
  content: {
12338
12348
  "application/json": coreComponents["schemas"]["CustomerJWT"];
12339
12349
  };
@@ -12385,6 +12395,7 @@ export interface operations {
12385
12395
  responses: {
12386
12396
  /** Blocklist was created. */
12387
12397
  201: {
12398
+ headers: {};
12388
12399
  content: {
12389
12400
  "application/json": coreComponents["schemas"]["Blocklist"];
12390
12401
  };
@@ -12426,6 +12437,7 @@ export interface operations {
12426
12437
  responses: {
12427
12438
  /** Blocklist was created. */
12428
12439
  201: {
12440
+ headers: {};
12429
12441
  content: {
12430
12442
  "application/json": coreComponents["schemas"]["Blocklist"];
12431
12443
  };
@@ -12489,6 +12501,7 @@ export interface operations {
12489
12501
  responses: {
12490
12502
  /** Coupon was redeemed. */
12491
12503
  201: {
12504
+ headers: {};
12492
12505
  content: {
12493
12506
  "application/json": coreComponents["schemas"]["CouponRedemption"];
12494
12507
  };
@@ -12575,6 +12588,7 @@ export interface operations {
12575
12588
  responses: {
12576
12589
  /** Coupon was created. */
12577
12590
  201: {
12591
+ headers: {};
12578
12592
  content: {
12579
12593
  "application/json": coreComponents["schemas"]["Coupon"];
12580
12594
  };
@@ -12622,6 +12636,7 @@ export interface operations {
12622
12636
  };
12623
12637
  /** Coupon was created. */
12624
12638
  201: {
12639
+ headers: {};
12625
12640
  content: {
12626
12641
  "application/json": coreComponents["schemas"]["Coupon"];
12627
12642
  };
@@ -12648,6 +12663,7 @@ export interface operations {
12648
12663
  responses: {
12649
12664
  /** Coupon expiration was successfully set. */
12650
12665
  201: {
12666
+ headers: {};
12651
12667
  content: {
12652
12668
  "application/json": coreComponents["schemas"]["Coupon"];
12653
12669
  };
@@ -12697,6 +12713,7 @@ export interface operations {
12697
12713
  responses: {
12698
12714
  /** Credential was created. */
12699
12715
  201: {
12716
+ headers: {};
12700
12717
  content: {
12701
12718
  "application/json": coreComponents["schemas"]["CustomerCredential"];
12702
12719
  };
@@ -12749,6 +12766,7 @@ export interface operations {
12749
12766
  };
12750
12767
  /** Credential was created. */
12751
12768
  201: {
12769
+ headers: {};
12752
12770
  content: {
12753
12771
  "application/json": coreComponents["schemas"]["CustomerCredential"];
12754
12772
  };
@@ -12846,6 +12864,7 @@ export interface operations {
12846
12864
  };
12847
12865
  /** The Custom Fields was created. */
12848
12866
  201: {
12867
+ headers: {};
12849
12868
  content: {
12850
12869
  "application/json": coreComponents["schemas"]["CustomField"];
12851
12870
  };
@@ -12921,7 +12940,13 @@ export interface operations {
12921
12940
  */
12922
12941
  PostCustomer: {
12923
12942
  responses: {
12924
- 201: coreComponents["responses"]["Customer"];
12943
+ /** A customer was created succesfully. */
12944
+ 201: {
12945
+ headers: {};
12946
+ content: {
12947
+ "application/json": coreComponents["schemas"]["Customer"];
12948
+ };
12949
+ };
12925
12950
  401: coreComponents["responses"]["Unauthorized"];
12926
12951
  403: coreComponents["responses"]["Forbidden"];
12927
12952
  409: coreComponents["responses"]["Conflict"];
@@ -12972,7 +12997,13 @@ export interface operations {
12972
12997
  };
12973
12998
  responses: {
12974
12999
  200: coreComponents["responses"]["Customer"];
12975
- 201: coreComponents["responses"]["Customer"];
13000
+ /** A customer with predefined ID was created succesfully. */
13001
+ 201: {
13002
+ headers: {};
13003
+ content: {
13004
+ "application/json": coreComponents["schemas"]["Customer"];
13005
+ };
13006
+ };
12976
13007
  401: coreComponents["responses"]["Unauthorized"];
12977
13008
  403: coreComponents["responses"]["Forbidden"];
12978
13009
  409: coreComponents["responses"]["Conflict"];
@@ -13033,6 +13064,7 @@ export interface operations {
13033
13064
  responses: {
13034
13065
  /** Customer Timeline Custom Event Type was created. */
13035
13066
  201: {
13067
+ headers: {};
13036
13068
  content: {
13037
13069
  "application/json": coreComponents["schemas"]["CustomerTimelineCustomEvent"];
13038
13070
  };
@@ -13120,6 +13152,7 @@ export interface operations {
13120
13152
  responses: {
13121
13153
  /** Lead Source was created. */
13122
13154
  201: {
13155
+ headers: {};
13123
13156
  content: {
13124
13157
  "application/json": coreComponents["schemas"]["LeadSource"];
13125
13158
  };
@@ -13199,6 +13232,7 @@ export interface operations {
13199
13232
  responses: {
13200
13233
  /** Customer Timeline comment or custom defined event was created. */
13201
13234
  201: {
13235
+ headers: {};
13202
13236
  content: {
13203
13237
  "application/json": coreComponents["schemas"]["CustomerTimeline"];
13204
13238
  };
@@ -13298,6 +13332,7 @@ export interface operations {
13298
13332
  responses: {
13299
13333
  /** Dispute was created. */
13300
13334
  201: {
13335
+ headers: {};
13301
13336
  content: {
13302
13337
  "application/json": coreComponents["schemas"]["Dispute"];
13303
13338
  };
@@ -13345,6 +13380,7 @@ export interface operations {
13345
13380
  };
13346
13381
  /** Dispute was created. */
13347
13382
  201: {
13383
+ headers: {};
13348
13384
  content: {
13349
13385
  "application/json": coreComponents["schemas"]["Dispute"];
13350
13386
  };
@@ -13416,6 +13452,7 @@ export interface operations {
13416
13452
  responses: {
13417
13453
  /** File was created. */
13418
13454
  201: {
13455
+ headers: {};
13419
13456
  content: {
13420
13457
  "application/json": coreComponents["schemas"]["File"];
13421
13458
  };
@@ -13569,6 +13606,7 @@ export interface operations {
13569
13606
  responses: {
13570
13607
  /** Invoice was created. */
13571
13608
  201: {
13609
+ headers: {};
13572
13610
  content: {
13573
13611
  "application/json": coreComponents["schemas"]["Invoice"];
13574
13612
  };
@@ -13629,6 +13667,7 @@ export interface operations {
13629
13667
  };
13630
13668
  /** Invoice was created. */
13631
13669
  201: {
13670
+ headers: {};
13632
13671
  content: {
13633
13672
  "application/json": coreComponents["schemas"]["Invoice"];
13634
13673
  };
@@ -13683,6 +13722,7 @@ export interface operations {
13683
13722
  responses: {
13684
13723
  /** InvoiceItem was created. */
13685
13724
  201: {
13725
+ headers: {};
13686
13726
  content: {
13687
13727
  "application/json": coreComponents["schemas"]["InvoiceItem"];
13688
13728
  };
@@ -13773,6 +13813,7 @@ export interface operations {
13773
13813
  responses: {
13774
13814
  /** Invoice was issued successfully. */
13775
13815
  201: {
13816
+ headers: {};
13776
13817
  content: {
13777
13818
  "application/json": coreComponents["schemas"]["Invoice"];
13778
13819
  };
@@ -13800,6 +13841,7 @@ export interface operations {
13800
13841
  responses: {
13801
13842
  /** Invoice was abandoned successfully. */
13802
13843
  201: {
13844
+ headers: {};
13803
13845
  content: {
13804
13846
  "application/json": coreComponents["schemas"]["Invoice"];
13805
13847
  };
@@ -13820,6 +13862,7 @@ export interface operations {
13820
13862
  responses: {
13821
13863
  /** Invoice was voided successfully. */
13822
13864
  201: {
13865
+ headers: {};
13823
13866
  content: {
13824
13867
  "application/json": coreComponents["schemas"]["Invoice"];
13825
13868
  };
@@ -13843,6 +13886,7 @@ export interface operations {
13843
13886
  responses: {
13844
13887
  /** Invoice was recalculated successfully. */
13845
13888
  201: {
13889
+ headers: {};
13846
13890
  content: {
13847
13891
  "application/json": coreComponents["schemas"]["Invoice"];
13848
13892
  };
@@ -13864,6 +13908,7 @@ export interface operations {
13864
13908
  responses: {
13865
13909
  /** Invoice was reissued successfully. */
13866
13910
  201: {
13911
+ headers: {};
13867
13912
  content: {
13868
13913
  "application/json": coreComponents["schemas"]["Invoice"];
13869
13914
  };
@@ -14012,6 +14057,7 @@ export interface operations {
14012
14057
  responses: {
14013
14058
  /** Invoice Timeline comment was created. */
14014
14059
  201: {
14060
+ headers: {};
14015
14061
  content: {
14016
14062
  "application/json": coreComponents["schemas"]["InvoiceTimeline"];
14017
14063
  };
@@ -14111,6 +14157,7 @@ export interface operations {
14111
14157
  responses: {
14112
14158
  /** CreditMemo was created. */
14113
14159
  201: {
14160
+ headers: {};
14114
14161
  content: {
14115
14162
  "application/json": coreComponents["schemas"]["CreditMemo"];
14116
14163
  };
@@ -14170,6 +14217,7 @@ export interface operations {
14170
14217
  };
14171
14218
  /** CreditMemo was created. */
14172
14219
  201: {
14220
+ headers: {};
14173
14221
  content: {
14174
14222
  "application/json": coreComponents["schemas"]["CreditMemo"];
14175
14223
  };
@@ -14196,6 +14244,7 @@ export interface operations {
14196
14244
  responses: {
14197
14245
  /** Credit memo successfully voided . */
14198
14246
  201: {
14247
+ headers: {};
14199
14248
  content: {
14200
14249
  "application/json": coreComponents["schemas"]["CreditMemo"];
14201
14250
  };
@@ -14252,6 +14301,7 @@ export interface operations {
14252
14301
  responses: {
14253
14302
  /** Credit memo timeline message was created. */
14254
14303
  201: {
14304
+ headers: {};
14255
14305
  content: {
14256
14306
  "application/json": coreComponents["schemas"]["CreditMemoTimeline"];
14257
14307
  };
@@ -14382,6 +14432,7 @@ export interface operations {
14382
14432
  };
14383
14433
  /** Credit memo allocation was created. */
14384
14434
  201: {
14435
+ headers: {};
14385
14436
  content: {
14386
14437
  "application/json": coreComponents["schemas"]["CreditMemoAllocation"];
14387
14438
  };
@@ -14462,6 +14513,7 @@ export interface operations {
14462
14513
  responses: {
14463
14514
  /** KYC request was created. */
14464
14515
  201: {
14516
+ headers: {};
14465
14517
  content: {
14466
14518
  "application/json": coreComponents["schemas"]["KycRequest"];
14467
14519
  };
@@ -14569,6 +14621,7 @@ export interface operations {
14569
14621
  responses: {
14570
14622
  /** Kyc document was created. */
14571
14623
  201: {
14624
+ headers: {};
14572
14625
  content: {
14573
14626
  "application/json": coreComponents["schemas"]["KycDocument"];
14574
14627
  };
@@ -14621,6 +14674,7 @@ export interface operations {
14621
14674
  };
14622
14675
  /** KYC document was created. */
14623
14676
  201: {
14677
+ headers: {};
14624
14678
  content: {
14625
14679
  "application/json": coreComponents["schemas"]["KycDocument"];
14626
14680
  };
@@ -14648,6 +14702,7 @@ export interface operations {
14648
14702
  responses: {
14649
14703
  /** KYC document acceptance was created. */
14650
14704
  201: {
14705
+ headers: {};
14651
14706
  content: {
14652
14707
  "application/json": coreComponents["schemas"]["KycDocument"];
14653
14708
  };
@@ -14691,6 +14746,7 @@ export interface operations {
14691
14746
  responses: {
14692
14747
  /** KYC document rejection was created. */
14693
14748
  201: {
14749
+ headers: {};
14694
14750
  content: {
14695
14751
  "application/json": coreComponents["schemas"]["KycDocument"];
14696
14752
  };
@@ -14718,6 +14774,7 @@ export interface operations {
14718
14774
  responses: {
14719
14775
  /** KYC document was reviewed. */
14720
14776
  201: {
14777
+ headers: {};
14721
14778
  content: {
14722
14779
  "application/json": coreComponents["schemas"]["KycDocument"];
14723
14780
  };
@@ -14739,6 +14796,7 @@ export interface operations {
14739
14796
  responses: {
14740
14797
  /** KYC document review started. */
14741
14798
  201: {
14799
+ headers: {};
14742
14800
  content: {
14743
14801
  "application/json": coreComponents["schemas"]["KycDocument"];
14744
14802
  };
@@ -14760,6 +14818,7 @@ export interface operations {
14760
14818
  responses: {
14761
14819
  /** KYC document review stopped. */
14762
14820
  201: {
14821
+ headers: {};
14763
14822
  content: {
14764
14823
  "application/json": coreComponents["schemas"]["KycDocument"];
14765
14824
  };
@@ -14831,6 +14890,7 @@ export interface operations {
14831
14890
  responses: {
14832
14891
  /** Reset Password Token was created. */
14833
14892
  201: {
14893
+ headers: {};
14834
14894
  content: {
14835
14895
  "application/json": coreComponents["schemas"]["ResetPasswordToken"];
14836
14896
  };
@@ -14930,6 +14990,7 @@ export interface operations {
14930
14990
  responses: {
14931
14991
  /** Payment instrument was created. */
14932
14992
  201: {
14993
+ headers: {};
14933
14994
  content: {
14934
14995
  "application/json": coreComponents["schemas"]["PaymentInstrument"];
14935
14996
  };
@@ -15000,6 +15061,7 @@ export interface operations {
15000
15061
  responses: {
15001
15062
  /** Payment instrument was deactivated. */
15002
15063
  201: {
15064
+ headers: {};
15003
15065
  content: {
15004
15066
  "application/json": coreComponents["schemas"]["PaymentInstrument"];
15005
15067
  };
@@ -15047,6 +15109,7 @@ export interface operations {
15047
15109
  responses: {
15048
15110
  /** Plan was created. */
15049
15111
  201: {
15112
+ headers: {};
15050
15113
  content: {
15051
15114
  "application/json": coreComponents["schemas"]["Plan"];
15052
15115
  };
@@ -15094,6 +15157,7 @@ export interface operations {
15094
15157
  };
15095
15158
  /** Plan was created. */
15096
15159
  201: {
15160
+ headers: {};
15097
15161
  content: {
15098
15162
  "application/json": coreComponents["schemas"]["Plan"];
15099
15163
  };
@@ -15158,6 +15222,7 @@ export interface operations {
15158
15222
  responses: {
15159
15223
  /** Product was created. */
15160
15224
  201: {
15225
+ headers: {};
15161
15226
  content: {
15162
15227
  "application/json": coreComponents["schemas"]["Product"];
15163
15228
  };
@@ -15205,6 +15270,7 @@ export interface operations {
15205
15270
  };
15206
15271
  /** Product was created. */
15207
15272
  201: {
15273
+ headers: {};
15208
15274
  content: {
15209
15275
  "application/json": coreComponents["schemas"]["Product"];
15210
15276
  };
@@ -15326,6 +15392,7 @@ export interface operations {
15326
15392
  responses: {
15327
15393
  /** Shipping rate was created. */
15328
15394
  201: {
15395
+ headers: {};
15329
15396
  content: {
15330
15397
  "application/json": coreComponents["schemas"]["ShippingRate"];
15331
15398
  };
@@ -15378,6 +15445,7 @@ export interface operations {
15378
15445
  };
15379
15446
  /** Shipping rate was created. */
15380
15447
  201: {
15448
+ headers: {};
15381
15449
  content: {
15382
15450
  "application/json": coreComponents["schemas"]["ShippingRate"];
15383
15451
  };
@@ -15485,6 +15553,7 @@ export interface operations {
15485
15553
  responses: {
15486
15554
  /** Order was created. */
15487
15555
  201: {
15556
+ headers: {};
15488
15557
  content: {
15489
15558
  "application/json": coreComponents["schemas"]["Subscription"];
15490
15559
  };
@@ -15568,6 +15637,7 @@ export interface operations {
15568
15637
  };
15569
15638
  /** Order was created. */
15570
15639
  201: {
15640
+ headers: {};
15571
15641
  content: {
15572
15642
  "application/json": coreComponents["schemas"]["Subscription"];
15573
15643
  };
@@ -15607,6 +15677,7 @@ export interface operations {
15607
15677
  responses: {
15608
15678
  /** Order was voided successfully. */
15609
15679
  201: {
15680
+ headers: {};
15610
15681
  content: {
15611
15682
  "application/json": coreComponents["schemas"]["Subscription"];
15612
15683
  };
@@ -15628,6 +15699,7 @@ export interface operations {
15628
15699
  responses: {
15629
15700
  /** Order was changed. */
15630
15701
  201: {
15702
+ headers: {};
15631
15703
  content: {
15632
15704
  "application/json": coreComponents["schemas"]["Subscription"];
15633
15705
  };
@@ -15658,6 +15730,7 @@ export interface operations {
15658
15730
  responses: {
15659
15731
  /** Invoice was created. */
15660
15732
  201: {
15733
+ headers: {};
15661
15734
  content: {
15662
15735
  "application/json": coreComponents["schemas"]["Invoice"];
15663
15736
  };
@@ -15708,6 +15781,7 @@ export interface operations {
15708
15781
  responses: {
15709
15782
  /** Pause was created, the subscription will be paused at the specified time. */
15710
15783
  201: {
15784
+ headers: {};
15711
15785
  content: {
15712
15786
  "application/json": coreComponents["schemas"]["SubscriptionPause"];
15713
15787
  };
@@ -15760,6 +15834,7 @@ export interface operations {
15760
15834
  };
15761
15835
  /** Pause was created, the subscription is or will be paused. */
15762
15836
  201: {
15837
+ headers: {};
15763
15838
  content: {
15764
15839
  "application/json": coreComponents["schemas"]["SubscriptionPause"];
15765
15840
  };
@@ -15826,6 +15901,7 @@ export interface operations {
15826
15901
  responses: {
15827
15902
  /** Cancellation was created, the order is or will be deactivated. */
15828
15903
  201: {
15904
+ headers: {};
15829
15905
  content: {
15830
15906
  "application/json": coreComponents["schemas"]["SubscriptionCancellation"];
15831
15907
  };
@@ -15873,6 +15949,7 @@ export interface operations {
15873
15949
  };
15874
15950
  /** Cancellation was created, the order is or will be deactivated. */
15875
15951
  201: {
15952
+ headers: {};
15876
15953
  content: {
15877
15954
  "application/json": coreComponents["schemas"]["SubscriptionCancellation"];
15878
15955
  };
@@ -15968,6 +16045,7 @@ export interface operations {
15968
16045
  * If there was a cancellation with status "confirmed", it is revoked.
15969
16046
  */
15970
16047
  201: {
16048
+ headers: {};
15971
16049
  content: {
15972
16050
  "application/json": coreComponents["schemas"]["SubscriptionReactivation"];
15973
16051
  };
@@ -16047,6 +16125,7 @@ export interface operations {
16047
16125
  responses: {
16048
16126
  /** Upcoming Invoice was issued successfully. */
16049
16127
  201: {
16128
+ headers: {};
16050
16129
  content: {
16051
16130
  "application/json": coreComponents["schemas"]["Invoice"];
16052
16131
  };
@@ -16109,6 +16188,7 @@ export interface operations {
16109
16188
  responses: {
16110
16189
  /** Order Timeline comment was created. */
16111
16190
  201: {
16191
+ headers: {};
16112
16192
  content: {
16113
16193
  "application/json": coreComponents["schemas"]["OrderTimeline"];
16114
16194
  };
@@ -16202,6 +16282,7 @@ export interface operations {
16202
16282
  responses: {
16203
16283
  /** Tag was created. */
16204
16284
  201: {
16285
+ headers: {};
16205
16286
  content: {
16206
16287
  "application/json": coreComponents["schemas"]["Tag"];
16207
16288
  };
@@ -16496,6 +16577,7 @@ export interface operations {
16496
16577
  responses: {
16497
16578
  /** Token was created. */
16498
16579
  201: {
16580
+ headers: {};
16499
16581
  content: {
16500
16582
  "application/json": coreComponents["schemas"]["CompositeToken"];
16501
16583
  };
@@ -16539,6 +16621,7 @@ export interface operations {
16539
16621
  responses: {
16540
16622
  /** Digital wallet validation was made. */
16541
16623
  201: {
16624
+ headers: {};
16542
16625
  content: {
16543
16626
  "application/json": coreComponents["schemas"]["DigitalWalletValidation"];
16544
16627
  };
@@ -16632,6 +16715,7 @@ export interface operations {
16632
16715
  responses: {
16633
16716
  /** Transaction was created. */
16634
16717
  201: {
16718
+ headers: {};
16635
16719
  content: {
16636
16720
  "application/json": coreComponents["schemas"]["Transaction"];
16637
16721
  };
@@ -16697,6 +16781,7 @@ export interface operations {
16697
16781
  responses: {
16698
16782
  /** Transaction was created. */
16699
16783
  201: {
16784
+ headers: {};
16700
16785
  content: {
16701
16786
  "application/json": coreComponents["schemas"]["Transaction"];
16702
16787
  };
@@ -16723,6 +16808,7 @@ export interface operations {
16723
16808
  responses: {
16724
16809
  /** Transaction was queried successfully. */
16725
16810
  201: {
16811
+ headers: {};
16726
16812
  content: {
16727
16813
  "application/json": coreComponents["schemas"]["TransactionQuery"];
16728
16814
  };
@@ -16771,6 +16857,7 @@ export interface operations {
16771
16857
  responses: {
16772
16858
  /** Transaction was refunded successfully. */
16773
16859
  201: {
16860
+ headers: {};
16774
16861
  content: {
16775
16862
  "application/json": coreComponents["schemas"]["Transaction"];
16776
16863
  };
@@ -16829,6 +16916,7 @@ export interface operations {
16829
16916
  responses: {
16830
16917
  /** Transaction Timeline comment was created. */
16831
16918
  201: {
16919
+ headers: {};
16832
16920
  content: {
16833
16921
  "application/json": coreComponents["schemas"]["TransactionTimeline"];
16834
16922
  };
@@ -16920,6 +17008,7 @@ export interface operations {
16920
17008
  responses: {
16921
17009
  /** Fee entry was created successfully. */
16922
17010
  201: {
17011
+ headers: {};
16923
17012
  content: {
16924
17013
  "application/json": coreComponents["schemas"]["Fee"];
16925
17014
  };
@@ -16979,6 +17068,7 @@ export interface operations {
16979
17068
  };
16980
17069
  /** Fee entry was created successfully. */
16981
17070
  201: {
17071
+ headers: {};
16982
17072
  content: {
16983
17073
  "application/json": coreComponents["schemas"]["Fee"];
16984
17074
  };
@@ -17136,6 +17226,7 @@ export interface operations {
17136
17226
  responses: {
17137
17227
  /** EDD Timeline comment was created. */
17138
17228
  201: {
17229
+ headers: {};
17139
17230
  content: {
17140
17231
  "application/json": coreComponents["schemas"]["EddTimeline"];
17141
17232
  };
@@ -17181,7 +17272,7 @@ export interface usersPaths {
17181
17272
  "/application-instances/{applicationId}": {
17182
17273
  /**
17183
17274
  * Retrieve a list of application instances.
17184
- * You may sort by the id, name, status, createdTime, and updatedTime.
17275
+ * You may sort by the `id`, `name`, `status`, `createdTime`, and `updatedTime`.
17185
17276
  */
17186
17277
  get: operations["GetApplicationInstance"];
17187
17278
  /** Create or update an application instance. */
@@ -17198,7 +17289,7 @@ export interface usersPaths {
17198
17289
  "/applications": {
17199
17290
  /**
17200
17291
  * Retrieve a list of applications.
17201
- * You may sort by the id, name, status, createdTime, and updatedTime.
17292
+ * You may sort by the `id`, `name`, `status`, `createdTime`, and `updatedTime`.
17202
17293
  */
17203
17294
  get: operations["GetApplicationCollection"];
17204
17295
  /** Register an application. It will appear publicly in the [App Store](https://app.rebilly.com/app-store). Before you submit an app, read the [App Store documentation](https://www.rebilly.com/docs/content/concepts-and-features/app-store/). */
@@ -18314,18 +18405,22 @@ export interface usersComponents {
18314
18405
  schemas: {
18315
18406
  /** The ISO 3166 alpha-2 country code. */
18316
18407
  Country: string;
18317
- Link: {
18318
- /** The link URL. */
18319
- href: string;
18320
- };
18321
- SelfLink: usersComponents["schemas"]["Link"] & {
18408
+ SelfLink: {
18322
18409
  /** The link type. */
18323
18410
  rel: "self";
18411
+ /** The link URL. */
18412
+ href: string;
18324
18413
  };
18325
18414
  /** The resource ID. Defaults to UUID v4. */
18326
18415
  ResourceId: string;
18327
18416
  /** Read-only timestamp, automatically assigned on back-end. */
18328
18417
  ServerTimestamp: string;
18418
+ /** Read-only timestamp updates when the resource is updated. */
18419
+ UpdatedTime: string;
18420
+ Link: {
18421
+ /** The link URL. */
18422
+ href: string;
18423
+ };
18329
18424
  /** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
18330
18425
  BaseProblem: {
18331
18426
  /** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
@@ -18363,6 +18458,8 @@ export interface usersComponents {
18363
18458
  /** The HTTP status code. */
18364
18459
  status?: number;
18365
18460
  } & usersComponents["schemas"]["BaseProblem"];
18461
+ /** The customer resource ID. Defaults to UUID v4. */
18462
+ CustomerId: string;
18366
18463
  ApiKeyScope: {
18367
18464
  /** The array of account identifier strings. */
18368
18465
  organizationId?: usersComponents["schemas"]["ResourceId"][];
@@ -18600,7 +18697,7 @@ export interface usersComponents {
18600
18697
  };
18601
18698
  /** Check payment instrument object. */
18602
18699
  CheckInstrument: {
18603
- method: "cash";
18700
+ method: "check";
18604
18701
  /** Reference data. */
18605
18702
  reference?: string;
18606
18703
  };
@@ -18684,8 +18781,7 @@ export interface usersComponents {
18684
18781
  type: "customer" | "kyc-document";
18685
18782
  /** The tag's created time. */
18686
18783
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
18687
- /** The tag's updated time. */
18688
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
18784
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
18689
18785
  /** The links related to resource. */
18690
18786
  _links?: Partial<usersComponents["schemas"]["SelfLink"]>[];
18691
18787
  };
@@ -18759,8 +18855,7 @@ export interface usersComponents {
18759
18855
  defaultPaymentInstrument?: usersComponents["schemas"]["PaymentInstrumentValueObject"];
18760
18856
  /** The customer created time. */
18761
18857
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
18762
- /** The customer updated time. */
18763
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
18858
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
18764
18859
  customFields?: usersComponents["schemas"]["ResourceCustomFields"];
18765
18860
  primaryAddress?: usersComponents["schemas"]["ContactObject"];
18766
18861
  averageValue?: usersComponents["schemas"]["CustomerAverageValue"];
@@ -18780,7 +18875,7 @@ export interface usersComponents {
18780
18875
  revision?: number;
18781
18876
  /** Indicates if EDD is enabled for this customer. */
18782
18877
  isEddRequired: boolean;
18783
- /** Whether the customer has fulfilled a KYC request by providing valid identity and address documents. */
18878
+ /** Specifies whether the customer has accepted and reviewed identity and address documents, or an accepted credit file document. */
18784
18879
  hasFulfilledKyc?: boolean;
18785
18880
  /** The links related to resource. */
18786
18881
  _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
@@ -18879,11 +18974,6 @@ export interface usersComponents {
18879
18974
  /** The link type. */
18880
18975
  rel: "transaction";
18881
18976
  };
18882
- InstrumentReference: {
18883
- method: usersComponents["schemas"]["PaymentMethod"];
18884
- /** The payment instrument ID. */
18885
- paymentInstrumentId?: usersComponents["schemas"]["ResourceId"];
18886
- };
18887
18977
  ThreeDSecureResult: {
18888
18978
  /** 3D Secure server name. */
18889
18979
  server?: string;
@@ -19082,8 +19172,7 @@ export interface usersComponents {
19082
19172
  id?: usersComponents["schemas"]["ResourceId"];
19083
19173
  /** The website ID. */
19084
19174
  websiteId?: usersComponents["schemas"]["ResourceId"];
19085
- /** The customer ID. */
19086
- customerId?: usersComponents["schemas"]["ResourceId"];
19175
+ customerId?: usersComponents["schemas"]["CustomerId"];
19087
19176
  /** Transaction type. */
19088
19177
  type?:
19089
19178
  | "3ds-authentication"
@@ -19136,7 +19225,6 @@ export interface usersComponents {
19136
19225
  isRebill?: boolean;
19137
19226
  /** The transaction's rebill number. */
19138
19227
  rebillNumber?: number;
19139
- paymentInstrument?: usersComponents["schemas"]["InstrumentReference"];
19140
19228
  /** Billing address. */
19141
19229
  billingAddress?: usersComponents["schemas"]["ContactObject"];
19142
19230
  has3ds?: boolean;
@@ -19165,8 +19253,7 @@ export interface usersComponents {
19165
19253
  processedTime?: usersComponents["schemas"]["ServerTimestamp"];
19166
19254
  /** Transaction created time. */
19167
19255
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
19168
- /** Transaction updated time. */
19169
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
19256
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
19170
19257
  };
19171
19258
  /** The acquirer name. */
19172
19259
  AcquirerName:
@@ -19740,8 +19827,7 @@ export interface usersComponents {
19740
19827
  | "do-nothing";
19741
19828
  /** Gateway Account created time. */
19742
19829
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
19743
- /** Gateway Account updated time. */
19744
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
19830
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
19745
19831
  /** Organization ID. */
19746
19832
  organizationId?: usersComponents["schemas"]["ResourceId"];
19747
19833
  /** The links related to resource. */
@@ -22561,9 +22647,55 @@ export interface usersComponents {
22561
22647
  CustomerEmbed: {
22562
22648
  customer?: usersComponents["schemas"]["Customer"];
22563
22649
  };
22650
+ /** Website settings. */
22651
+ WebsiteSettings: {
22652
+ /** Payment form settings. */
22653
+ paymentForm?: {
22654
+ /**
22655
+ * Hosted payment form
22656
+ * [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
22657
+ */
22658
+ css?: string;
22659
+ /**
22660
+ * Hosted payment form
22661
+ * [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
22662
+ */
22663
+ theme?: { [key: string]: string };
22664
+ /** Hosted payment form features. */
22665
+ features?: {
22666
+ showCoupons?: string[] | null;
22667
+ };
22668
+ };
22669
+ };
22670
+ OrganizationLink: usersComponents["schemas"]["Link"] & {
22671
+ /** The link type. */
22672
+ rel: "organization";
22673
+ };
22674
+ Website: {
22675
+ /** The website identifier string. */
22676
+ id?: usersComponents["schemas"]["ResourceId"];
22677
+ /** The website name. */
22678
+ name: string;
22679
+ /** The website domain address. */
22680
+ url: string;
22681
+ /** The website customer service phone number. */
22682
+ servicePhone: string;
22683
+ /** The website customer service email address. */
22684
+ serviceEmail: string;
22685
+ /** Website created time. */
22686
+ createdTime?: usersComponents["schemas"]["ServerTimestamp"];
22687
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
22688
+ customFields?: usersComponents["schemas"]["ResourceCustomFields"];
22689
+ settings?: usersComponents["schemas"]["WebsiteSettings"];
22690
+ /** Organization ID. */
22691
+ organizationId?: usersComponents["schemas"]["ResourceId"];
22692
+ /** The links related to resource. */
22693
+ _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
22694
+ Partial<usersComponents["schemas"]["OrganizationLink"]>)[];
22695
+ };
22564
22696
  /** Website object. */
22565
22697
  WebsiteEmbed: {
22566
- website?: { [key: string]: any };
22698
+ website?: usersComponents["schemas"]["Website"];
22567
22699
  };
22568
22700
  CommonPaymentCard: {
22569
22701
  /** The payment instrument ID. */
@@ -22607,8 +22739,7 @@ export interface usersComponents {
22607
22739
  billingPortalUrl?: string;
22608
22740
  /** Payment instrument created time. */
22609
22741
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
22610
- /** Payment instrument updated time. */
22611
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
22742
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
22612
22743
  customFields?: usersComponents["schemas"]["ResourceCustomFields"];
22613
22744
  };
22614
22745
  AuthTransactionLink: usersComponents["schemas"]["Link"] & {
@@ -22620,8 +22751,7 @@ export interface usersComponents {
22620
22751
  authTransaction?: usersComponents["schemas"]["Transaction"];
22621
22752
  };
22622
22753
  PaymentCard: usersComponents["schemas"]["CommonPaymentCard"] & {
22623
- /** The customer ID. */
22624
- customerId?: usersComponents["schemas"]["ResourceId"];
22754
+ customerId?: usersComponents["schemas"]["CustomerId"];
22625
22755
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
22626
22756
  stickyGatewayAccountId?: string | null;
22627
22757
  /** Time expiration reminder event will be triggered. */
@@ -22673,13 +22803,11 @@ export interface usersComponents {
22673
22803
  useAsBackup: boolean;
22674
22804
  /** Bank account created time. */
22675
22805
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
22676
- /** Bank account updated time. */
22677
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
22806
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
22678
22807
  customFields?: usersComponents["schemas"]["ResourceCustomFields"];
22679
22808
  };
22680
22809
  BankAccount: usersComponents["schemas"]["CommonBankAccount"] & {
22681
- /** The customer's ID. */
22682
- customerId?: usersComponents["schemas"]["ResourceId"];
22810
+ customerId?: usersComponents["schemas"]["CustomerId"];
22683
22811
  /** Sticky gateway account ID. All future payments will be processed by this gateway account. */
22684
22812
  stickyGatewayAccountId?: string | null;
22685
22813
  riskMetadata?: usersComponents["schemas"]["RiskMetadata"];
@@ -22784,8 +22912,7 @@ export interface usersComponents {
22784
22912
  customFields?: usersComponents["schemas"]["ResourceCustomFields"];
22785
22913
  /** The product created time. */
22786
22914
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
22787
- /** The product updated time. */
22788
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
22915
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
22789
22916
  };
22790
22917
  Product: usersComponents["schemas"]["CommonProduct"] & {
22791
22918
  /** The product's tax category identifier string. */
@@ -22978,8 +23105,7 @@ export interface usersComponents {
22978
23105
  revision?: number;
22979
23106
  /** Plan created time. */
22980
23107
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
22981
- /** Plan updated time. */
22982
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23108
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
22983
23109
  };
22984
23110
  TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
22985
23111
  TimePluralUnit:
@@ -23063,8 +23189,7 @@ export interface usersComponents {
23063
23189
  periodNumber?: number;
23064
23190
  /** Invoice item created time. */
23065
23191
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23066
- /** Invoice item updated time. */
23067
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23192
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23068
23193
  /** Invoice item tax. */
23069
23194
  tax?: usersComponents["schemas"]["InvoiceTaxItem"];
23070
23195
  /** The links related to resource. */
@@ -23149,8 +23274,7 @@ export interface usersComponents {
23149
23274
  issuedTime?: usersComponents["schemas"]["ServerTimestamp"];
23150
23275
  /** Invoice created time. */
23151
23276
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23152
- /** Invoice updated time. */
23153
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23277
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23154
23278
  /**
23155
23279
  * URL where the customer can be redirected to pay for the invoice
23156
23280
  * with one of the methods which are available for this customer.
@@ -23162,6 +23286,7 @@ export interface usersComponents {
23162
23286
  CommonScheduleInstruction: {
23163
23287
  method:
23164
23288
  | "auto"
23289
+ | "intelligent"
23165
23290
  | "immediately"
23166
23291
  | "date-interval"
23167
23292
  | "day-of-month"
@@ -23210,7 +23335,12 @@ export interface usersComponents {
23210
23335
  };
23211
23336
  /** The calculation instruction of scheduled time. */
23212
23337
  InvoiceRetryScheduleInstruction: {
23213
- method: "immediately" | "date-interval" | "day-of-month" | "day-of-week";
23338
+ method:
23339
+ | "intelligent"
23340
+ | "immediately"
23341
+ | "date-interval"
23342
+ | "day-of-month"
23343
+ | "day-of-week";
23214
23344
  };
23215
23345
  immediately: usersComponents["schemas"]["CommonScheduleInstruction"] &
23216
23346
  usersComponents["schemas"]["ServicePeriodAnchorInstruction"] &
@@ -23225,6 +23355,15 @@ export interface usersComponents {
23225
23355
  | "Saturday";
23226
23356
  /** Extended ISO-8601 format of time. */
23227
23357
  TimeIso8601Extended: string;
23358
+ intelligent: usersComponents["schemas"]["CommonScheduleInstruction"] &
23359
+ usersComponents["schemas"]["CustomEventScheduleInstruction"] &
23360
+ usersComponents["schemas"]["InvoiceRetryScheduleInstruction"] & {
23361
+ /** The number of the units. */
23362
+ duration: number;
23363
+ unit:
23364
+ | usersComponents["schemas"]["TimeUnit"]
23365
+ | usersComponents["schemas"]["TimePluralUnit"];
23366
+ };
23228
23367
  AmountAdjustment: {
23229
23368
  method: "none" | "partial";
23230
23369
  };
@@ -23249,10 +23388,6 @@ export interface usersComponents {
23249
23388
  InvoiceRetryAmountAdjustmentInstruction: {
23250
23389
  method: "none" | "partial";
23251
23390
  };
23252
- OrganizationLink: usersComponents["schemas"]["Link"] & {
23253
- /** The link type. */
23254
- rel: "organization";
23255
- };
23256
23391
  TransactionAllocationsLink: usersComponents["schemas"]["Link"] & {
23257
23392
  /** The link type. */
23258
23393
  rel: "transactionAllocations";
@@ -23334,8 +23469,7 @@ export interface usersComponents {
23334
23469
  settings?: usersComponents["schemas"]["OrganizationSettings"];
23335
23470
  /** The organization created time. */
23336
23471
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23337
- /** The organization updated time. */
23338
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23472
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23339
23473
  /** The links related to resource. */
23340
23474
  _links?: usersComponents["schemas"]["SelfLink"][];
23341
23475
  };
@@ -23363,16 +23497,14 @@ export interface usersComponents {
23363
23497
  status: "active" | "inactive";
23364
23498
  /** The shipping rate created time. */
23365
23499
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23366
- /** The shipping rate updated time. */
23367
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23500
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23368
23501
  };
23369
23502
  /** Shipping rate object. */
23370
23503
  ShippingRateEmbed: {
23371
23504
  shippingRate?: usersComponents["schemas"]["ShippingRate"];
23372
23505
  };
23373
23506
  Invoice: usersComponents["schemas"]["CommonInvoice"] & { [key: string]: any } & {
23374
- /** The customer ID. */
23375
- customerId?: usersComponents["schemas"]["ResourceId"];
23507
+ customerId?: usersComponents["schemas"]["CustomerId"];
23376
23508
  /** Invoice transactions array. */
23377
23509
  transactions?: usersComponents["schemas"]["Transaction"][];
23378
23510
  /** The invoice retry instruction. */
@@ -23441,8 +23573,7 @@ export interface usersComponents {
23441
23573
  settings: { [key: string]: string };
23442
23574
  /** Application instance created time. */
23443
23575
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23444
- /** Application instance updated time. */
23445
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23576
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23446
23577
  /** The links related to resource. */
23447
23578
  _links?: Partial<usersComponents["schemas"]["SelfLink"]>[];
23448
23579
  };
@@ -23504,8 +23635,7 @@ export interface usersComponents {
23504
23635
  properties?: { [key: string]: any };
23505
23636
  /** Application created time. */
23506
23637
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23507
- /** Application updated time. */
23508
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23638
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23509
23639
  /** The links related to resource. */
23510
23640
  _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
23511
23641
  Partial<usersComponents["schemas"]["ApplicationInstanceLink"]> &
@@ -23768,8 +23898,7 @@ export interface usersComponents {
23768
23898
  settlementRate?: number;
23769
23899
  /** Entry created time. */
23770
23900
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23771
- /** Entry updated time. */
23772
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23901
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23773
23902
  };
23774
23903
  ParentLink: usersComponents["schemas"]["Link"] & {
23775
23904
  /** The link type. */
@@ -23859,8 +23988,7 @@ export interface usersComponents {
23859
23988
  };
23860
23989
  /** Billing portal created time. */
23861
23990
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23862
- /** Billing portal updated time. */
23863
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
23991
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23864
23992
  };
23865
23993
  BillingPortal: usersComponents["schemas"]["CommonBillingPortal"] & {
23866
23994
  /** Billing portal name, used for internal display to help you organize your various billing portals. Will not be displayed to your customers. */
@@ -23926,8 +24054,7 @@ export interface usersComponents {
23926
24054
  status?: "draft" | "sending" | "sent" | "archived";
23927
24055
  /** The broadcast message's created time. */
23928
24056
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
23929
- /** The broadcast message's updated time. */
23930
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24057
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
23931
24058
  /** The links related to the resource. */
23932
24059
  _links?: usersComponents["schemas"]["SelfLink"][];
23933
24060
  };
@@ -24031,8 +24158,7 @@ export interface usersComponents {
24031
24158
  };
24032
24159
  /** Checkout form created time. */
24033
24160
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
24034
- /** Checkout form updated time. */
24035
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24161
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24036
24162
  };
24037
24163
  PreviewLink: usersComponents["schemas"]["Link"] & {
24038
24164
  /** The link type. */
@@ -24206,8 +24332,7 @@ export interface usersComponents {
24206
24332
  isVerified?: boolean;
24207
24333
  /** Custom domain created time. */
24208
24334
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
24209
- /** Custom domain updated time. */
24210
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24335
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24211
24336
  };
24212
24337
  EmailDeliverySetting: {
24213
24338
  /** The email delivery setting's identifier string. */
@@ -24232,8 +24357,7 @@ export interface usersComponents {
24232
24357
  isDefault: boolean;
24233
24358
  /** The created time. */
24234
24359
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
24235
- /** The updated time. */
24236
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24360
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24237
24361
  };
24238
24362
  EmailMessage: {
24239
24363
  /** The email message's identifier string. */
@@ -24267,8 +24391,7 @@ export interface usersComponents {
24267
24391
  }[];
24268
24392
  /** The email message's created time. */
24269
24393
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
24270
- /** The email message's updated time. */
24271
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24394
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24272
24395
  /** The links related to the resource. */
24273
24396
  _links?: usersComponents["schemas"]["SelfLink"][];
24274
24397
  };
@@ -24865,7 +24988,7 @@ export interface usersComponents {
24865
24988
  * a final rule can stop the execution of following rules after execution.
24866
24989
  */
24867
24990
  rules: usersComponents["schemas"]["Rule"][];
24868
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
24991
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24869
24992
  /** The links related to resource. */
24870
24993
  _links?: usersComponents["schemas"]["SelfLink"][];
24871
24994
  };
@@ -24948,7 +25071,7 @@ export interface usersComponents {
24948
25071
  /** Detailed description of the drafted rule set. */
24949
25072
  description?: string;
24950
25073
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
24951
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25074
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
24952
25075
  /** The links related to resource. */
24953
25076
  _links?: (Partial<usersComponents["schemas"]["LinkSelf"]> &
24954
25077
  Partial<usersComponents["schemas"]["LinkUser"]>)[];
@@ -25014,8 +25137,7 @@ export interface usersComponents {
25014
25137
  usage?: number;
25015
25138
  /** Gateway account limit created time. */
25016
25139
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25017
- /** Gateway account limit updated time. */
25018
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25140
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25019
25141
  /** The links related to resource. */
25020
25142
  _links?: usersComponents["schemas"]["SelfLink"][];
25021
25143
  };
@@ -25181,8 +25303,7 @@ export interface usersComponents {
25181
25303
  values: string[];
25182
25304
  /** List created time. */
25183
25305
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25184
- /** List updated time. */
25185
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25306
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25186
25307
  /** Links related to resource. */
25187
25308
  _links?: usersComponents["schemas"]["SelfLink"][];
25188
25309
  };
@@ -25361,8 +25482,7 @@ export interface usersComponents {
25361
25482
  userId?: usersComponents["schemas"]["ResourceId"];
25362
25483
  /** Session created time. */
25363
25484
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25364
- /** Session updated time. */
25365
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25485
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25366
25486
  /** Session expired time. Defaults to one hour. */
25367
25487
  expiredTime?: string;
25368
25488
  /** The links related to resource. */
@@ -25474,8 +25594,7 @@ export interface usersComponents {
25474
25594
  credentialHash: string;
25475
25595
  /** List created time. */
25476
25596
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25477
- /** List updated time. */
25478
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25597
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25479
25598
  /** Links related to resource. */
25480
25599
  _links?: usersComponents["schemas"]["SelfLink"][];
25481
25600
  };
@@ -25574,8 +25693,7 @@ export interface usersComponents {
25574
25693
  computedPermissions?: usersComponents["schemas"]["AclPermissions"];
25575
25694
  /** The user created time. */
25576
25695
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25577
- /** The user updated time. */
25578
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25696
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25579
25697
  /** The user last login time. */
25580
25698
  loginTime?: usersComponents["schemas"]["ServerTimestamp"];
25581
25699
  /** The user's ISO Alpha-3 code used for reports. */
@@ -25624,8 +25742,7 @@ export interface usersComponents {
25624
25742
  usersCount?: number;
25625
25743
  /** The role created time. */
25626
25744
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25627
- /** The role updated time. */
25628
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25745
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25629
25746
  /** The links related to a resource. */
25630
25747
  _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
25631
25748
  Partial<usersComponents["schemas"]["SeniorRolesLink"]> &
@@ -25726,7 +25843,7 @@ export interface usersComponents {
25726
25843
  ipAddress?: string;
25727
25844
  /** The IDs of related resources. */
25728
25845
  relatedIds?: {
25729
- customerId?: usersComponents["schemas"]["ResourceId"];
25846
+ customerId?: usersComponents["schemas"]["CustomerId"];
25730
25847
  transactionId?: usersComponents["schemas"]["ResourceId"];
25731
25848
  tokenId?: usersComponents["schemas"]["ResourceId"];
25732
25849
  };
@@ -25768,49 +25885,6 @@ export interface usersComponents {
25768
25885
  /** The links related to resource. */
25769
25886
  _links?: usersComponents["schemas"]["SelfLink"][];
25770
25887
  };
25771
- /** Website settings. */
25772
- WebsiteSettings: {
25773
- /** Payment form settings. */
25774
- paymentForm?: {
25775
- /**
25776
- * Hosted payment form
25777
- * [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
25778
- */
25779
- css?: string;
25780
- /**
25781
- * Hosted payment form
25782
- * [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
25783
- */
25784
- theme?: { [key: string]: string };
25785
- /** Hosted payment form features. */
25786
- features?: {
25787
- showCoupons?: string[] | null;
25788
- };
25789
- };
25790
- };
25791
- Website: {
25792
- /** The website identifier string. */
25793
- id?: usersComponents["schemas"]["ResourceId"];
25794
- /** The website name. */
25795
- name: string;
25796
- /** The website domain address. */
25797
- url: string;
25798
- /** The website customer service phone number. */
25799
- servicePhone: string;
25800
- /** The website customer service email address. */
25801
- serviceEmail: string;
25802
- /** Website created time. */
25803
- createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25804
- /** Website updated time. */
25805
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25806
- customFields?: usersComponents["schemas"]["ResourceCustomFields"];
25807
- settings?: usersComponents["schemas"]["WebsiteSettings"];
25808
- /** Organization ID. */
25809
- organizationId?: usersComponents["schemas"]["ResourceId"];
25810
- /** The links related to resource. */
25811
- _links?: (Partial<usersComponents["schemas"]["SelfLink"]> &
25812
- Partial<usersComponents["schemas"]["OrganizationLink"]>)[];
25813
- };
25814
25888
  LinkSignedLink: usersComponents["schemas"]["Link"] & {
25815
25889
  /** The link type. */
25816
25890
  rel: "signedLink";
@@ -25856,8 +25930,7 @@ export interface usersComponents {
25856
25930
  items?: usersComponents["schemas"]["OrganizationExportResource"][];
25857
25931
  /** Time at which the organization data export was requested. */
25858
25932
  createdTime?: usersComponents["schemas"]["ServerTimestamp"];
25859
- /** Time at which the organization data export is updated. */
25860
- updatedTime?: usersComponents["schemas"]["ServerTimestamp"];
25933
+ updatedTime?: usersComponents["schemas"]["UpdatedTime"];
25861
25934
  /** Retention end date. After this date, files will be removed. */
25862
25935
  retentionTime?: string | null;
25863
25936
  /** Links related to the resource. */
@@ -26135,7 +26208,7 @@ export interface usersComponents {
26135
26208
  export interface operations {
26136
26209
  /**
26137
26210
  * Retrieve a list of application instances.
26138
- * You may sort by the id, name, status, createdTime, and updatedTime.
26211
+ * You may sort by the `id`, `name`, `status`, `createdTime`, and `updatedTime`.
26139
26212
  */
26140
26213
  GetApplicationInstance: {
26141
26214
  parameters: {
@@ -26173,6 +26246,7 @@ export interface operations {
26173
26246
  };
26174
26247
  /** Application instance was created. */
26175
26248
  201: {
26249
+ headers: {};
26176
26250
  content: {
26177
26251
  "application/json": usersComponents["schemas"]["ApplicationInstance"];
26178
26252
  };
@@ -26205,7 +26279,7 @@ export interface operations {
26205
26279
  };
26206
26280
  /**
26207
26281
  * Retrieve a list of applications.
26208
- * You may sort by the id, name, status, createdTime, and updatedTime.
26282
+ * You may sort by the `id`, `name`, `status`, `createdTime`, and `updatedTime`.
26209
26283
  */
26210
26284
  GetApplicationCollection: {
26211
26285
  parameters: {
@@ -26251,6 +26325,7 @@ export interface operations {
26251
26325
  responses: {
26252
26326
  /** Application was registered. */
26253
26327
  201: {
26328
+ headers: {};
26254
26329
  content: {
26255
26330
  "application/json": usersComponents["schemas"]["Application"];
26256
26331
  };
@@ -26371,6 +26446,7 @@ export interface operations {
26371
26446
  responses: {
26372
26447
  /** API key was created. */
26373
26448
  201: {
26449
+ headers: {};
26374
26450
  content: {
26375
26451
  "application/json": usersComponents["schemas"]["ApiKey"];
26376
26452
  };
@@ -26418,6 +26494,7 @@ export interface operations {
26418
26494
  };
26419
26495
  /** API key was created. */
26420
26496
  201: {
26497
+ headers: {};
26421
26498
  content: {
26422
26499
  "application/json": usersComponents["schemas"]["ApiKey"];
26423
26500
  };
@@ -26533,6 +26610,7 @@ export interface operations {
26533
26610
  responses: {
26534
26611
  /** Billing portal was created. */
26535
26612
  201: {
26613
+ headers: {};
26536
26614
  content: {
26537
26615
  "application/json": usersComponents["schemas"]["BillingPortal"];
26538
26616
  };
@@ -26584,6 +26662,7 @@ export interface operations {
26584
26662
  };
26585
26663
  /** Billing portal was created. */
26586
26664
  201: {
26665
+ headers: {};
26587
26666
  content: {
26588
26667
  "application/json": usersComponents["schemas"]["BillingPortal"];
26589
26668
  };
@@ -26650,6 +26729,7 @@ export interface operations {
26650
26729
  responses: {
26651
26730
  /** Broadcast message was created. */
26652
26731
  201: {
26732
+ headers: {};
26653
26733
  content: {
26654
26734
  "application/json": usersComponents["schemas"]["BroadcastMessage"];
26655
26735
  };
@@ -26761,6 +26841,7 @@ export interface operations {
26761
26841
  responses: {
26762
26842
  /** Checkout form was created. */
26763
26843
  201: {
26844
+ headers: {};
26764
26845
  content: {
26765
26846
  "application/json": usersComponents["schemas"]["CheckoutForm"];
26766
26847
  };
@@ -26812,6 +26893,7 @@ export interface operations {
26812
26893
  };
26813
26894
  /** Checkout form was created. */
26814
26895
  201: {
26896
+ headers: {};
26815
26897
  content: {
26816
26898
  "application/json": usersComponents["schemas"]["CheckoutForm"];
26817
26899
  };
@@ -26848,6 +26930,7 @@ export interface operations {
26848
26930
  responses: {
26849
26931
  /** AWS SES credential was created. */
26850
26932
  201: {
26933
+ headers: {};
26851
26934
  content: {
26852
26935
  "application/json": usersComponents["schemas"]["SESCredential"];
26853
26936
  };
@@ -26922,6 +27005,7 @@ export interface operations {
26922
27005
  responses: {
26923
27006
  /** SMTP credential was created. */
26924
27007
  201: {
27008
+ headers: {};
26925
27009
  content: {
26926
27010
  "application/json": usersComponents["schemas"]["SmtpCredential"];
26927
27011
  };
@@ -26996,6 +27080,7 @@ export interface operations {
26996
27080
  responses: {
26997
27081
  /** Mailgun credential was created. */
26998
27082
  201: {
27083
+ headers: {};
26999
27084
  content: {
27000
27085
  "application/json": usersComponents["schemas"]["MailgunCredential"];
27001
27086
  };
@@ -27106,6 +27191,7 @@ export interface operations {
27106
27191
  responses: {
27107
27192
  /** OAuth2 credential was created. */
27108
27193
  201: {
27194
+ headers: {};
27109
27195
  content: {
27110
27196
  "application/json": usersComponents["schemas"]["OAuth2Credential"];
27111
27197
  };
@@ -27233,6 +27319,7 @@ export interface operations {
27233
27319
  responses: {
27234
27320
  /** Plaid credential was created. */
27235
27321
  201: {
27322
+ headers: {};
27236
27323
  content: {
27237
27324
  "application/json": usersComponents["schemas"]["PlaidCredential"];
27238
27325
  };
@@ -27307,6 +27394,7 @@ export interface operations {
27307
27394
  responses: {
27308
27395
  /** Postmark credential was created. */
27309
27396
  201: {
27397
+ headers: {};
27310
27398
  content: {
27311
27399
  "application/json": usersComponents["schemas"]["PostmarkCredential"];
27312
27400
  };
@@ -27381,6 +27469,7 @@ export interface operations {
27381
27469
  responses: {
27382
27470
  /** SendGrid credential was created. */
27383
27471
  201: {
27472
+ headers: {};
27384
27473
  content: {
27385
27474
  "application/json": usersComponents["schemas"]["SendGridCredential"];
27386
27475
  };
@@ -27455,6 +27544,7 @@ export interface operations {
27455
27544
  responses: {
27456
27545
  /** Webhook credential was created. */
27457
27546
  201: {
27547
+ headers: {};
27458
27548
  content: {
27459
27549
  "application/json": usersComponents["schemas"]["WebhookCredential"];
27460
27550
  };
@@ -27560,6 +27650,7 @@ export interface operations {
27560
27650
  responses: {
27561
27651
  /** Experian credential was created. */
27562
27652
  201: {
27653
+ headers: {};
27563
27654
  content: {
27564
27655
  "application/json": usersComponents["schemas"]["ExperianCredential"];
27565
27656
  };
@@ -27665,6 +27756,7 @@ export interface operations {
27665
27756
  responses: {
27666
27757
  /** TaxJar credential was created. */
27667
27758
  201: {
27759
+ headers: {};
27668
27760
  content: {
27669
27761
  "application/json": usersComponents["schemas"]["TaxJarCredential"];
27670
27762
  };
@@ -27771,6 +27863,7 @@ export interface operations {
27771
27863
  responses: {
27772
27864
  /** Custom domain was created. */
27773
27865
  201: {
27866
+ headers: {};
27774
27867
  content: {
27775
27868
  "application/json": usersComponents["schemas"]["CustomDomain"];
27776
27869
  };
@@ -27877,6 +27970,7 @@ export interface operations {
27877
27970
  responses: {
27878
27971
  /** Email delivery setting was created. */
27879
27972
  201: {
27973
+ headers: {};
27880
27974
  content: {
27881
27975
  "application/json": usersComponents["schemas"]["EmailDeliverySetting"];
27882
27976
  };
@@ -28011,6 +28105,7 @@ export interface operations {
28011
28105
  responses: {
28012
28106
  /** Email message was created. */
28013
28107
  201: {
28108
+ headers: {};
28014
28109
  content: {
28015
28110
  "application/json": usersComponents["schemas"]["EmailMessage"];
28016
28111
  };
@@ -28222,6 +28317,7 @@ export interface operations {
28222
28317
  responses: {
28223
28318
  /** Rules Engine Timeline comment was created. */
28224
28319
  201: {
28320
+ headers: {};
28225
28321
  content: {
28226
28322
  "application/json": usersComponents["schemas"]["RulesEngineTimeline"];
28227
28323
  };
@@ -28590,6 +28686,7 @@ export interface operations {
28590
28686
  responses: {
28591
28687
  /** Gateway Account was created. */
28592
28688
  201: {
28689
+ headers: {};
28593
28690
  content: {
28594
28691
  "application/json": usersComponents["schemas"]["GatewayAccount"];
28595
28692
  };
@@ -28642,6 +28739,7 @@ export interface operations {
28642
28739
  };
28643
28740
  /** Gateway Account was created. */
28644
28741
  201: {
28742
+ headers: {};
28645
28743
  content: {
28646
28744
  "application/json": usersComponents["schemas"]["GatewayAccount"];
28647
28745
  };
@@ -28707,6 +28805,7 @@ export interface operations {
28707
28805
  responses: {
28708
28806
  /** Closed successfully. */
28709
28807
  201: {
28808
+ headers: {};
28710
28809
  content: {
28711
28810
  "application/json": usersComponents["schemas"]["GatewayAccount"];
28712
28811
  };
@@ -28730,6 +28829,7 @@ export interface operations {
28730
28829
  responses: {
28731
28830
  /** Disabled successfully. */
28732
28831
  201: {
28832
+ headers: {};
28733
28833
  content: {
28734
28834
  "application/json": usersComponents["schemas"]["GatewayAccount"];
28735
28835
  };
@@ -28786,6 +28886,7 @@ export interface operations {
28786
28886
  responses: {
28787
28887
  /** Gateway Account downtime schedule was created. */
28788
28888
  201: {
28889
+ headers: {};
28789
28890
  content: {
28790
28891
  "application/json": usersComponents["schemas"]["GatewayAccountDowntimeSchedule"];
28791
28892
  };
@@ -28876,6 +28977,7 @@ export interface operations {
28876
28977
  responses: {
28877
28978
  /** Enabled successfully. */
28878
28979
  201: {
28980
+ headers: {};
28879
28981
  content: {
28880
28982
  "application/json": usersComponents["schemas"]["GatewayAccount"];
28881
28983
  };
@@ -28955,6 +29057,7 @@ export interface operations {
28955
29057
  };
28956
29058
  /** Gateway account limit was created. */
28957
29059
  201: {
29060
+ headers: {};
28958
29061
  content: {
28959
29062
  "application/json": usersComponents["schemas"]["GatewayAccountLimit"];
28960
29063
  };
@@ -29040,6 +29143,7 @@ export interface operations {
29040
29143
  responses: {
29041
29144
  /** Gateway Account Timeline comment was created. */
29042
29145
  201: {
29146
+ headers: {};
29043
29147
  content: {
29044
29148
  "application/json": usersComponents["schemas"]["GatewayAccountTimeline"];
29045
29149
  };
@@ -29185,6 +29289,7 @@ export interface operations {
29185
29289
  };
29186
29290
  /** Domain was successfully registered with Apple Pay. */
29187
29291
  201: {
29292
+ headers: {};
29188
29293
  content: {
29189
29294
  "application/json": usersComponents["schemas"]["DigitalWalletOnboardingApplePay"];
29190
29295
  };
@@ -29239,6 +29344,7 @@ export interface operations {
29239
29344
  responses: {
29240
29345
  /** Segment was created successfully. */
29241
29346
  201: {
29347
+ headers: {};
29242
29348
  content: {
29243
29349
  "application/json": usersComponents["schemas"]["Segment"];
29244
29350
  };
@@ -29381,6 +29487,7 @@ export interface operations {
29381
29487
  responses: {
29382
29488
  /** List was created. */
29383
29489
  201: {
29490
+ headers: {};
29384
29491
  content: {
29385
29492
  "application/json": usersComponents["schemas"]["ValueList"];
29386
29493
  };
@@ -29432,6 +29539,7 @@ export interface operations {
29432
29539
  };
29433
29540
  /** List was created. */
29434
29541
  201: {
29542
+ headers: {};
29435
29543
  content: {
29436
29544
  "application/json": usersComponents["schemas"]["ValueList"];
29437
29545
  };
@@ -29570,6 +29678,7 @@ export interface operations {
29570
29678
  };
29571
29679
  /** Membership was created. */
29572
29680
  201: {
29681
+ headers: {};
29573
29682
  content: {
29574
29683
  "application/json": usersComponents["schemas"]["Membership"];
29575
29684
  };
@@ -29638,6 +29747,7 @@ export interface operations {
29638
29747
  responses: {
29639
29748
  /** Organization was created. */
29640
29749
  201: {
29750
+ headers: {};
29641
29751
  content: {
29642
29752
  "application/json": usersComponents["schemas"]["Organization"];
29643
29753
  };
@@ -29782,6 +29892,7 @@ export interface operations {
29782
29892
  responses: {
29783
29893
  /** Session was created. */
29784
29894
  201: {
29895
+ headers: {};
29785
29896
  content: {
29786
29897
  "application/json": usersComponents["schemas"]["Session"];
29787
29898
  };
@@ -29809,6 +29920,7 @@ export interface operations {
29809
29920
  responses: {
29810
29921
  /** Session was restored. */
29811
29922
  201: {
29923
+ headers: {};
29812
29924
  content: {
29813
29925
  "application/json": usersComponents["schemas"]["Session"];
29814
29926
  };
@@ -29927,6 +30039,7 @@ export interface operations {
29927
30039
  responses: {
29928
30040
  /** User MFA update url was created successfuly. */
29929
30041
  201: {
30042
+ headers: {};
29930
30043
  content: {
29931
30044
  "application/json": usersComponents["schemas"]["ProfileMfa"];
29932
30045
  };
@@ -29951,6 +30064,7 @@ export interface operations {
29951
30064
  responses: {
29952
30065
  /** Password updated successfully. */
29953
30066
  201: {
30067
+ headers: {};
29954
30068
  content: {
29955
30069
  "application/json": usersComponents["schemas"]["Profile"];
29956
30070
  };
@@ -29967,6 +30081,7 @@ export interface operations {
29967
30081
  responses: {
29968
30082
  /** totpSecret reset (renewed) successfully. */
29969
30083
  201: {
30084
+ headers: {};
29970
30085
  content: {
29971
30086
  "application/json": usersComponents["schemas"]["Profile"];
29972
30087
  };
@@ -30002,6 +30117,7 @@ export interface operations {
30002
30117
  responses: {
30003
30118
  /** Password was reset successfully. */
30004
30119
  201: {
30120
+ headers: {};
30005
30121
  content: {
30006
30122
  "application/json": usersComponents["schemas"]["User"];
30007
30123
  };
@@ -30058,6 +30174,7 @@ export interface operations {
30058
30174
  responses: {
30059
30175
  /** Role was created. */
30060
30176
  201: {
30177
+ headers: {};
30061
30178
  content: {
30062
30179
  "application/json": usersComponents["schemas"]["Role"];
30063
30180
  };
@@ -30118,6 +30235,7 @@ export interface operations {
30118
30235
  };
30119
30236
  /** Role was created. */
30120
30237
  201: {
30238
+ headers: {};
30121
30239
  content: {
30122
30240
  "application/json": usersComponents["schemas"]["Role"];
30123
30241
  };
@@ -30173,6 +30291,7 @@ export interface operations {
30173
30291
  responses: {
30174
30292
  /** Session was created. */
30175
30293
  201: {
30294
+ headers: {};
30176
30295
  content: {
30177
30296
  "application/json": usersComponents["schemas"]["Session"];
30178
30297
  };
@@ -30193,6 +30312,7 @@ export interface operations {
30193
30312
  responses: {
30194
30313
  /** User was created. */
30195
30314
  201: {
30315
+ headers: {};
30196
30316
  content: {
30197
30317
  "application/json": usersComponents["schemas"]["User"];
30198
30318
  };
@@ -30405,6 +30525,7 @@ export interface operations {
30405
30525
  responses: {
30406
30526
  /** User was created. */
30407
30527
  201: {
30528
+ headers: {};
30408
30529
  content: {
30409
30530
  "application/json": usersComponents["schemas"]["User"];
30410
30531
  };
@@ -30452,6 +30573,7 @@ export interface operations {
30452
30573
  };
30453
30574
  /** User was created. */
30454
30575
  201: {
30576
+ headers: {};
30455
30577
  content: {
30456
30578
  "application/json": usersComponents["schemas"]["User"];
30457
30579
  };
@@ -30494,6 +30616,7 @@ export interface operations {
30494
30616
  responses: {
30495
30617
  /** Password updated successfully. */
30496
30618
  201: {
30619
+ headers: {};
30497
30620
  content: {
30498
30621
  "application/json": usersComponents["schemas"]["User"];
30499
30622
  };
@@ -30516,6 +30639,7 @@ export interface operations {
30516
30639
  responses: {
30517
30640
  /** totpSecret reset (renewed) successfully. */
30518
30641
  201: {
30642
+ headers: {};
30519
30643
  content: {
30520
30644
  "application/json": usersComponents["schemas"]["User"];
30521
30645
  };
@@ -30556,6 +30680,7 @@ export interface operations {
30556
30680
  responses: {
30557
30681
  /** Webhook was created. */
30558
30682
  201: {
30683
+ headers: {};
30559
30684
  content: {
30560
30685
  "application/json": usersComponents["schemas"]["GlobalWebhook"];
30561
30686
  };
@@ -30603,6 +30728,7 @@ export interface operations {
30603
30728
  };
30604
30729
  /** Webhook was created. */
30605
30730
  201: {
30731
+ headers: {};
30606
30732
  content: {
30607
30733
  "application/json": usersComponents["schemas"]["GlobalWebhook"];
30608
30734
  };
@@ -30655,6 +30781,7 @@ export interface operations {
30655
30781
  responses: {
30656
30782
  /** Website was created. */
30657
30783
  201: {
30784
+ headers: {};
30658
30785
  content: {
30659
30786
  "application/json": usersComponents["schemas"]["Website"];
30660
30787
  };
@@ -30702,6 +30829,7 @@ export interface operations {
30702
30829
  };
30703
30830
  /** Website was created. */
30704
30831
  201: {
30832
+ headers: {};
30705
30833
  content: {
30706
30834
  "application/json": usersComponents["schemas"]["Website"];
30707
30835
  };
@@ -30770,6 +30898,7 @@ export interface operations {
30770
30898
  responses: {
30771
30899
  /** Organization data export request received. */
30772
30900
  201: {
30901
+ headers: {};
30773
30902
  content: {
30774
30903
  "application/json": usersComponents["schemas"]["OrganizationExport"];
30775
30904
  };
@@ -31115,18 +31244,22 @@ export interface storefrontComponents {
31115
31244
  schemas: {
31116
31245
  /** The ISO 3166 alpha-2 country code. */
31117
31246
  Country: string;
31118
- Link: {
31119
- /** The link URL. */
31120
- href: string;
31121
- };
31122
- SelfLink: storefrontComponents["schemas"]["Link"] & {
31247
+ SelfLink: {
31123
31248
  /** The link type. */
31124
31249
  rel: "self";
31250
+ /** The link URL. */
31251
+ href: string;
31125
31252
  };
31126
31253
  /** The resource ID. Defaults to UUID v4. */
31127
31254
  ResourceId: string;
31128
31255
  /** Read-only timestamp, automatically assigned on back-end. */
31129
31256
  ServerTimestamp: string;
31257
+ /** Read-only timestamp updates when the resource is updated. */
31258
+ UpdatedTime: string;
31259
+ Link: {
31260
+ /** The link URL. */
31261
+ href: string;
31262
+ };
31130
31263
  /** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
31131
31264
  BaseProblem: {
31132
31265
  /** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
@@ -31164,6 +31297,8 @@ export interface storefrontComponents {
31164
31297
  /** The HTTP status code. */
31165
31298
  status?: number;
31166
31299
  } & storefrontComponents["schemas"]["BaseProblem"];
31300
+ /** The customer resource ID. Defaults to UUID v4. */
31301
+ CustomerId: string;
31167
31302
  CustomerLink: storefrontComponents["schemas"]["Link"] & {
31168
31303
  /** The link type. */
31169
31304
  rel: "customer" | "targetCustomer";
@@ -31417,11 +31552,6 @@ export interface storefrontComponents {
31417
31552
  _links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
31418
31553
  Partial<storefrontComponents["schemas"]["CustomerLink"]>)[];
31419
31554
  };
31420
- InstrumentReference: {
31421
- method: storefrontComponents["schemas"]["PaymentMethod"];
31422
- /** The payment instrument ID. */
31423
- paymentInstrumentId?: storefrontComponents["schemas"]["ResourceId"];
31424
- };
31425
31555
  ThreeDSecureResult: {
31426
31556
  /** 3D Secure server name. */
31427
31557
  server?: string;
@@ -31620,8 +31750,7 @@ export interface storefrontComponents {
31620
31750
  id?: storefrontComponents["schemas"]["ResourceId"];
31621
31751
  /** The website ID. */
31622
31752
  websiteId?: storefrontComponents["schemas"]["ResourceId"];
31623
- /** The customer ID. */
31624
- customerId?: storefrontComponents["schemas"]["ResourceId"];
31753
+ customerId?: storefrontComponents["schemas"]["CustomerId"];
31625
31754
  /** Transaction type. */
31626
31755
  type?:
31627
31756
  | "3ds-authentication"
@@ -31674,7 +31803,6 @@ export interface storefrontComponents {
31674
31803
  isRebill?: boolean;
31675
31804
  /** The transaction's rebill number. */
31676
31805
  rebillNumber?: number;
31677
- paymentInstrument?: storefrontComponents["schemas"]["InstrumentReference"];
31678
31806
  /** Billing address. */
31679
31807
  billingAddress?: storefrontComponents["schemas"]["ContactObject"];
31680
31808
  has3ds?: boolean;
@@ -31703,8 +31831,7 @@ export interface storefrontComponents {
31703
31831
  processedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31704
31832
  /** Transaction created time. */
31705
31833
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31706
- /** Transaction updated time. */
31707
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31834
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
31708
31835
  };
31709
31836
  /** The HTTP headers. */
31710
31837
  HttpHeaders: { [key: string]: string };
@@ -31822,6 +31949,52 @@ export interface storefrontComponents {
31822
31949
  | "AstroPay Card";
31823
31950
  /** The ISO 3166 alpha-2 country code where the payment is processed. This is often the location for settling the payment. Consult with your payment service provider (PSP) to determine the appropriate country code. */
31824
31951
  DigitalWalletCountry: storefrontComponents["schemas"]["Country"];
31952
+ /** Website settings. */
31953
+ WebsiteSettings: {
31954
+ /** Payment form settings. */
31955
+ paymentForm?: {
31956
+ /**
31957
+ * Hosted payment form
31958
+ * [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
31959
+ */
31960
+ css?: string;
31961
+ /**
31962
+ * Hosted payment form
31963
+ * [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
31964
+ */
31965
+ theme?: { [key: string]: string };
31966
+ /** Hosted payment form features. */
31967
+ features?: {
31968
+ showCoupons?: string[] | null;
31969
+ };
31970
+ };
31971
+ };
31972
+ OrganizationLink: storefrontComponents["schemas"]["Link"] & {
31973
+ /** The link type. */
31974
+ rel: "organization";
31975
+ };
31976
+ Website: {
31977
+ /** The website identifier string. */
31978
+ id?: storefrontComponents["schemas"]["ResourceId"];
31979
+ /** The website name. */
31980
+ name: string;
31981
+ /** The website domain address. */
31982
+ url: string;
31983
+ /** The website customer service phone number. */
31984
+ servicePhone: string;
31985
+ /** The website customer service email address. */
31986
+ serviceEmail: string;
31987
+ /** Website created time. */
31988
+ createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31989
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
31990
+ customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
31991
+ settings?: storefrontComponents["schemas"]["WebsiteSettings"];
31992
+ /** Organization ID. */
31993
+ organizationId?: storefrontComponents["schemas"]["ResourceId"];
31994
+ /** The links related to resource. */
31995
+ _links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
31996
+ Partial<storefrontComponents["schemas"]["OrganizationLink"]>)[];
31997
+ };
31825
31998
  CommonPaymentCard: {
31826
31999
  /** The payment instrument ID. */
31827
32000
  id?: storefrontComponents["schemas"]["ResourceId"];
@@ -31864,8 +32037,7 @@ export interface storefrontComponents {
31864
32037
  billingPortalUrl?: string;
31865
32038
  /** Payment instrument created time. */
31866
32039
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31867
- /** Payment instrument updated time. */
31868
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32040
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
31869
32041
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
31870
32042
  };
31871
32043
  CommonBankAccount: {
@@ -31895,8 +32067,7 @@ export interface storefrontComponents {
31895
32067
  useAsBackup: boolean;
31896
32068
  /** Bank account created time. */
31897
32069
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31898
- /** Bank account updated time. */
31899
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32070
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
31900
32071
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
31901
32072
  };
31902
32073
  /** Shipping settings. */
@@ -31990,8 +32161,7 @@ export interface storefrontComponents {
31990
32161
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
31991
32162
  /** The product created time. */
31992
32163
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
31993
- /** The product updated time. */
31994
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32164
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
31995
32165
  };
31996
32166
  Product: storefrontComponents["schemas"]["CommonProduct"] & {
31997
32167
  /** The product's tax category identifier string. */
@@ -32184,8 +32354,7 @@ export interface storefrontComponents {
32184
32354
  revision?: number;
32185
32355
  /** Plan created time. */
32186
32356
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32187
- /** Plan updated time. */
32188
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32357
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32189
32358
  };
32190
32359
  TimeUnit: "second" | "minute" | "hour" | "day" | "month" | "year";
32191
32360
  TimePluralUnit:
@@ -32269,8 +32438,7 @@ export interface storefrontComponents {
32269
32438
  periodNumber?: number;
32270
32439
  /** Invoice item created time. */
32271
32440
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32272
- /** Invoice item updated time. */
32273
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32441
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32274
32442
  /** Invoice item tax. */
32275
32443
  tax?: storefrontComponents["schemas"]["InvoiceTaxItem"];
32276
32444
  /** The links related to resource. */
@@ -32355,8 +32523,7 @@ export interface storefrontComponents {
32355
32523
  issuedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32356
32524
  /** Invoice created time. */
32357
32525
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32358
- /** Invoice updated time. */
32359
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32526
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32360
32527
  /**
32361
32528
  * URL where the customer can be redirected to pay for the invoice
32362
32529
  * with one of the methods which are available for this customer.
@@ -32368,6 +32535,7 @@ export interface storefrontComponents {
32368
32535
  CommonScheduleInstruction: {
32369
32536
  method:
32370
32537
  | "auto"
32538
+ | "intelligent"
32371
32539
  | "immediately"
32372
32540
  | "date-interval"
32373
32541
  | "day-of-month"
@@ -32416,7 +32584,12 @@ export interface storefrontComponents {
32416
32584
  };
32417
32585
  /** The calculation instruction of scheduled time. */
32418
32586
  InvoiceRetryScheduleInstruction: {
32419
- method: "immediately" | "date-interval" | "day-of-month" | "day-of-week";
32587
+ method:
32588
+ | "intelligent"
32589
+ | "immediately"
32590
+ | "date-interval"
32591
+ | "day-of-month"
32592
+ | "day-of-week";
32420
32593
  };
32421
32594
  immediately: storefrontComponents["schemas"]["CommonScheduleInstruction"] &
32422
32595
  storefrontComponents["schemas"]["ServicePeriodAnchorInstruction"] &
@@ -32431,10 +32604,15 @@ export interface storefrontComponents {
32431
32604
  | "Saturday";
32432
32605
  /** Extended ISO-8601 format of time. */
32433
32606
  TimeIso8601Extended: string;
32434
- OrganizationLink: storefrontComponents["schemas"]["Link"] & {
32435
- /** The link type. */
32436
- rel: "organization";
32437
- };
32607
+ intelligent: storefrontComponents["schemas"]["CommonScheduleInstruction"] &
32608
+ storefrontComponents["schemas"]["CustomEventScheduleInstruction"] &
32609
+ storefrontComponents["schemas"]["InvoiceRetryScheduleInstruction"] & {
32610
+ /** The number of the units. */
32611
+ duration: number;
32612
+ unit:
32613
+ | storefrontComponents["schemas"]["TimeUnit"]
32614
+ | storefrontComponents["schemas"]["TimePluralUnit"];
32615
+ };
32438
32616
  ShippingOption: {
32439
32617
  /** The shipping rate identifier string. */
32440
32618
  id?: storefrontComponents["schemas"]["ResourceId"];
@@ -32517,8 +32695,7 @@ export interface storefrontComponents {
32517
32695
  expirationTime?: string;
32518
32696
  /** Creation date-time. */
32519
32697
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32520
- /** Latest update date-time. */
32521
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32698
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32522
32699
  };
32523
32700
  KycDocumentsLink: storefrontComponents["schemas"]["Link"] & {
32524
32701
  /** The link type. */
@@ -32566,8 +32743,7 @@ export interface storefrontComponents {
32566
32743
  requestId?: storefrontComponents["schemas"]["ResourceId"] | null;
32567
32744
  /** Creation date/time. */
32568
32745
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32569
- /** Latest update date/time. */
32570
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32746
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32571
32747
  /** Processing date/time. */
32572
32748
  processedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32573
32749
  /** The links related to resource. */
@@ -32669,8 +32845,7 @@ export interface storefrontComponents {
32669
32845
  useAsBackup: boolean;
32670
32846
  /** PayPal account created time. */
32671
32847
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32672
- /** PayPal account updated time. */
32673
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32848
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32674
32849
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
32675
32850
  };
32676
32851
  CommonKhelocardCard: {
@@ -32696,8 +32871,7 @@ export interface storefrontComponents {
32696
32871
  useAsBackup: boolean;
32697
32872
  /** The payment instrument created time. */
32698
32873
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32699
- /** The payment instrument updated time. */
32700
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32874
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32701
32875
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
32702
32876
  };
32703
32877
  AlternativePaymentMethods:
@@ -32854,15 +33028,13 @@ export interface storefrontComponents {
32854
33028
  useAsBackup: boolean;
32855
33029
  /** The payment instrument created time. */
32856
33030
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
32857
- /** The payment instrument updated time. */
32858
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33031
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
32859
33032
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
32860
33033
  };
32861
33034
  PaymentCardCreatePlain: {
32862
33035
  /** The method of payment instrument. */
32863
33036
  method: "payment-card";
32864
- /** The Customer's ID. */
32865
- customerId: storefrontComponents["schemas"]["ResourceId"];
33037
+ customerId: storefrontComponents["schemas"]["CustomerId"];
32866
33038
  /** The card PAN (Primary Account Number). */
32867
33039
  pan: string;
32868
33040
  /** Card's expiration year. */
@@ -32885,8 +33057,7 @@ export interface storefrontComponents {
32885
33057
  BBANType: storefrontComponents["schemas"]["BankAccountCreatePlain"] & {
32886
33058
  /** Payment method of the payment instrument. */
32887
33059
  method?: "ach";
32888
- /** ID of the customer who is initiating the payment. */
32889
- customerId?: storefrontComponents["schemas"]["ResourceId"];
33060
+ customerId?: storefrontComponents["schemas"]["CustomerId"];
32890
33061
  /**
32891
33062
  * Bank account number type. A valid value is Basic Bank Account Number (BBAN) or International Bank Account Number (IBAN).
32892
33063
  * BBAN object.
@@ -32911,8 +33082,7 @@ export interface storefrontComponents {
32911
33082
  IBANType: storefrontComponents["schemas"]["BankAccountCreatePlain"] & {
32912
33083
  /** Payment method of the payment instrument. */
32913
33084
  method?: "ach";
32914
- /** ID of the customer who is initiating a payment. */
32915
- customerId?: storefrontComponents["schemas"]["ResourceId"];
33085
+ customerId?: storefrontComponents["schemas"]["CustomerId"];
32916
33086
  /**
32917
33087
  * Customer's bank account number type. A valid value is a Basic Bank Account Number (BBAN) or an International Bank Account Number (IBAN).
32918
33088
  * IBAN object.
@@ -33320,8 +33490,7 @@ export interface storefrontComponents {
33320
33490
  };
33321
33491
  /** Billing portal created time. */
33322
33492
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33323
- /** Billing portal updated time. */
33324
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33493
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
33325
33494
  };
33326
33495
  CheckoutFormFixedPlan: {
33327
33496
  /** The plan identifier string. */
@@ -33423,8 +33592,7 @@ export interface storefrontComponents {
33423
33592
  };
33424
33593
  /** Checkout form created time. */
33425
33594
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33426
- /** Checkout form updated time. */
33427
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33595
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
33428
33596
  };
33429
33597
  CommonOrderPreview: {
33430
33598
  /** The website identifier string. */
@@ -33488,48 +33656,10 @@ export interface storefrontComponents {
33488
33656
  /** The purchase's total amount. */
33489
33657
  total?: number;
33490
33658
  };
33491
- /** Website settings. */
33492
- WebsiteSettings: {
33493
- /** Payment form settings. */
33494
- paymentForm?: {
33495
- /**
33496
- * Hosted payment form
33497
- * [css](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#2-use-css-property-to-override-any-styles) options.
33498
- */
33499
- css?: string;
33500
- /**
33501
- * Hosted payment form
33502
- * [theme](https://www.rebilly.com/docs/content/concepts-and-features/tutorial/customize-style-rebilly-instruments/#adjust-the-default-style) options.
33503
- */
33504
- theme?: { [key: string]: string };
33505
- /** Hosted payment form features. */
33506
- features?: {
33507
- showCoupons?: string[] | null;
33508
- };
33509
- };
33510
- };
33511
- Website: {
33512
- /** The website identifier string. */
33513
- id?: storefrontComponents["schemas"]["ResourceId"];
33514
- /** The website name. */
33515
- name: string;
33516
- /** The website domain address. */
33517
- url: string;
33518
- /** The website customer service phone number. */
33519
- servicePhone: string;
33520
- /** The website customer service email address. */
33521
- serviceEmail: string;
33522
- /** Website created time. */
33523
- createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33524
- /** Website updated time. */
33525
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33526
- customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
33527
- settings?: storefrontComponents["schemas"]["WebsiteSettings"];
33528
- /** Organization ID. */
33529
- organizationId?: storefrontComponents["schemas"]["ResourceId"];
33530
- /** The links related to resource. */
33531
- _links?: (Partial<storefrontComponents["schemas"]["SelfLink"]> &
33532
- Partial<storefrontComponents["schemas"]["OrganizationLink"]>)[];
33659
+ InstrumentReference: {
33660
+ method: storefrontComponents["schemas"]["PaymentMethod"];
33661
+ /** The payment instrument ID. */
33662
+ paymentInstrumentId?: storefrontComponents["schemas"]["ResourceId"];
33533
33663
  };
33534
33664
  Account: {
33535
33665
  /** The account ID. */
@@ -33551,8 +33681,7 @@ export interface storefrontComponents {
33551
33681
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
33552
33682
  /** The customer created time. */
33553
33683
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33554
- /** The customer updated time. */
33555
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33684
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
33556
33685
  /** The links related to resource. */
33557
33686
  _links?: Partial<storefrontComponents["schemas"]["SelfLink"]>[];
33558
33687
  };
@@ -33570,6 +33699,7 @@ export interface storefrontComponents {
33570
33699
  _links?: Partial<storefrontComponents["schemas"]["SelfLink"]>[];
33571
33700
  };
33572
33701
  StorefrontTransaction: storefrontComponents["schemas"]["CommonTransaction"] & {
33702
+ paymentInstrument?: storefrontComponents["schemas"]["InstrumentReference"];
33573
33703
  /** The URL to redirect the end-customer when transaction `status` is `waiting-approval` or `offsite`. */
33574
33704
  approvalUrl?: string;
33575
33705
  /** The session's token used for authentication. It would allow to visit created order, invoice and transaction. */
@@ -33631,8 +33761,7 @@ export interface storefrontComponents {
33631
33761
  token?: string;
33632
33762
  /** Session created time. */
33633
33763
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33634
- /** Session updated time. */
33635
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33764
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
33636
33765
  /** Session expired time. Defaults to one hour. */
33637
33766
  expiredTime?: string;
33638
33767
  };
@@ -33640,8 +33769,7 @@ export interface storefrontComponents {
33640
33769
  customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
33641
33770
  /** Order created time. */
33642
33771
  createdTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33643
- /** Order updated time. */
33644
- updatedTime?: storefrontComponents["schemas"]["ServerTimestamp"];
33772
+ updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
33645
33773
  /** The links related to resource. */
33646
33774
  _links?: Partial<storefrontComponents["schemas"]["SelfLink"]>[];
33647
33775
  };
@@ -33939,6 +34067,8 @@ export interface storefrontComponents {
33939
34067
  "Pagination-Limit"?: number;
33940
34068
  /** Pagination offset. */
33941
34069
  "Pagination-Offset"?: number;
34070
+ /** The location of the related resource. */
34071
+ Location?: string;
33942
34072
  };
33943
34073
  }
33944
34074
 
@@ -34037,6 +34167,7 @@ export interface operations {
34037
34167
  responses: {
34038
34168
  /** Password was reset successfuly. */
34039
34169
  201: {
34170
+ headers: {};
34040
34171
  content: {
34041
34172
  "application/json": storefrontComponents["schemas"]["Account"];
34042
34173
  };
@@ -34188,6 +34319,7 @@ export interface operations {
34188
34319
  responses: {
34189
34320
  /** Kyc document was created. */
34190
34321
  201: {
34322
+ headers: {};
34191
34323
  content: {
34192
34324
  "application/json": storefrontComponents["schemas"]["StorefrontKycDocument"];
34193
34325
  };
@@ -34283,6 +34415,7 @@ export interface operations {
34283
34415
  responses: {
34284
34416
  /** Account logged in. */
34285
34417
  201: {
34418
+ headers: {};
34286
34419
  content: {
34287
34420
  "application/json": storefrontComponents["schemas"]["StorefrontCustomerJWT"];
34288
34421
  };
@@ -34393,6 +34526,7 @@ export interface operations {
34393
34526
  responses: {
34394
34527
  /** Order was canceled. */
34395
34528
  201: {
34529
+ headers: {};
34396
34530
  content: {
34397
34531
  "application/json": storefrontComponents["schemas"]["StorefrontOrder"];
34398
34532
  };
@@ -34421,6 +34555,7 @@ export interface operations {
34421
34555
  };
34422
34556
  /** Transaction was updated. */
34423
34557
  201: {
34558
+ headers: {};
34424
34559
  content: {
34425
34560
  "application/json": storefrontComponents["schemas"]["StorefrontTransaction"];
34426
34561
  };
@@ -34474,6 +34609,7 @@ export interface operations {
34474
34609
  responses: {
34475
34610
  /** Payment instrument was created. */
34476
34611
  201: {
34612
+ headers: {};
34477
34613
  content: {
34478
34614
  "application/json": storefrontComponents["schemas"]["StorefrontPaymentInstrument"];
34479
34615
  };
@@ -34548,6 +34684,7 @@ export interface operations {
34548
34684
  responses: {
34549
34685
  /** Deactivation successful. */
34550
34686
  201: {
34687
+ headers: {};
34551
34688
  content: {
34552
34689
  "application/json": storefrontComponents["schemas"]["StorefrontPaymentInstrument"];
34553
34690
  };
@@ -34599,6 +34736,7 @@ export interface operations {
34599
34736
  responses: {
34600
34737
  /** Setup transaction was created. */
34601
34738
  201: {
34739
+ headers: {};
34602
34740
  content: {
34603
34741
  "application/json": storefrontComponents["schemas"]["StorefrontTransaction"];
34604
34742
  };
@@ -34737,6 +34875,7 @@ export interface operations {
34737
34875
  responses: {
34738
34876
  /** Order was created. */
34739
34877
  201: {
34878
+ headers: {};
34740
34879
  content: {
34741
34880
  "application/json": storefrontComponents["schemas"]["Purchase"];
34742
34881
  };
@@ -34815,6 +34954,7 @@ export interface operations {
34815
34954
  responses: {
34816
34955
  /** Account registered. */
34817
34956
  201: {
34957
+ headers: {};
34818
34958
  content: {
34819
34959
  "application/json": storefrontComponents["schemas"]["Account"];
34820
34960
  };
@@ -34976,6 +35116,13 @@ export interface reportsPaths {
34976
35116
  /** Retrieve a future renewals report. */
34977
35117
  get: operations["GetFutureRenewalReport"];
34978
35118
  };
35119
+ "/reports/journal": {
35120
+ /**
35121
+ * Retrieve a journal report which reflects a per-account revenue.
35122
+ * It is a more-granular step of a revenue waterfall report.
35123
+ */
35124
+ get: operations["GetJournalReport"];
35125
+ };
34979
35126
  "/reports/kyc-acceptance-summary": {
34980
35127
  /** Retrieve a KYC acceptance summary report. */
34981
35128
  get: operations["GetKycAcceptanceSummaryReport"];
@@ -35045,14 +35192,16 @@ export interface reportsPaths {
35045
35192
 
35046
35193
  export interface reportsComponents {
35047
35194
  schemas: {
35048
- Link: {
35049
- /** The link URL. */
35050
- href: string;
35051
- };
35052
35195
  /** The resource ID. Defaults to UUID v4. */
35053
35196
  ResourceId: string;
35054
35197
  /** Read-only timestamp, automatically assigned on back-end. */
35055
35198
  ServerTimestamp: string;
35199
+ /** Read-only timestamp updates when the resource is updated. */
35200
+ UpdatedTime: string;
35201
+ Link: {
35202
+ /** The link URL. */
35203
+ href: string;
35204
+ };
35056
35205
  /** The Problem Details JSON Object [[RFC7807](https://tools.ietf.org/html/rfc7807)]. */
35057
35206
  BaseProblem: {
35058
35207
  /** A URI reference [[RFC3986](https://tools.ietf.org/html/rfc3986)] that identifies the problem type. It should provide human-readable documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". */
@@ -35234,8 +35383,7 @@ export interface reportsComponents {
35234
35383
  scheduledTime?: reportsComponents["schemas"]["ServerTimestamp"];
35235
35384
  /** The time the data export was requested. */
35236
35385
  createdTime?: reportsComponents["schemas"]["ServerTimestamp"];
35237
- /** Data export updated time. */
35238
- updatedTime?: reportsComponents["schemas"]["ServerTimestamp"];
35386
+ updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
35239
35387
  /** Status of export request. */
35240
35388
  status?: "pending" | "queued" | "processing" | "completed";
35241
35389
  /** The links related to resource. */
@@ -35490,6 +35638,35 @@ export interface reportsComponents {
35490
35638
  }[];
35491
35639
  }[];
35492
35640
  };
35641
+ ReportJournal: {
35642
+ /** The report data is grouped by the aggregation field. */
35643
+ aggregationField?: "product.accountingCode" | "product.id" | "plan.id";
35644
+ currency?: reportsComponents["schemas"]["CurrencyCode"];
35645
+ /**
35646
+ * A year and month from which revenue is booked.
35647
+ * If empty then booked revenue starts from the first booked amount.
35648
+ */
35649
+ bookedFrom?: string;
35650
+ /**
35651
+ * A year and month in which revenue is booked until.
35652
+ * If empty then booked revenue is taken until the most recently booked amount.
35653
+ */
35654
+ bookedTo?: string;
35655
+ /** A year and month in which revenue was recognized. */
35656
+ recognizedAt?: string;
35657
+ data?: {
35658
+ /** The aggregation field value. */
35659
+ aggregationValue?: string;
35660
+ /** Month in which revenue is booked. */
35661
+ bookedMonth?: string;
35662
+ /** Revenue amount which is booked for recognition. */
35663
+ bookedAmount?: number;
35664
+ /** Recognized revenue amount. */
35665
+ recognizedAmount?: number;
35666
+ /** Remaining revenue amount to be recognized. */
35667
+ remainingAmount?: number;
35668
+ }[];
35669
+ };
35493
35670
  ReportKycRejections: {
35494
35671
  data?: {
35495
35672
  documentType?: reportsComponents["schemas"]["KycDocumentTypes"];
@@ -35618,7 +35795,7 @@ export interface reportsComponents {
35618
35795
  issuedMonth?: string;
35619
35796
  /** The revenue amount booked at issue month. */
35620
35797
  booked?: number;
35621
- /** The revenue amount regognized up to `recognizedTo` month. */
35798
+ /** Recognized revenue amount up to, and including, the `recognizedTo` month. */
35622
35799
  recognized?: number;
35623
35800
  /** The revenue amount remaining to be recognized after `recognizedTo` month. */
35624
35801
  remaining?: number;
@@ -35808,6 +35985,8 @@ export interface reportsComponents {
35808
35985
  "Pagination-Limit"?: number;
35809
35986
  /** Pagination offset. */
35810
35987
  "Pagination-Offset"?: number;
35988
+ /** The location of the related resource. */
35989
+ Location?: string;
35811
35990
  };
35812
35991
  }
35813
35992
 
@@ -35887,6 +36066,7 @@ export interface operations {
35887
36066
  responses: {
35888
36067
  /** Data export request received. */
35889
36068
  201: {
36069
+ headers: {};
35890
36070
  content: {
35891
36071
  "application/json": reportsComponents["schemas"]["DataExport"];
35892
36072
  };
@@ -35951,6 +36131,7 @@ export interface operations {
35951
36131
  };
35952
36132
  /** Data Export was updated. */
35953
36133
  201: {
36134
+ headers: {};
35954
36135
  content: {
35955
36136
  "application/json": reportsComponents["schemas"]["DataExport"];
35956
36137
  };
@@ -36277,6 +36458,53 @@ export interface operations {
36277
36458
  403: reportsComponents["responses"]["Forbidden"];
36278
36459
  };
36279
36460
  };
36461
+ /**
36462
+ * Retrieve a journal report which reflects a per-account revenue.
36463
+ * It is a more-granular step of a revenue waterfall report.
36464
+ */
36465
+ GetJournalReport: {
36466
+ parameters: {
36467
+ query: {
36468
+ /** Revenue currency. */
36469
+ currency: reportsComponents["schemas"]["CurrencyCode"];
36470
+ /**
36471
+ * A year and month from which revenue is booked.
36472
+ * If omitted then booked revenue starts from the first booked amount.
36473
+ */
36474
+ bookedFrom?: string;
36475
+ /**
36476
+ * A year and month in which revenue is booked until.
36477
+ * If omitted then booked revenue is taken until the most recently booked amount.
36478
+ */
36479
+ bookedTo?: string;
36480
+ /** A year and month in which revenue was recognized. */
36481
+ recognizedAt: string;
36482
+ /** Report aggregation field. */
36483
+ aggregationField: "product.accountingCode" | "product.id" | "plan.id";
36484
+ /** The collection items limit. */
36485
+ limit?: reportsComponents["parameters"]["collectionLimit"];
36486
+ /** The collection items offset. */
36487
+ offset?: reportsComponents["parameters"]["collectionOffset"];
36488
+ /**
36489
+ * The collection items filter requires a special format.
36490
+ * Use "," for multiple allowed values. Use ";" for multiple fields.
36491
+ * See the [filter guide](https://api-reference.rebilly.com/#section/Using-filter-with-collections) for more options and examples about this format.
36492
+ */
36493
+ filter?: reportsComponents["parameters"]["collectionFilter"];
36494
+ };
36495
+ };
36496
+ responses: {
36497
+ /** Report successfully retrieved. */
36498
+ 200: {
36499
+ headers: {};
36500
+ content: {
36501
+ "application/json": reportsComponents["schemas"]["ReportJournal"];
36502
+ };
36503
+ };
36504
+ 401: reportsComponents["responses"]["Unauthorized"];
36505
+ 403: reportsComponents["responses"]["Forbidden"];
36506
+ };
36507
+ };
36280
36508
  /** Retrieve a KYC acceptance summary report. */
36281
36509
  GetKycAcceptanceSummaryReport: {
36282
36510
  parameters: {
@@ -37763,9 +37991,8 @@ declare module "resources/files-resource" {
37763
37991
  updatedTime?: string;
37764
37992
  isPublic?: boolean;
37765
37993
  _links?: (Partial<{
37766
- href: string;
37767
- } & {
37768
37994
  rel: "self";
37995
+ href: string;
37769
37996
  }> & Partial<{
37770
37997
  href: string;
37771
37998
  } & {
@@ -39468,9 +39695,8 @@ declare module "resources/api-instance" {
39468
39695
  updatedTime?: string;
39469
39696
  isPublic?: boolean;
39470
39697
  _links?: (Partial<{
39471
- href: string;
39472
- } & {
39473
39698
  rel: "self";
39699
+ href: string;
39474
39700
  }> & Partial<{
39475
39701
  href: string;
39476
39702
  } & {
@@ -40492,6 +40718,16 @@ declare module "resources/experimental/reports-resource" {
40492
40718
  limit?: any;
40493
40719
  offset?: any;
40494
40720
  }): rebilly.GetFutureRenewalReportResponsePromise;
40721
+ getJournal({ currency, bookedFrom, bookedTo, recognizedAt, aggregationField, limit, offset, filter, }: {
40722
+ currency: any;
40723
+ bookedFrom?: any;
40724
+ bookedTo?: any;
40725
+ recognizedAt: any;
40726
+ aggregationField: any;
40727
+ limit?: any;
40728
+ offset?: any;
40729
+ filter?: any;
40730
+ }): rebilly.GetJournalReportResponsePromise;
40495
40731
  getKycAcceptanceSummary({ periodStart, periodEnd }: {
40496
40732
  periodStart: any;
40497
40733
  periodEnd: any;
@@ -40723,6 +40959,16 @@ declare module "resources/experimental/experimental-resources" {
40723
40959
  limit?: any;
40724
40960
  offset?: any;
40725
40961
  }): rebilly.GetFutureRenewalReportResponsePromise;
40962
+ getJournal({ currency, bookedFrom, bookedTo, recognizedAt, aggregationField, limit, offset, filter, }: {
40963
+ currency: any;
40964
+ bookedFrom?: any;
40965
+ bookedTo?: any;
40966
+ recognizedAt: any;
40967
+ aggregationField: any;
40968
+ limit?: any;
40969
+ offset?: any;
40970
+ filter?: any;
40971
+ }): rebilly.GetJournalReportResponsePromise;
40726
40972
  getKycAcceptanceSummary({ periodStart, periodEnd }: {
40727
40973
  periodStart: any;
40728
40974
  periodEnd: any;