@rebilly/api 0.18.3 → 0.19.1

package/CHANGELOG.md

@@ -1,3 +1,3 @@
-## 0.18.3 (2026-11-03)
+## 0.19.1 (2026-11-04)
 
 This was a version bump only for rebilly-api to align it with other projects, there were no code changes.

package/dist/core-client.d.ts

@@ -8832,7 +8832,7 @@ export type PutRolePath = {
      */
     id: string;
 };
-export type PutRoleBody = Omit<Role, "id" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
+export type PutRoleBody = Omit<Role, "id" | "computedAllowedIps" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
 export type PutRoleResponseHeaders = {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -8942,7 +8942,7 @@ export type PutUserPath = {
      */
     id: string;
 };
-export type PutUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "mfaEnabled">;
+export type PutUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "computedAllowedIps" | "mfaEnabled">;
 export type PutUserResponseHeaders = {
     rateLimitLimit?: number;
     rateLimitRemaining?: number;
@@ -9797,7 +9797,7 @@ export type GetCustomDomainCollectionVariables = {
     query?: GetCustomDomainCollectionQuery;
 };
 export type PostCustomDomainResult = CustomDomain;
-export type PostCustomDomainBody = Omit<CustomDomain, "id" | "isVerified">;
+export type PostCustomDomainBody = Omit<CustomDomain, "id" | "isVerified" | "verificationFailure">;
 export type PostCustomDomainResponseHeaders = {
     location?: string;
     rateLimitLimit?: number;
@@ -10351,7 +10351,7 @@ export type GetRoleCollectionVariables = {
     query?: GetRoleCollectionQuery;
 };
 export type PostRoleResult = Role;
-export type PostRoleBody = Omit<Role, "id" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
+export type PostRoleBody = Omit<Role, "id" | "computedAllowedIps" | "seniorIds" | "usersCount" | "_links" | "_embedded">;
 export type PostRoleResponseHeaders = {
     location?: string;
     rateLimitLimit?: number;
@@ -10584,7 +10584,7 @@ export type GetUserCollectionVariables = {
     query?: GetUserCollectionQuery;
 };
 export type PostUserResult = User;
-export type PostUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "mfaEnabled">;
+export type PostUserBody = Omit<User, "id" | "computedPermissions" | "loginTime" | "reportingCurrency" | "availableCurrencies" | "status" | "computedAllowedIps" | "mfaEnabled">;
 export type PostUserResponseHeaders = {
     location?: string;
     rateLimitLimit?: number;

package/dist/core-client.schemas.d.ts

@@ -2699,6 +2699,8 @@ export type File = {
      * Specifies if the file is available publicly without authentication.
      * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
      * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
+     * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
+     * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
      */
     isPublic?: boolean;
     /**
@@ -2724,6 +2726,8 @@ export type FileCreateFromInline = {
      * Specifies if the file is available publicly without authentication.
      * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
      * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
+     * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
+     * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
      */
     isPublic?: boolean;
     /**
@@ -2754,6 +2758,8 @@ export type FileCreateFromUrl = {
      * Specifies if the file is available publicly without authentication.
      * If this value is `true`, the `permalink` and `cdn` links in the `_links` section contain the public URLs.
      * The `cdn` link is served from a cache and accepts the `imageSize` query parameter for images.
+     * If the organization has a verified media domain with no verification failure, the `cdn` link uses that domain.
+     * For more information, see [Configure a custom domain](https://www.rebilly.com/docs/settings/organizations-and-websites/#configure-a-custom-domain).
      */
     isPublic?: boolean;
     /**
@@ -8027,10 +8033,12 @@ export type UsageLimits = {
      * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
      * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
      * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
+     *
      * The quantity limit applies to the larger of the reported and billed quantity.
      * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
      * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
      * The amount limit applies to the billed amount.
+     *
      * To notify the customer, a webhook and notification can be configured for this event.
      * This field is useful for accounting and customer success purposes.
      * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -8054,6 +8062,7 @@ export type UsageLimits = {
      * When a soft limit is reached,
      * a customer may receive a notification
      * but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
+     *
      * When the reported usage reaches the configured limit,
      * a specific event is triggered.
      * To notify the customer in the merchant system,
@@ -8062,6 +8071,7 @@ export type UsageLimits = {
      * When the total usage reaches the hard limit quantity,
      * or amount values,
      * metered billing plan usages can no longer be reported.
+     *
      * Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
      * A `quantity` value below the minimum billable quantity is invalid.
      * An `amount` value below the minimum billable amount is invalid.
@@ -14998,6 +15008,7 @@ export type CheckoutForm = {
     websiteId: WebsiteId;
     /**
      * Custom domain for the checkout form.
+     * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
      * @maxLength 255
      */
     customDomain?: string | null;
@@ -15857,6 +15868,7 @@ export type BillingPortal = {
     /**
      * Custom domain for the billing portal.
      * The default domain is: `portal.secure-payments.app`.
+     * Only a custom domain with the `purpose` field set to `hosted-pages` is accepted.
      * @maxLength 255
      */
     customDomain?: string | null;
@@ -16914,10 +16926,24 @@ export type CustomDomain = {
      * @maxLength 255
      */
     domain: string;
+    /**
+     * Purpose of the custom domain.
+     * Use `hosted-pages` for hosted pages, such as billing portals and checkout forms,
+     * and `media` for the public files of the organization.
+     * Each organization has at most one custom domain with the `purpose` field set to `media`.
+     */
+    purpose?: "hosted-pages" | "media";
     /**
      * True if the domain is verified by Rebilly.
      */
     readonly isVerified?: boolean;
+    /**
+     * Reason why the media domain cannot be verified,
+     * or why a verified media domain fails its hourly check.
+     * A verified media domain keeps `isVerified` set to `true` while it fails the check.
+     * This value is `null` if verification is pending, or if the custom domain has no failure.
+     */
+    readonly verificationFailure?: ("certificate-failed" | "hostname-taken" | "cname-missing") | null;
     createdTime?: CreatedTime;
     updatedTime?: UpdatedTime;
     _links?: SelfLink;
@@ -25692,6 +25718,11 @@ export type Role = {
     description?: string | null;
     acl: Acl;
     allowedIps?: AllowedIps;
+    /**
+     * IP addresses specified in `allowedIps` for this role and any roles included in it.
+     * This value is `null` if no allowed IP addresses are configured for any of these roles.
+     */
+    readonly computedAllowedIps?: string[] | null;
     /**
      * List of role IDs where this role is used.
      * For example, a role called `user` may be used in the `admin` and `manager` roles.
@@ -26136,6 +26167,14 @@ export type User = {
      */
     roleIds?: string[];
     allowedIps?: AllowedIps;
+    /**
+     * IP addresses specified in `allowedIps` for the user,
+     * the roles assigned to the user,
+     * and any roles included in those roles.
+     * This value is `null` if no allowed IP addresses are configured for any of them.
+     * This value is also `null` when a Rebilly admin retrieves their own user.
+     */
+    readonly computedAllowedIps?: string[] | null;
     /**
      * Specifies if the user has multi-factor authentication (MFA) set up.
      * This value is present only in responses from the [Retrieve a list of users](https://www.rebilly.com/catalog/all/users/getusercollection) operation

package/dist/storefront-client.d.ts

@@ -625,10 +625,12 @@ export type StorefrontPatchOrderBody = {
              * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
              * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
              * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
+             *
              * The quantity limit applies to the larger of the reported and billed quantity.
              * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
              * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
              * The amount limit applies to the billed amount.
+             *
              * To notify the customer, a webhook and notification can be configured for this event.
              * This field is useful for accounting and customer success purposes.
              * The usage of metered billing plans can still be reported if the soft limit is reached.

package/dist/storefront-client.schemas.d.ts

@@ -4416,10 +4416,12 @@ export type UsageLimits = {
      * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
      * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
      * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
+     *
      * The quantity limit applies to the larger of the reported and billed quantity.
      * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
      * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
      * The amount limit applies to the billed amount.
+     *
      * To notify the customer, a webhook and notification can be configured for this event.
      * This field is useful for accounting and customer success purposes.
      * The usage of metered billing plans can still be reported if the soft limit is reached.
@@ -4443,6 +4445,7 @@ export type UsageLimits = {
      * When a soft limit is reached,
      * a customer may receive a notification
      * but the service can still be provided up to the hard limit value so that the customer can upgrade their plan.
+     *
      * When the reported usage reaches the configured limit,
      * a specific event is triggered.
      * To notify the customer in the merchant system,
@@ -4451,6 +4454,7 @@ export type UsageLimits = {
      * When the total usage reaches the hard limit quantity,
      * or amount values,
      * metered billing plan usages can no longer be reported.
+     *
      * Plans with a minimum quantity, fixed fee, or flat stairstep bracket set a minimum billable quantity and amount.
      * A `quantity` value below the minimum billable quantity is invalid.
      * An `amount` value below the minimum billable amount is invalid.
@@ -7340,10 +7344,12 @@ export type PostSubscription = {
              * For example, to notify the customer that their usage is near the hard limit of their metered billing plan.
              * This notification informs the customer so that they can upgrade their plan before the hard limit is reached.
              * When metered usage equals or exceeds the configured soft limit, the `soft-usage-limit-reached` event is triggered.
+             *
              * The quantity limit applies to the larger of the reported and billed quantity.
              * If a minimum billable quantity results in a billed quantity that is higher than the reported quantity, the billed quantity applies to the limit.
              * If a maximum billable quantity results in a billed quantity that is lower than the reported quantity, the reported quantity applies to the limit.
              * The amount limit applies to the billed amount.
+             *
              * To notify the customer, a webhook and notification can be configured for this event.
              * This field is useful for accounting and customer success purposes.
              * The usage of metered billing plans can still be reported if the soft limit is reached.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rebilly/api",
-  "version": "0.18.3",
+  "version": "0.19.1",
   "description": "Rebilly Core and Storefront API clients generated from the OpenAPI definitions",
   "type": "module",
   "sideEffects": false,