rebilly-js-sdk 62.246.3 → 62.247.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,3 +1,3 @@
1
- ## 62.246.3 (2026-11-03)
1
+ ## 62.247.1 (2026-11-04)
2
2
 
3
3
  This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.
@@ -4647,7 +4647,13 @@ export interface corePaths {
4647
4647
  };
4648
4648
  };
4649
4649
  "/api-keys": {
4650
- /** Retrieve a list of API keys. */
4650
+ /**
4651
+ * Retrieves a list of API keys.
4652
+ *
4653
+ * To retrieve secret API keys that are not expired and have no `allowedIps` restrictions,
4654
+ * so they can be used from any IP address, use `filter=usableFromAnyIp:true`.
4655
+ * To retrieve all other API keys, use `filter=usableFromAnyIp:false`.
4656
+ */
4651
4657
  get: operations["GetApiKeyCollection"];
4652
4658
  /**
4653
4659
  * Creates an API key for the authenticated user.
@@ -5639,13 +5645,16 @@ export interface corePaths {
5639
5645
  * For `add`, `remove`, and `move`, the operation is atomic.
5640
5646
  * If the operation cannot add, remove, or move a specified payout request,
5641
5647
  * the operation returns a `409` response and changes no batch membership.
5648
+ *
5642
5649
  * For `block` and `unblock`, if the request includes `payoutRequestIds`
5643
5650
  * and a specified payout request is not associated with this batch,
5644
5651
  * the operation returns a `409` response and changes no payout request.
5645
5652
  * For the other types, each payout request is checked independently.
5646
5653
  * Payout requests that do not qualify for the action are skipped.
5654
+ *
5647
5655
  * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
5648
5656
  * If queueing fails, no allocation is queued and the operation returns an error.
5657
+ *
5649
5658
  * The operation completes before the response returns.
5650
5659
  * If the batch does not exist, the operation returns a `422` response.
5651
5660
  */
@@ -5775,12 +5784,15 @@ export interface corePaths {
5775
5784
  * If the session of a user has not passed MFA, other operations respond with `403` and `error` is `mfa_required`.
5776
5785
  * Only owners and administrators who are signed in to the Rebilly UI can change this setting.
5777
5786
  * This setting does not apply to API keys, and a request that uses an API key cannot change this setting.
5787
+ *
5778
5788
  * To turn on `requireMfa`, the session must have passed MFA.
5779
5789
  * If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
5780
5790
  * If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
5791
+ *
5781
5792
  * If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
5782
5793
  * If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
5783
5794
  * If the list does not include the IP address of the caller, the response is `422`.
5795
+ *
5784
5796
  * Settings apply to the current environment only: live and sandbox are configured separately.
5785
5797
  */
5786
5798
  put: operations["PutSecuritySettings"];
@@ -5874,6 +5886,12 @@ export interface corePaths {
5874
5886
  * User objects of Rebilly staff do not include `mfaEnabled`.
5875
5887
  * The totals are the same as those returned by the [Retrieve security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings) operation.
5876
5888
  * If the MFA status is temporarily unavailable, the response is `503` and `error` is `mfa_status_unavailable`.
5889
+ *
5890
+ * To retrieve users of the organization who can sign in only from allowed IP addresses, with `allowedIps` configured for the user or one of their roles, use `filter=hasAllowedIps:true`.
5891
+ * To retrieve users who have no `allowedIps` configured for the user or any of their roles, use `filter=hasAllowedIps:false`.
5892
+ * The `hasAllowedIps` filter applies only when listing users of an organization.
5893
+ * It does not include allowed IP addresses configured in the [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings).
5894
+ * Inactive users and Rebilly staff are excluded from the `hasAllowedIps` filter.
5877
5895
  */
5878
5896
  get: operations["GetUserCollection"];
5879
5897
  /** Creates a user. */
@@ -8228,6 +8246,8 @@ export interface coreComponents {
8228
8246
  * Specifies if the file is available publicly without authentication.
8229
8247
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
8230
8248
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
8249
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
8250
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
8231
8251
  */
8232
8252
  isPublic?: boolean;
8233
8253
  /** Related links. */
@@ -8245,6 +8265,8 @@ export interface coreComponents {
8245
8265
  * Specifies if the file is available publicly without authentication.
8246
8266
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
8247
8267
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
8268
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
8269
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
8248
8270
  */
8249
8271
  isPublic?: boolean;
8250
8272
  /** File name used for downloading. */
@@ -8270,6 +8292,8 @@ export interface coreComponents {
8270
8292
  * Specifies if the file is available publicly without authentication.
8271
8293
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
8272
8294
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
8295
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
8296
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
8273
8297
  */
8274
8298
  isPublic?: boolean;
8275
8299
  /** File name used for downloading. */
@@ -12777,10 +12801,12 @@ export interface coreComponents {
12777
12801
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
12778
12802
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
12779
12803
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
12804
+ *
12780
12805
  * The quantity limit applies to the larger of the reported and billed quantity.
12781
12806
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
12782
12807
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
12783
12808
  * The amount limit applies to the billed amount.
12809
+ *
12784
12810
  * To notify the customer, a webhook and notification can be configured for this event.
12785
12811
  * This field is useful for accounting and customer success purposes.
12786
12812
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -12797,6 +12823,7 @@ export interface coreComponents {
12797
12823
  * When a soft limit is reached,
12798
12824
  * a customer may receive a notification
12799
12825
  * but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
12826
+ *
12800
12827
  * When the reported usage reaches the configured limit,
12801
12828
  * a specific event is triggered.
12802
12829
  * To notify the customer in the merchant system,
@@ -12805,6 +12832,7 @@ export interface coreComponents {
12805
12832
  * When the total usage reaches the hard limit quantity,
12806
12833
  * or amount values,
12807
12834
  * metered billing plan usages can no longer be reported.
12835
+ *
12808
12836
  * Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
12809
12837
  * A `quantity` value below the minimum billable quantity is invalid.
12810
12838
  * An `amount` value below the minimum billable amount is invalid.
@@ -16535,6 +16563,7 @@ export interface coreComponents {
16535
16563
  /**
16536
16564
  * Custom domain for the billing portal.
16537
16565
  * The default domain is: `portal.secure-payments.app`.
16566
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
16538
16567
  */
16539
16568
  customDomain?: string | null;
16540
16569
  /** Features that can be enabled for the billing portal. */
@@ -17233,7 +17262,10 @@ export interface coreComponents {
17233
17262
  /** ID of the checkout form. */
17234
17263
  id?: string;
17235
17264
  websiteId: coreComponents["schemas"]["WebsiteId"];
17236
- /** Custom domain for the checkout form. */
17265
+ /**
17266
+ * Custom domain for the checkout form.
17267
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
17268
+ */
17237
17269
  customDomain?: string | null;
17238
17270
  /**
17239
17271
  * List of plans that are applied to a customer order by default.
@@ -17859,8 +17891,24 @@ export interface coreComponents {
17859
17891
  id?: string;
17860
17892
  /** Fully qualified domain name. */
17861
17893
  domain: string;
17894
+ /**
17895
+ * Purpose of the custom domain.
17896
+ * Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
17897
+ * and `media` for the public files of the organization.
17898
+ * Each organization has at most one custom domain with the `purpose` field set to `media`.
17899
+ */
17900
+ purpose?: "hosted-pages" | "media";
17862
17901
  /** True if the domain is verified by Rebilly. */
17863
17902
  isVerified?: boolean;
17903
+ /**
17904
+ * Reason why the media domain cannot be verified,
17905
+ * or why a verified media domain fails its hourly check.
17906
+ * A verified media domain keeps `isVerified` set to `true` while it fails the check.
17907
+ * This value is `null` if verification is pending, or if the custom domain has no failure.
17908
+ */
17909
+ verificationFailure?:
17910
+ | ("certificate-failed" | "hostname-taken" | "cname-missing")
17911
+ | null;
17864
17912
  createdTime?: coreComponents["schemas"]["CreatedTime"];
17865
17913
  updatedTime?: coreComponents["schemas"]["UpdatedTime"];
17866
17914
  _links?: coreComponents["schemas"]["SelfLink"];
@@ -24172,6 +24220,11 @@ export interface coreComponents {
24172
24220
  description?: string | null;
24173
24221
  acl: coreComponents["schemas"]["Acl"];
24174
24222
  allowedIps?: coreComponents["schemas"]["AllowedIps"];
24223
+ /**
24224
+ * IP addresses specified in `allowedIps` for this role and any roles included in it.
24225
+ * This value is `null` if no allowed IP addresses are configured for any of these roles.
24226
+ */
24227
+ computedAllowedIps?: string[] | null;
24175
24228
  /**
24176
24229
  * List of role IDs where this role is used.
24177
24230
  * For example, a role called `user` may be used in the `admin` and `manager` roles.
@@ -24466,6 +24519,14 @@ export interface coreComponents {
24466
24519
  */
24467
24520
  roleIds?: string[];
24468
24521
  allowedIps?: coreComponents["schemas"]["AllowedIps"];
24522
+ /**
24523
+ * IP addresses specified in `allowedIps` for the user,
24524
+ * the roles assigned to the user,
24525
+ * and any roles included in those roles.
24526
+ * This value is `null` if no allowed IP addresses are configured for any of them.
24527
+ * This value is also `null` when a Rebilly admin retrieves their own user.
24528
+ */
24529
+ computedAllowedIps?: string[] | null;
24469
24530
  /**
24470
24531
  * Specifies if the user has multi-factor authentication (MFA) set up.
24471
24532
  * This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
@@ -28820,10 +28881,12 @@ export interface coreComponents {
28820
28881
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
28821
28882
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
28822
28883
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
28884
+ *
28823
28885
  * The quantity limit applies to the larger of the reported and billed quantity.
28824
28886
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
28825
28887
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
28826
28888
  * The amount limit applies to the billed amount.
28889
+ *
28827
28890
  * To notify the customer, a webhook and notification can be configured for this event.
28828
28891
  * This field is useful for accounting and customer success purposes.
28829
28892
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -30329,10 +30392,12 @@ export interface coreComponents {
30329
30392
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
30330
30393
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
30331
30394
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
30395
+ *
30332
30396
  * The quantity limit applies to the larger of the reported and billed quantity.
30333
30397
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
30334
30398
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
30335
30399
  * The amount limit applies to the billed amount.
30400
+ *
30336
30401
  * To notify the customer, a webhook and notification can be configured for this event.
30337
30402
  * This field is useful for accounting and customer success purposes.
30338
30403
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -40344,7 +40409,13 @@ export interface operations {
40344
40409
  };
40345
40410
  };
40346
40411
  };
40347
- /** Retrieve a list of API keys. */
40412
+ /**
40413
+ * Retrieves a list of API keys.
40414
+ *
40415
+ * To retrieve secret API keys that are not expired and have no `allowedIps` restrictions,
40416
+ * so they can be used from any IP address, use `filter=usableFromAnyIp:true`.
40417
+ * To retrieve all other API keys, use `filter=usableFromAnyIp:false`.
40418
+ */
40348
40419
  GetApiKeyCollection: {
40349
40420
  parameters: {
40350
40421
  query: {
@@ -44309,13 +44380,16 @@ export interface operations {
44309
44380
  * For `add`, `remove`, and `move`, the operation is atomic.
44310
44381
  * If the operation cannot add, remove, or move a specified payout request,
44311
44382
  * the operation returns a `409` response and changes no batch membership.
44383
+ *
44312
44384
  * For `block` and `unblock`, if the request includes `payoutRequestIds`
44313
44385
  * and a specified payout request is not associated with this batch,
44314
44386
  * the operation returns a `409` response and changes no payout request.
44315
44387
  * For the other types, each payout request is checked independently.
44316
44388
  * Payout requests that do not qualify for the action are skipped.
44389
+ *
44317
44390
  * For `process`, allocations that do not qualify are skipped, and allocations that qualify are queued together.
44318
44391
  * If queueing fails, no allocation is queued and the operation returns an error.
44392
+ *
44319
44393
  * The operation completes before the response returns.
44320
44394
  * If the batch does not exist, the operation returns a `422` response.
44321
44395
  */
@@ -44929,12 +45003,15 @@ export interface operations {
44929
45003
  * If the session of a user has not passed MFA, other operations respond with `403` and `error` is `mfa_required`.
44930
45004
  * Only owners and administrators who are signed in to the Rebilly UI can change this setting.
44931
45005
  * This setting does not apply to API keys, and a request that uses an API key cannot change this setting.
45006
+ *
44932
45007
  * To turn on `requireMfa`, the session must have passed MFA.
44933
45008
  * If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
44934
45009
  * If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
45010
+ *
44935
45011
  * If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
44936
45012
  * If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
44937
45013
  * If the list does not include the IP address of the caller, the response is `422`.
45014
+ *
44938
45015
  * Settings apply to the current environment only: live and sandbox are configured separately.
44939
45016
  */
44940
45017
  PutSecuritySettings: {
@@ -45258,6 +45335,12 @@ export interface operations {
45258
45335
  * User objects of Rebilly staff do not include `mfaEnabled`.
45259
45336
  * The totals are the same as those returned by the [Retrieve security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings) operation.
45260
45337
  * If the MFA status is temporarily unavailable, the response is `503` and `error` is `mfa_status_unavailable`.
45338
+ *
45339
+ * To retrieve users of the organization who can sign in only from allowed IP addresses, with `allowedIps` configured for the user or one of their roles, use `filter=hasAllowedIps:true`.
45340
+ * To retrieve users who have no `allowedIps` configured for the user or any of their roles, use `filter=hasAllowedIps:false`.
45341
+ * The `hasAllowedIps` filter applies only when listing users of an organization.
45342
+ * It does not include allowed IP addresses configured in the [security settings](https://www.rebilly.com/catalog/all/organizations/getsecuritysettings).
45343
+ * Inactive users and Rebilly staff are excluded from the `hasAllowedIps` filter.
45261
45344
  */
45262
45345
  GetUserCollection: {
45263
45346
  parameters: {
@@ -48915,6 +48998,8 @@ export interface storefrontComponents {
48915
48998
  * Specifies if the file is available publicly without authentication.
48916
48999
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
48917
49000
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
49001
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
49002
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
48918
49003
  */
48919
49004
  isPublic?: boolean;
48920
49005
  /** Related links. */
@@ -48932,6 +49017,8 @@ export interface storefrontComponents {
48932
49017
  * Specifies if the file is available publicly without authentication.
48933
49018
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
48934
49019
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
49020
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
49021
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
48935
49022
  */
48936
49023
  isPublic?: boolean;
48937
49024
  /** File name used for downloading. */
@@ -48957,6 +49044,8 @@ export interface storefrontComponents {
48957
49044
  * Specifies if the file is available publicly without authentication.
48958
49045
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
48959
49046
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
49047
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
49048
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
48960
49049
  */
48961
49050
  isPublic?: boolean;
48962
49051
  /** File name used for downloading. */
@@ -53464,10 +53553,12 @@ export interface storefrontComponents {
53464
53553
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
53465
53554
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
53466
53555
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
53556
+ *
53467
53557
  * The quantity limit applies to the larger of the reported and billed quantity.
53468
53558
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
53469
53559
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
53470
53560
  * The amount limit applies to the billed amount.
53561
+ *
53471
53562
  * To notify the customer, a webhook and notification can be configured for this event.
53472
53563
  * This field is useful for accounting and customer success purposes.
53473
53564
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -53484,6 +53575,7 @@ export interface storefrontComponents {
53484
53575
  * When a soft limit is reached,
53485
53576
  * a customer may receive a notification
53486
53577
  * but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
53578
+ *
53487
53579
  * When the reported usage reaches the configured limit,
53488
53580
  * a specific event is triggered.
53489
53581
  * To notify the customer in the merchant system,
@@ -53492,6 +53584,7 @@ export interface storefrontComponents {
53492
53584
  * When the total usage reaches the hard limit quantity,
53493
53585
  * or amount values,
53494
53586
  * metered billing plan usages can no longer be reported.
53587
+ *
53495
53588
  * Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
53496
53589
  * A `quantity` value below the minimum billable quantity is invalid.
53497
53590
  * An `amount` value below the minimum billable amount is invalid.
@@ -57222,6 +57315,7 @@ export interface storefrontComponents {
57222
57315
  /**
57223
57316
  * Custom domain for the billing portal.
57224
57317
  * The default domain is: `portal.secure-payments.app`.
57318
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
57225
57319
  */
57226
57320
  customDomain?: string | null;
57227
57321
  /** Features that can be enabled for the billing portal. */
@@ -57920,7 +58014,10 @@ export interface storefrontComponents {
57920
58014
  /** ID of the checkout form. */
57921
58015
  id?: string;
57922
58016
  websiteId: storefrontComponents["schemas"]["WebsiteId"];
57923
- /** Custom domain for the checkout form. */
58017
+ /**
58018
+ * Custom domain for the checkout form.
58019
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
58020
+ */
57924
58021
  customDomain?: string | null;
57925
58022
  /**
57926
58023
  * List of plans that are applied to a customer order by default.
@@ -58546,8 +58643,24 @@ export interface storefrontComponents {
58546
58643
  id?: string;
58547
58644
  /** Fully qualified domain name. */
58548
58645
  domain: string;
58646
+ /**
58647
+ * Purpose of the custom domain.
58648
+ * Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
58649
+ * and `media` for the public files of the organization.
58650
+ * Each organization has at most one custom domain with the `purpose` field set to `media`.
58651
+ */
58652
+ purpose?: "hosted-pages" | "media";
58549
58653
  /** True if the domain is verified by Rebilly. */
58550
58654
  isVerified?: boolean;
58655
+ /**
58656
+ * Reason why the media domain cannot be verified,
58657
+ * or why a verified media domain fails its hourly check.
58658
+ * A verified media domain keeps `isVerified` set to `true` while it fails the check.
58659
+ * This value is `null` if verification is pending, or if the custom domain has no failure.
58660
+ */
58661
+ verificationFailure?:
58662
+ | ("certificate-failed" | "hostname-taken" | "cname-missing")
58663
+ | null;
58551
58664
  createdTime?: storefrontComponents["schemas"]["CreatedTime"];
58552
58665
  updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
58553
58666
  _links?: storefrontComponents["schemas"]["SelfLink"];
@@ -64859,6 +64972,11 @@ export interface storefrontComponents {
64859
64972
  description?: string | null;
64860
64973
  acl: storefrontComponents["schemas"]["Acl"];
64861
64974
  allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
64975
+ /**
64976
+ * IP addresses specified in `allowedIps` for this role and any roles included in it.
64977
+ * This value is `null` if no allowed IP addresses are configured for any of these roles.
64978
+ */
64979
+ computedAllowedIps?: string[] | null;
64862
64980
  /**
64863
64981
  * List of role IDs where this role is used.
64864
64982
  * For example, a role called `user` may be used in the `admin` and `manager` roles.
@@ -65153,6 +65271,14 @@ export interface storefrontComponents {
65153
65271
  */
65154
65272
  roleIds?: string[];
65155
65273
  allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
65274
+ /**
65275
+ * IP addresses specified in `allowedIps` for the user,
65276
+ * the roles assigned to the user,
65277
+ * and any roles included in those roles.
65278
+ * This value is `null` if no allowed IP addresses are configured for any of them.
65279
+ * This value is also `null` when a Rebilly admin retrieves their own user.
65280
+ */
65281
+ computedAllowedIps?: string[] | null;
65156
65282
  /**
65157
65283
  * Specifies if the user has multi-factor authentication (MFA) set up.
65158
65284
  * This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
@@ -69507,10 +69633,12 @@ export interface storefrontComponents {
69507
69633
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
69508
69634
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
69509
69635
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
69636
+ *
69510
69637
  * The quantity limit applies to the larger of the reported and billed quantity.
69511
69638
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
69512
69639
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
69513
69640
  * The amount limit applies to the billed amount.
69641
+ *
69514
69642
  * To notify the customer, a webhook and notification can be configured for this event.
69515
69643
  * This field is useful for accounting and customer success purposes.
69516
69644
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -71016,10 +71144,12 @@ export interface storefrontComponents {
71016
71144
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
71017
71145
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
71018
71146
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
71147
+ *
71019
71148
  * The quantity limit applies to the larger of the reported and billed quantity.
71020
71149
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
71021
71150
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
71022
71151
  * The amount limit applies to the billed amount.
71152
+ *
71023
71153
  * To notify the customer, a webhook and notification can be configured for this event.
71024
71154
  * This field is useful for accounting and customer success purposes.
71025
71155
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -76777,6 +76907,8 @@ export interface reportsComponents {
76777
76907
  * Specifies if the file is available publicly without authentication.
76778
76908
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
76779
76909
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
76910
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
76911
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
76780
76912
  */
76781
76913
  isPublic?: boolean;
76782
76914
  /** Related links. */
@@ -76794,6 +76926,8 @@ export interface reportsComponents {
76794
76926
  * Specifies if the file is available publicly without authentication.
76795
76927
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
76796
76928
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
76929
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
76930
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
76797
76931
  */
76798
76932
  isPublic?: boolean;
76799
76933
  /** File name used for downloading. */
@@ -76819,6 +76953,8 @@ export interface reportsComponents {
76819
76953
  * Specifies if the file is available publicly without authentication.
76820
76954
  * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
76821
76955
  * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
76956
+ * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
76957
+ * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
76822
76958
  */
76823
76959
  isPublic?: boolean;
76824
76960
  /** File name used for downloading. */
@@ -81326,10 +81462,12 @@ export interface reportsComponents {
81326
81462
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
81327
81463
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
81328
81464
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
81465
+ *
81329
81466
  * The quantity limit applies to the larger of the reported and billed quantity.
81330
81467
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
81331
81468
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
81332
81469
  * The amount limit applies to the billed amount.
81470
+ *
81333
81471
  * To notify the customer, a webhook and notification can be configured for this event.
81334
81472
  * This field is useful for accounting and customer success purposes.
81335
81473
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -81346,6 +81484,7 @@ export interface reportsComponents {
81346
81484
  * When a soft limit is reached,
81347
81485
  * a customer may receive a notification
81348
81486
  * but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
81487
+ *
81349
81488
  * When the reported usage reaches the configured limit,
81350
81489
  * a specific event is triggered.
81351
81490
  * To notify the customer in the merchant system,
@@ -81354,6 +81493,7 @@ export interface reportsComponents {
81354
81493
  * When the total usage reaches the hard limit quantity,
81355
81494
  * or amount values,
81356
81495
  * metered billing plan usages can no longer be reported.
81496
+ *
81357
81497
  * Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
81358
81498
  * A `quantity` value below the minimum billable quantity is invalid.
81359
81499
  * An `amount` value below the minimum billable amount is invalid.
@@ -85084,6 +85224,7 @@ export interface reportsComponents {
85084
85224
  /**
85085
85225
  * Custom domain for the billing portal.
85086
85226
  * The default domain is: `portal.secure-payments.app`.
85227
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
85087
85228
  */
85088
85229
  customDomain?: string | null;
85089
85230
  /** Features that can be enabled for the billing portal. */
@@ -85782,7 +85923,10 @@ export interface reportsComponents {
85782
85923
  /** ID of the checkout form. */
85783
85924
  id?: string;
85784
85925
  websiteId: reportsComponents["schemas"]["WebsiteId"];
85785
- /** Custom domain for the checkout form. */
85926
+ /**
85927
+ * Custom domain for the checkout form.
85928
+ * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
85929
+ */
85786
85930
  customDomain?: string | null;
85787
85931
  /**
85788
85932
  * List of plans that are applied to a customer order by default.
@@ -86408,8 +86552,24 @@ export interface reportsComponents {
86408
86552
  id?: string;
86409
86553
  /** Fully qualified domain name. */
86410
86554
  domain: string;
86555
+ /**
86556
+ * Purpose of the custom domain.
86557
+ * Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
86558
+ * and `media` for the public files of the organization.
86559
+ * Each organization has at most one custom domain with the `purpose` field set to `media`.
86560
+ */
86561
+ purpose?: "hosted-pages" | "media";
86411
86562
  /** True if the domain is verified by Rebilly. */
86412
86563
  isVerified?: boolean;
86564
+ /**
86565
+ * Reason why the media domain cannot be verified,
86566
+ * or why a verified media domain fails its hourly check.
86567
+ * A verified media domain keeps `isVerified` set to `true` while it fails the check.
86568
+ * This value is `null` if verification is pending, or if the custom domain has no failure.
86569
+ */
86570
+ verificationFailure?:
86571
+ | ("certificate-failed" | "hostname-taken" | "cname-missing")
86572
+ | null;
86413
86573
  createdTime?: reportsComponents["schemas"]["CreatedTime"];
86414
86574
  updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
86415
86575
  _links?: reportsComponents["schemas"]["SelfLink"];
@@ -92721,6 +92881,11 @@ export interface reportsComponents {
92721
92881
  description?: string | null;
92722
92882
  acl: reportsComponents["schemas"]["Acl"];
92723
92883
  allowedIps?: reportsComponents["schemas"]["AllowedIps"];
92884
+ /**
92885
+ * IP addresses specified in `allowedIps` for this role and any roles included in it.
92886
+ * This value is `null` if no allowed IP addresses are configured for any of these roles.
92887
+ */
92888
+ computedAllowedIps?: string[] | null;
92724
92889
  /**
92725
92890
  * List of role IDs where this role is used.
92726
92891
  * For example, a role called `user` may be used in the `admin` and `manager` roles.
@@ -93015,6 +93180,14 @@ export interface reportsComponents {
93015
93180
  */
93016
93181
  roleIds?: string[];
93017
93182
  allowedIps?: reportsComponents["schemas"]["AllowedIps"];
93183
+ /**
93184
+ * IP addresses specified in `allowedIps` for the user,
93185
+ * the roles assigned to the user,
93186
+ * and any roles included in those roles.
93187
+ * This value is `null` if no allowed IP addresses are configured for any of them.
93188
+ * This value is also `null` when a Rebilly admin retrieves their own user.
93189
+ */
93190
+ computedAllowedIps?: string[] | null;
93018
93191
  /**
93019
93192
  * Specifies if the user has multi-factor authentication (MFA) set up.
93020
93193
  * This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation
@@ -97369,10 +97542,12 @@ export interface reportsComponents {
97369
97542
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
97370
97543
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
97371
97544
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
97545
+ *
97372
97546
  * The quantity limit applies to the larger of the reported and billed quantity.
97373
97547
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
97374
97548
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
97375
97549
  * The amount limit applies to the billed amount.
97550
+ *
97376
97551
  * To notify the customer, a webhook and notification can be configured for this event.
97377
97552
  * This field is useful for accounting and customer success purposes.
97378
97553
  * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -98878,10 +99053,12 @@ export interface reportsComponents {
98878
99053
  * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
98879
99054
  * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
98880
99055
  * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
99056
+ *
98881
99057
  * The quantity limit applies to the larger of the reported and billed quantity.
98882
99058
  * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
98883
99059
  * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
98884
99060
  * The amount limit applies to the billed amount.
99061
+ *
98885
99062
  * To notify the customer, a webhook and notification can be configured for this event.
98886
99063
  * This field is useful for accounting and customer success purposes.
98887
99064
  * The usage of metered billing plans can still be reported if the soft limit is reached.