rebilly-js-sdk 62.235.1 → 62.236.1

package/CHANGELOG.md

@@ -1,5 +1,3 @@
-## 62.235.1 (2026-10-26)
+## 62.236.1 (2026-10-27)
 
-### 🧱 Updated Dependencies
-
-- Updated eslint-config to 4.32.14
+This was a version bump only for rebilly-js-sdk to align it with other projects, there were no code changes.

package/dist/rebilly-js-sdk.d.cts

@@ -3182,6 +3182,15 @@ export interface corePaths {
      *
      * One use case for this operation to apply a revoked coupon,
      * or coupon that is redeemed by a customer after the invoice is issued.
+     *
+     * Shipping amount recalculation depends on the `shipping.calculator` property:
+     *
+     * - If `shipping.calculator` is `manual` and the invoice is issued, the shipping amount is not changed.
+     * - If `shipping.calculator` is `manual` and the invoice is a scheduled draft or a quotation, the shipping amount is 0 if no invoice item requires shipping.
+     * - If `shipping.calculator` is `rebilly`, the shipping amount is recalculated from the current shipping rates.
+     *   This amount can differ from the original shipping amount of the invoice.
+     *   The shipping amount is 0 if no invoice item requires shipping.
+     *   A scheduled draft without a shipping rate also gets a shipping amount of 0.
      */
     post: operations["PostInvoiceRecalculation"];
     parameters: {
@@ -4627,7 +4636,12 @@ export interface corePaths {
   "/api-keys": {
     /** Retrieve a list of API keys. */
     get: operations["GetApiKeyCollection"];
-    /** Create an API key. */
+    /**
+     * Creates an API key for the authenticated user.
+     * The key is not assigned to another user.
+     * If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
+     * For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
+     */
     post: operations["PostApiKey"];
   };
   "/api-keys/{id}": {
@@ -5746,6 +5760,9 @@ export interface corePaths {
      * To turn on `requireMfa`, the session must have passed MFA.
      * If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
      * If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
+     * If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
+     * If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
+     * If the list does not include the IP address of the caller, the response is `422`.
      * Settings apply to the current environment only: live and sandbox are configured separately.
      */
     put: operations["PutSecuritySettings"];
@@ -6278,6 +6295,12 @@ export interface coreComponents {
       /** HTTP status code. */
       status?: number;
     } & coreComponents["schemas"]["BaseProblem"];
+    /**
+     * Unique organization identifier.
+     * An organization is an entity that represents a company.
+     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+     */
+    OrganizationId: string;
     Forbidden: { [key: string]: any } & {
       /** HTTP status code. */
       status?: number;
@@ -6286,8 +6309,15 @@ export interface coreComponents {
        * Most responses use a descriptive message, such as `Not allowed to change security settings`.
        * If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
        * If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
+       * If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
        */
       error?: string;
+      /**
+       * ID of the organization that does not allow the IP address of the request.
+       * This property is present only if `error` is `ip_not_allowed`.
+       * The organization is the organization of the request or another organization that the request acts on.
+       */
+      organizationId?: coreComponents["schemas"]["OrganizationId"];
     } & coreComponents["schemas"]["BaseProblem"];
     NotFound: {
       /** HTTP status code. */
@@ -7543,12 +7573,6 @@ export interface coreComponents {
       /** Revenue amount in USD. */
       amountUsd?: number;
     };
-    /**
-     * Unique organization identifier.
-     * An organization is an entity that represents a company.
-     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
-     */
-    OrganizationId: string;
     TaxNumber: {
       /** Type of the tax number. */
       type: "eu-vat" | "other";
@@ -9617,6 +9641,20 @@ export interface coreComponents {
       subtotalAmount?: number;
       /** Discount amount that is applied to the invoice. */
       discountAmount?: number;
+      /**
+       * Shipping settings of the invoice.
+       * The `calculator` property is `manual` when the shipping amount is provided
+       * and `rebilly` when the amount is calculated from shipping rates.
+       * If `calculator` is `manual` and an issued invoice is recalculated or its items change,
+       * the shipping amount is not changed, even if no invoice item requires shipping.
+       * If `calculator` is `manual` and no invoice item requires shipping, the shipping amount is 0 in these cases:
+       *
+       * - A draft invoice is issued with the [Issue an invoice](https://www.rebilly.com/catalog/all/invoices/postinvoiceissuance) operation, a renewal invoice is issued, or a scheduled draft invoice is recalculated.
+       * - An order is created or previewed, a quote is created, or a `pending` order is updated.
+       *   This applies to the order invoice. The order keeps its shipping amount.
+       *
+       * To change the shipping amount of an issued invoice, use the [Upsert an invoice](https://www.rebilly.com/catalog/all/invoices/putinvoice) operation.
+       */
       shipping?: coreComponents["schemas"]["Shipping"];
       tax?: coreComponents["schemas"]["Taxes"];
       /** Organization tax ID number that is displayed on the invoice. */
@@ -16008,8 +16046,14 @@ export interface coreComponents {
       /** Type of API key. */
       type?: "secret" | "publishable";
       /**
-       * Specify access control list here if creating a restricted API key.
-       * Send all matching permission with an empty scope to allow all permissions.
+       * Permissions for this API key.
+       *
+       * A request is authorized only when these permissions include the permission for the operation,
+       * and the associated user has that permission.
+       * If these permissions include `*`, each operation is limited to the permissions of the associated user.
+       * If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
+       * If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
+       * For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
        */
       acl?: coreComponents["schemas"]["Acl"];
       allowedIps?: coreComponents["schemas"]["AllowedIps"];
@@ -23900,6 +23944,21 @@ export interface coreComponents {
     SecuritySettings: {
       /** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
       requireMfa: boolean;
+      /**
+       * List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
+       * This setting does not apply to API keys.
+       * This setting applies to the current environment only: live and sandbox are configured separately.
+       * If an IP address has no prefix length, only that address is allowed.
+       * Wildcards, such as `198.51.*.*`, are not accepted.
+       * To remove the restriction, set this value to `null` or an empty array.
+       * To retain the current list, omit this property.
+       */
+      allowedIps?: coreComponents["schemas"]["AllowedIps"];
+      /**
+       * IP address of the client that sent the request.
+       * This value is `null` if the IP address of the client cannot be determined.
+       */
+      currentIpAddress?: string | null;
       /**
        * Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
        * Pending invitations are counted as users without MFA.
@@ -34124,6 +34183,15 @@ export interface operations {
    *
    * One use case for this operation to apply a revoked coupon,
    * or coupon that is redeemed by a customer after the invoice is issued.
+   *
+   * Shipping amount recalculation depends on the `shipping.calculator` property:
+   *
+   * - If `shipping.calculator` is `manual` and the invoice is issued, the shipping amount is not changed.
+   * - If `shipping.calculator` is `manual` and the invoice is a scheduled draft or a quotation, the shipping amount is 0 if no invoice item requires shipping.
+   * - If `shipping.calculator` is `rebilly`, the shipping amount is recalculated from the current shipping rates.
+   *   This amount can differ from the original shipping amount of the invoice.
+   *   The shipping amount is 0 if no invoice item requires shipping.
+   *   A scheduled draft without a shipping rate also gets a shipping amount of 0.
    */
   PostInvoiceRecalculation: {
     parameters: {
@@ -39999,7 +40067,12 @@ export interface operations {
       403: coreComponents["responses"]["Forbidden"];
     };
   };
-  /** Create an API key. */
+  /**
+   * Creates an API key for the authenticated user.
+   * The key is not assigned to another user.
+   * If the authenticated user is removed from an organization, a request to that organization that uses the API key is not authorized.
+   * For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
+   */
   PostApiKey: {
     responses: {
       /** API key created. */
@@ -44538,6 +44611,9 @@ export interface operations {
    * To turn on `requireMfa`, the session must have passed MFA.
    * If the session has not passed MFA, the response is `403` and `error` is `mfa_required_for_caller`.
    * If the number of users who have MFA set up is temporarily unavailable, `requireMfa` cannot be turned on and the response is `503`.
+   * If `allowedIps` contains IP addresses, users can use the organization in the Rebilly UI only from those IP addresses.
+   * If a request comes from another IP address, other operations respond with `403` and `error` is `ip_not_allowed`.
+   * If the list does not include the IP address of the caller, the response is `422`.
    * Settings apply to the current environment only: live and sandbox are configured separately.
    */
   PutSecuritySettings: {
@@ -46602,6 +46678,12 @@ export interface storefrontComponents {
       /** HTTP status code. */
       status?: number;
     } & storefrontComponents["schemas"]["BaseProblem"];
+    /**
+     * Unique organization identifier.
+     * An organization is an entity that represents a company.
+     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+     */
+    OrganizationId: string;
     Forbidden: { [key: string]: any } & {
       /** HTTP status code. */
       status?: number;
@@ -46610,8 +46692,15 @@ export interface storefrontComponents {
        * Most responses use a descriptive message, such as `Not allowed to change security settings`.
        * If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
        * If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
+       * If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
        */
       error?: string;
+      /**
+       * ID of the organization that does not allow the IP address of the request.
+       * This property is present only if `error` is `ip_not_allowed`.
+       * The organization is the organization of the request or another organization that the request acts on.
+       */
+      organizationId?: storefrontComponents["schemas"]["OrganizationId"];
     } & storefrontComponents["schemas"]["BaseProblem"];
     NotFound: {
       /** HTTP status code. */
@@ -47867,12 +47956,6 @@ export interface storefrontComponents {
       /** Revenue amount in USD. */
       amountUsd?: number;
     };
-    /**
-     * Unique organization identifier.
-     * An organization is an entity that represents a company.
-     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
-     */
-    OrganizationId: string;
     TaxNumber: {
       /** Type of the tax number. */
       type: "eu-vat" | "other";
@@ -49941,6 +50024,20 @@ export interface storefrontComponents {
       subtotalAmount?: number;
       /** Discount amount that is applied to the invoice. */
       discountAmount?: number;
+      /**
+       * Shipping settings of the invoice.
+       * The `calculator` property is `manual` when the shipping amount is provided
+       * and `rebilly` when the amount is calculated from shipping rates.
+       * If `calculator` is `manual` and an issued invoice is recalculated or its items change,
+       * the shipping amount is not changed, even if no invoice item requires shipping.
+       * If `calculator` is `manual` and no invoice item requires shipping, the shipping amount is 0 in these cases:
+       *
+       * - A draft invoice is issued with the [Issue an invoice](https://www.rebilly.com/catalog/all/invoices/postinvoiceissuance) operation, a renewal invoice is issued, or a scheduled draft invoice is recalculated.
+       * - An order is created or previewed, a quote is created, or a `pending` order is updated.
+       *   This applies to the order invoice. The order keeps its shipping amount.
+       *
+       * To change the shipping amount of an issued invoice, use the [Upsert an invoice](https://www.rebilly.com/catalog/all/invoices/putinvoice) operation.
+       */
       shipping?: storefrontComponents["schemas"]["Shipping"];
       tax?: storefrontComponents["schemas"]["Taxes"];
       /** Organization tax ID number that is displayed on the invoice. */
@@ -56332,8 +56429,14 @@ export interface storefrontComponents {
       /** Type of API key. */
       type?: "secret" | "publishable";
       /**
-       * Specify access control list here if creating a restricted API key.
-       * Send all matching permission with an empty scope to allow all permissions.
+       * Permissions for this API key.
+       *
+       * A request is authorized only when these permissions include the permission for the operation,
+       * and the associated user has that permission.
+       * If these permissions include `*`, each operation is limited to the permissions of the associated user.
+       * If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
+       * If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
+       * For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
        */
       acl?: storefrontComponents["schemas"]["Acl"];
       allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
@@ -64224,6 +64327,21 @@ export interface storefrontComponents {
     SecuritySettings: {
       /** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
       requireMfa: boolean;
+      /**
+       * List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
+       * This setting does not apply to API keys.
+       * This setting applies to the current environment only: live and sandbox are configured separately.
+       * If an IP address has no prefix length, only that address is allowed.
+       * Wildcards, such as `198.51.*.*`, are not accepted.
+       * To remove the restriction, set this value to `null` or an empty array.
+       * To retain the current list, omit this property.
+       */
+      allowedIps?: storefrontComponents["schemas"]["AllowedIps"];
+      /**
+       * IP address of the client that sent the request.
+       * This value is `null` if the IP address of the client cannot be determined.
+       */
+      currentIpAddress?: string | null;
       /**
        * Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
        * Pending invitations are counted as users without MFA.
@@ -74166,6 +74284,12 @@ export interface reportsComponents {
       /** HTTP status code. */
       status?: number;
     } & reportsComponents["schemas"]["BaseProblem"];
+    /**
+     * Unique organization identifier.
+     * An organization is an entity that represents a company.
+     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
+     */
+    OrganizationId: string;
     Forbidden: { [key: string]: any } & {
       /** HTTP status code. */
       status?: number;
@@ -74174,8 +74298,15 @@ export interface reportsComponents {
        * Most responses use a descriptive message, such as `Not allowed to change security settings`.
        * If the organization requires multi-factor authentication (MFA) and MFA verification has not been completed for the session, this value is `mfa_required`.
        * If the request sets `requireMfa` to `true` and MFA verification has not been completed for the session, this value is `mfa_required_for_caller`.
+       * If the organization restricts access to a list of IP addresses and the request comes from an IP address that is not in the list, this value is `ip_not_allowed`.
        */
       error?: string;
+      /**
+       * ID of the organization that does not allow the IP address of the request.
+       * This property is present only if `error` is `ip_not_allowed`.
+       * The organization is the organization of the request or another organization that the request acts on.
+       */
+      organizationId?: reportsComponents["schemas"]["OrganizationId"];
     } & reportsComponents["schemas"]["BaseProblem"];
     NotFound: {
       /** HTTP status code. */
@@ -75431,12 +75562,6 @@ export interface reportsComponents {
       /** Revenue amount in USD. */
       amountUsd?: number;
     };
-    /**
-     * Unique organization identifier.
-     * An organization is an entity that represents a company.
-     * For more information, see [Obtain an organization ID](https://www.rebilly.com/docs/settings/organizations-and-websites/#obtain-your-organization-id-and-website-id).
-     */
-    OrganizationId: string;
     TaxNumber: {
       /** Type of the tax number. */
       type: "eu-vat" | "other";
@@ -77505,6 +77630,20 @@ export interface reportsComponents {
       subtotalAmount?: number;
       /** Discount amount that is applied to the invoice. */
       discountAmount?: number;
+      /**
+       * Shipping settings of the invoice.
+       * The `calculator` property is `manual` when the shipping amount is provided
+       * and `rebilly` when the amount is calculated from shipping rates.
+       * If `calculator` is `manual` and an issued invoice is recalculated or its items change,
+       * the shipping amount is not changed, even if no invoice item requires shipping.
+       * If `calculator` is `manual` and no invoice item requires shipping, the shipping amount is 0 in these cases:
+       *
+       * - A draft invoice is issued with the [Issue an invoice](https://www.rebilly.com/catalog/all/invoices/postinvoiceissuance) operation, a renewal invoice is issued, or a scheduled draft invoice is recalculated.
+       * - An order is created or previewed, a quote is created, or a `pending` order is updated.
+       *   This applies to the order invoice. The order keeps its shipping amount.
+       *
+       * To change the shipping amount of an issued invoice, use the [Upsert an invoice](https://www.rebilly.com/catalog/all/invoices/putinvoice) operation.
+       */
       shipping?: reportsComponents["schemas"]["Shipping"];
       tax?: reportsComponents["schemas"]["Taxes"];
       /** Organization tax ID number that is displayed on the invoice. */
@@ -83896,8 +84035,14 @@ export interface reportsComponents {
       /** Type of API key. */
       type?: "secret" | "publishable";
       /**
-       * Specify access control list here if creating a restricted API key.
-       * Send all matching permission with an empty scope to allow all permissions.
+       * Permissions for this API key.
+       *
+       * A request is authorized only when these permissions include the permission for the operation,
+       * and the associated user has that permission.
+       * If these permissions include `*`, each operation is limited to the permissions of the associated user.
+       * If the associated user loses a permission and these permissions still include that permission, a request that requires that permission is not authorized.
+       * If the associated user gains a permission, a request that requires that permission is authorized only when these permissions include that permission or `*`.
+       * For more information, see [Ownership of an API key](https://www.rebilly.com/docs/dev-docs/api-keys/#ownership-of-an-api-key).
        */
       acl?: reportsComponents["schemas"]["Acl"];
       allowedIps?: reportsComponents["schemas"]["AllowedIps"];
@@ -91788,6 +91933,21 @@ export interface reportsComponents {
     SecuritySettings: {
       /** Specifies if users must pass multi-factor authentication (MFA) to use this organization in the Rebilly UI. */
       requireMfa: boolean;
+      /**
+       * List of IP addresses and Classless Inter-Domain Routing (CIDR) ranges from which users can use this organization in the Rebilly UI.
+       * This setting does not apply to API keys.
+       * This setting applies to the current environment only: live and sandbox are configured separately.
+       * If an IP address has no prefix length, only that address is allowed.
+       * Wildcards, such as `198.51.*.*`, are not accepted.
+       * To remove the restriction, set this value to `null` or an empty array.
+       * To retain the current list, omit this property.
+       */
+      allowedIps?: reportsComponents["schemas"]["AllowedIps"];
+      /**
+       * IP address of the client that sent the request.
+       * This value is `null` if the IP address of the client cannot be determined.
+       */
+      currentIpAddress?: string | null;
       /**
        * Number of users who have set up multi-factor authentication (MFA), excluding Rebilly staff.
        * Pending invitations are counted as users without MFA.
@@ -103092,6 +103252,7 @@ declare module "errors/errors" {
         export { RebillyError };
         export { RebillyRequestError };
         export { RebillyMfaRequiredError };
+        export { RebillyIpNotAllowedError };
         export { RebillyValidationError };
         export { RebillyNotFoundError };
         export { RebillyConflictError };
@@ -103107,6 +103268,9 @@ declare module "errors/errors" {
     class RebillyMfaRequiredError extends RebillyRequestError {
         name: string;
     }
+    class RebillyIpNotAllowedError extends RebillyRequestError {
+        name: string;
+    }
     class RebillyValidationError extends RebillyError {
         constructor(error: any);
     }