rebilly-js-sdk 58.84.0 → 58.85.1

package/CHANGELOG.md

@@ -1,6 +1 @@
-## [58.84.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v58.83.0...rebilly-js-sdk-v58.84.0) (2025-07-14)
-
-
-### Features
-
-* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#13535](https://github.com/Rebilly/rebilly/issues/13535)) ([54835f2](https://github.com/Rebilly/rebilly/commit/54835f291a626cb5431460bc20e5051f271b3a8a))
+## [58.85.1](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v58.85.0...rebilly-js-sdk-v58.85.1) (2025-07-15)

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

@@ -2218,6 +2218,11 @@ declare namespace rebilly {
   type GetMonthlyRecurringRevenueReportResponse = operations['GetMonthlyRecurringRevenueReport']['responses']['200']['content']['application/json']
   type GetMonthlyRecurringRevenueReportResponsePromise = Promise<{fields: GetMonthlyRecurringRevenueReportResponse}>
   
+  type GetAnnualRecurringRevenueReportRequest = operations['GetAnnualRecurringRevenueReport']['parameters']
+  
+  type GetAnnualRecurringRevenueReportResponse = operations['GetAnnualRecurringRevenueReport']['responses']['200']['content']['application/json']
+  type GetAnnualRecurringRevenueReportResponsePromise = Promise<{fields: GetAnnualRecurringRevenueReportResponse}>
+  
   type GetRenewalSaleReportRequest = operations['GetRenewalSaleReport']['parameters']
   
   type GetRenewalSaleReportResponse = operations['GetRenewalSaleReport']['responses']['200']['content']['application/json']
@@ -15014,18 +15019,18 @@ export interface coreComponents {
       /** ID of the OAuth2 credential. */
       credentialHash: string;
     };
-    /** Update an Intuit QuickBooks invoice. */
-    RuleActionUpdateIntuitQuickbooksInvoice: coreComponents["schemas"]["RuleAction"] & {
+    /** Create an Intuit QuickBooks invoice. */
+    RuleActionCreateIntuitQuickbooksInvoice: coreComponents["schemas"]["RuleAction"] & {
       /** ID of the unearned revenue QuickBooks account. */
       unearnedRevenueAccount: string;
       /**
        * ID of the taxes QuickBooks account.
-       * If supplied taxes are represented as separate line items instead of integrated tax field.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
        */
       taxesAccount?: string | null;
       /**
        * ID of the discounts QuickBooks account.
-       * If not set `unearnedRevenueAccount` is used for discounts.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
        */
       discountsAccount?: string | null;
       /** ID of the QuickBooks department. */
@@ -15056,9 +15061,6 @@ export interface coreComponents {
       };
       /** ID of the OAuth2 credential. */
       credentialHash: string;
-    };
-    /** Create an Intuit QuickBooks invoice. */
-    RuleActionCreateIntuitQuickbooksInvoice: coreComponents["schemas"]["RuleActionUpdateIntuitQuickbooksInvoice"] & {
       /**
        * Customer display name in QuickBooks. Duplicate names are mapped to a single QuickBooks customer.
        *
@@ -15394,6 +15396,49 @@ export interface coreComponents {
       /** List of tag ID customer should be untagged from. */
       removingTags: string[];
     };
+    /** Update an Intuit QuickBooks invoice. */
+    RuleActionUpdateIntuitQuickbooksInvoice: coreComponents["schemas"]["RuleAction"] & {
+      /** ID of the unearned revenue QuickBooks account. */
+      unearnedRevenueAccount: string;
+      /**
+       * ID of the taxes QuickBooks account.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
+       */
+      taxesAccount?: string | null;
+      /**
+       * ID of the discounts QuickBooks account.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
+       */
+      discountsAccount?: string | null;
+      /** ID of the QuickBooks department. */
+      department?: string | null;
+      template?: {
+        /** Name of the line item. */
+        itemName?: string;
+        /** Description of the line item. */
+        itemDescription?: string;
+        /** SKU of the line item. */
+        itemSku?: string;
+        /** Description of the line item. */
+        itemLineDescription?: string;
+        /**
+         * Name of the tax item name.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxName?: string;
+        /** Description of the tax item. */
+        taxDescription?: string;
+        /** SKU of the tax item. */
+        taxSku?: string;
+        /**
+         * Description of the tax line.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxLineDescription?: string;
+      };
+      /** ID of the OAuth2 credential. */
+      credentialHash: string;
+    };
     /** Void an Intuit QuickBooks invoice. */
     RuleActionVoidIntuitQuickbooksInvoice: coreComponents["schemas"]["RuleAction"] & {
       /** ID of the OAuth2 credential. */
@@ -20799,6 +20844,7 @@ export interface coreComponents {
         | "upgradesCount"
         | "downgradesCount"
         | "monthlyRecurringRevenue"
+        | "annualRecurringRevenue"
         | "averageRevenuePerCustomer"
         | "customerLifetimeValue"
         | "addressProofAcceptanceRate"
@@ -21074,6 +21120,63 @@ export interface coreComponents {
         };
       }[];
     };
+    ReportAnnualRecurringRevenue: {
+      /** Annual Recurring Revenue (ARR) data. */
+      data?: {
+        /** Revenue month. */
+        period?: string;
+        /** Total Annual Recurring Revenue (ARR) amount. */
+        total?: number;
+        /**
+         * ARR categories are described below.
+         * The difference between the current period ARR and the previous period ARR is equal to:
+         * `new` + `reactivation` + `expansion` - `contraction` - `churned`.
+         */
+        breakdown?: {
+          /**
+           * Occurs when new customers sign up.
+           * New ARR is the amount of the new customer's subscription.
+           *
+           * Example: A new customer signs up to a $40 per month plan.
+           * This is a new ARR amount of $480 ($40 multiplied by 12 months).
+           */
+          new?: number;
+          /**
+           * Occurs when a customer stops being a customer for a period but later signs up again.
+           * Reactivation ARR is the amount of the customer's new subscription.
+           *
+           * Example: A customer cancels their subscription, but signs up again and purchases a $25 per month plan.
+           * This is a reactivation ARR amount of $300 ($25 multiplied by 12 months).
+           */
+          reactivation?: number;
+          /**
+           * Occurs when a subscription is churned.
+           * Churn occurs when the paid service period on a subscription order expires.
+           * Churned ARR is the amount that is lost as a result of the churned subscription.
+           *
+           * Example: When a subscription is churned, the value of a subscription goes from $80 per month to $0 per month.
+           * This is a churned ARR amount of $960 ($80 multiplied by 12 months).
+           */
+          churned?: number;
+          /**
+           * Occurs when an existing customer changes items which result in a smaller ARR.
+           * Contraction ARR is the amount before the change minus the amount after the change.
+           *
+           * Example: A customer downgrades from a plan that is $100 per month to plan that is $80 per month.
+           * This is a contraction ARR amount of $240 ($20 multiplied by 12 months).
+           */
+          contraction?: number;
+          /**
+           * Occurs when existing customers change items which result in a bigger ARR.
+           * Expansion ARR is the amount after the change minus the amount before the change.
+           *
+           * Example: A customer upgrades from a plan that is $40 per month to a plan that is $100 per month.
+           * This is an expansion ARR amount of $720 ($60 multiplied by 12 months).
+           */
+          expansion?: number;
+        };
+      }[];
+    };
     RenewalSales: {
       /** Renewal sales data. */
       data?: {
@@ -48522,18 +48625,18 @@ export interface storefrontComponents {
       /** ID of the OAuth2 credential. */
       credentialHash: string;
     };
-    /** Update an Intuit QuickBooks invoice. */
-    RuleActionUpdateIntuitQuickbooksInvoice: storefrontComponents["schemas"]["RuleAction"] & {
+    /** Create an Intuit QuickBooks invoice. */
+    RuleActionCreateIntuitQuickbooksInvoice: storefrontComponents["schemas"]["RuleAction"] & {
       /** ID of the unearned revenue QuickBooks account. */
       unearnedRevenueAccount: string;
       /**
        * ID of the taxes QuickBooks account.
-       * If supplied taxes are represented as separate line items instead of integrated tax field.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
        */
       taxesAccount?: string | null;
       /**
        * ID of the discounts QuickBooks account.
-       * If not set `unearnedRevenueAccount` is used for discounts.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
        */
       discountsAccount?: string | null;
       /** ID of the QuickBooks department. */
@@ -48564,9 +48667,6 @@ export interface storefrontComponents {
       };
       /** ID of the OAuth2 credential. */
       credentialHash: string;
-    };
-    /** Create an Intuit QuickBooks invoice. */
-    RuleActionCreateIntuitQuickbooksInvoice: storefrontComponents["schemas"]["RuleActionUpdateIntuitQuickbooksInvoice"] & {
       /**
        * Customer display name in QuickBooks. Duplicate names are mapped to a single QuickBooks customer.
        *
@@ -48902,6 +49002,49 @@ export interface storefrontComponents {
       /** List of tag ID customer should be untagged from. */
       removingTags: string[];
     };
+    /** Update an Intuit QuickBooks invoice. */
+    RuleActionUpdateIntuitQuickbooksInvoice: storefrontComponents["schemas"]["RuleAction"] & {
+      /** ID of the unearned revenue QuickBooks account. */
+      unearnedRevenueAccount: string;
+      /**
+       * ID of the taxes QuickBooks account.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
+       */
+      taxesAccount?: string | null;
+      /**
+       * ID of the discounts QuickBooks account.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
+       */
+      discountsAccount?: string | null;
+      /** ID of the QuickBooks department. */
+      department?: string | null;
+      template?: {
+        /** Name of the line item. */
+        itemName?: string;
+        /** Description of the line item. */
+        itemDescription?: string;
+        /** SKU of the line item. */
+        itemSku?: string;
+        /** Description of the line item. */
+        itemLineDescription?: string;
+        /**
+         * Name of the tax item name.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxName?: string;
+        /** Description of the tax item. */
+        taxDescription?: string;
+        /** SKU of the tax item. */
+        taxSku?: string;
+        /**
+         * Description of the tax line.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxLineDescription?: string;
+      };
+      /** ID of the OAuth2 credential. */
+      credentialHash: string;
+    };
     /** Void an Intuit QuickBooks invoice. */
     RuleActionVoidIntuitQuickbooksInvoice: storefrontComponents["schemas"]["RuleAction"] & {
       /** ID of the OAuth2 credential. */
@@ -54307,6 +54450,7 @@ export interface storefrontComponents {
         | "upgradesCount"
         | "downgradesCount"
         | "monthlyRecurringRevenue"
+        | "annualRecurringRevenue"
         | "averageRevenuePerCustomer"
         | "customerLifetimeValue"
         | "addressProofAcceptanceRate"
@@ -54582,6 +54726,63 @@ export interface storefrontComponents {
         };
       }[];
     };
+    ReportAnnualRecurringRevenue: {
+      /** Annual Recurring Revenue (ARR) data. */
+      data?: {
+        /** Revenue month. */
+        period?: string;
+        /** Total Annual Recurring Revenue (ARR) amount. */
+        total?: number;
+        /**
+         * ARR categories are described below.
+         * The difference between the current period ARR and the previous period ARR is equal to:
+         * `new` + `reactivation` + `expansion` - `contraction` - `churned`.
+         */
+        breakdown?: {
+          /**
+           * Occurs when new customers sign up.
+           * New ARR is the amount of the new customer's subscription.
+           *
+           * Example: A new customer signs up to a $40 per month plan.
+           * This is a new ARR amount of $480 ($40 multiplied by 12 months).
+           */
+          new?: number;
+          /**
+           * Occurs when a customer stops being a customer for a period but later signs up again.
+           * Reactivation ARR is the amount of the customer's new subscription.
+           *
+           * Example: A customer cancels their subscription, but signs up again and purchases a $25 per month plan.
+           * This is a reactivation ARR amount of $300 ($25 multiplied by 12 months).
+           */
+          reactivation?: number;
+          /**
+           * Occurs when a subscription is churned.
+           * Churn occurs when the paid service period on a subscription order expires.
+           * Churned ARR is the amount that is lost as a result of the churned subscription.
+           *
+           * Example: When a subscription is churned, the value of a subscription goes from $80 per month to $0 per month.
+           * This is a churned ARR amount of $960 ($80 multiplied by 12 months).
+           */
+          churned?: number;
+          /**
+           * Occurs when an existing customer changes items which result in a smaller ARR.
+           * Contraction ARR is the amount before the change minus the amount after the change.
+           *
+           * Example: A customer downgrades from a plan that is $100 per month to plan that is $80 per month.
+           * This is a contraction ARR amount of $240 ($20 multiplied by 12 months).
+           */
+          contraction?: number;
+          /**
+           * Occurs when existing customers change items which result in a bigger ARR.
+           * Expansion ARR is the amount after the change minus the amount before the change.
+           *
+           * Example: A customer upgrades from a plan that is $40 per month to a plan that is $100 per month.
+           * This is an expansion ARR amount of $720 ($60 multiplied by 12 months).
+           */
+          expansion?: number;
+        };
+      }[];
+    };
     RenewalSales: {
       /** Renewal sales data. */
       data?: {
@@ -61143,6 +61344,14 @@ export interface reportsPaths {
      */
     get: operations["GetMonthlyRecurringRevenueReport"];
   };
+  "/reports/annual-recurring-revenue": {
+    /**
+     * Retrieves an Annual Recurring Revenue (ARR) report.
+     *
+     * Use ARR reports to view information on the predictable recurring revenue for your business over a period of months.
+     */
+    get: operations["GetAnnualRecurringRevenueReport"];
+  };
   "/reports/renewal-sales": {
     /** Retrieves a renewal sales report. */
     get: operations["GetRenewalSaleReport"];
@@ -70939,18 +71148,18 @@ export interface reportsComponents {
       /** ID of the OAuth2 credential. */
       credentialHash: string;
     };
-    /** Update an Intuit QuickBooks invoice. */
-    RuleActionUpdateIntuitQuickbooksInvoice: reportsComponents["schemas"]["RuleAction"] & {
+    /** Create an Intuit QuickBooks invoice. */
+    RuleActionCreateIntuitQuickbooksInvoice: reportsComponents["schemas"]["RuleAction"] & {
       /** ID of the unearned revenue QuickBooks account. */
       unearnedRevenueAccount: string;
       /**
        * ID of the taxes QuickBooks account.
-       * If supplied taxes are represented as separate line items instead of integrated tax field.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
        */
       taxesAccount?: string | null;
       /**
        * ID of the discounts QuickBooks account.
-       * If not set `unearnedRevenueAccount` is used for discounts.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
        */
       discountsAccount?: string | null;
       /** ID of the QuickBooks department. */
@@ -70981,9 +71190,6 @@ export interface reportsComponents {
       };
       /** ID of the OAuth2 credential. */
       credentialHash: string;
-    };
-    /** Create an Intuit QuickBooks invoice. */
-    RuleActionCreateIntuitQuickbooksInvoice: reportsComponents["schemas"]["RuleActionUpdateIntuitQuickbooksInvoice"] & {
       /**
        * Customer display name in QuickBooks. Duplicate names are mapped to a single QuickBooks customer.
        *
@@ -71319,6 +71525,49 @@ export interface reportsComponents {
       /** List of tag ID customer should be untagged from. */
       removingTags: string[];
     };
+    /** Update an Intuit QuickBooks invoice. */
+    RuleActionUpdateIntuitQuickbooksInvoice: reportsComponents["schemas"]["RuleAction"] & {
+      /** ID of the unearned revenue QuickBooks account. */
+      unearnedRevenueAccount: string;
+      /**
+       * ID of the taxes QuickBooks account.
+       * If this field is supplied, taxes are represented as separate line items instead of an integrated tax field.
+       */
+      taxesAccount?: string | null;
+      /**
+       * ID of the discounts QuickBooks account.
+       * If this field is not set, `unearnedRevenueAccount` is used for discounts.
+       */
+      discountsAccount?: string | null;
+      /** ID of the QuickBooks department. */
+      department?: string | null;
+      template?: {
+        /** Name of the line item. */
+        itemName?: string;
+        /** Description of the line item. */
+        itemDescription?: string;
+        /** SKU of the line item. */
+        itemSku?: string;
+        /** Description of the line item. */
+        itemLineDescription?: string;
+        /**
+         * Name of the tax item name.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxName?: string;
+        /** Description of the tax item. */
+        taxDescription?: string;
+        /** SKU of the tax item. */
+        taxSku?: string;
+        /**
+         * Description of the tax line.
+         * This value is used when the `taxesAccount` field is configured.
+         */
+        taxLineDescription?: string;
+      };
+      /** ID of the OAuth2 credential. */
+      credentialHash: string;
+    };
     /** Void an Intuit QuickBooks invoice. */
     RuleActionVoidIntuitQuickbooksInvoice: reportsComponents["schemas"]["RuleAction"] & {
       /** ID of the OAuth2 credential. */
@@ -76724,6 +76973,7 @@ export interface reportsComponents {
         | "upgradesCount"
         | "downgradesCount"
         | "monthlyRecurringRevenue"
+        | "annualRecurringRevenue"
         | "averageRevenuePerCustomer"
         | "customerLifetimeValue"
         | "addressProofAcceptanceRate"
@@ -76999,6 +77249,63 @@ export interface reportsComponents {
         };
       }[];
     };
+    ReportAnnualRecurringRevenue: {
+      /** Annual Recurring Revenue (ARR) data. */
+      data?: {
+        /** Revenue month. */
+        period?: string;
+        /** Total Annual Recurring Revenue (ARR) amount. */
+        total?: number;
+        /**
+         * ARR categories are described below.
+         * The difference between the current period ARR and the previous period ARR is equal to:
+         * `new` + `reactivation` + `expansion` - `contraction` - `churned`.
+         */
+        breakdown?: {
+          /**
+           * Occurs when new customers sign up.
+           * New ARR is the amount of the new customer's subscription.
+           *
+           * Example: A new customer signs up to a $40 per month plan.
+           * This is a new ARR amount of $480 ($40 multiplied by 12 months).
+           */
+          new?: number;
+          /**
+           * Occurs when a customer stops being a customer for a period but later signs up again.
+           * Reactivation ARR is the amount of the customer's new subscription.
+           *
+           * Example: A customer cancels their subscription, but signs up again and purchases a $25 per month plan.
+           * This is a reactivation ARR amount of $300 ($25 multiplied by 12 months).
+           */
+          reactivation?: number;
+          /**
+           * Occurs when a subscription is churned.
+           * Churn occurs when the paid service period on a subscription order expires.
+           * Churned ARR is the amount that is lost as a result of the churned subscription.
+           *
+           * Example: When a subscription is churned, the value of a subscription goes from $80 per month to $0 per month.
+           * This is a churned ARR amount of $960 ($80 multiplied by 12 months).
+           */
+          churned?: number;
+          /**
+           * Occurs when an existing customer changes items which result in a smaller ARR.
+           * Contraction ARR is the amount before the change minus the amount after the change.
+           *
+           * Example: A customer downgrades from a plan that is $100 per month to plan that is $80 per month.
+           * This is a contraction ARR amount of $240 ($20 multiplied by 12 months).
+           */
+          contraction?: number;
+          /**
+           * Occurs when existing customers change items which result in a bigger ARR.
+           * Expansion ARR is the amount after the change minus the amount before the change.
+           *
+           * Example: A customer upgrades from a plan that is $40 per month to a plan that is $100 per month.
+           * This is an expansion ARR amount of $720 ($60 multiplied by 12 months).
+           */
+          expansion?: number;
+        };
+      }[];
+    };
     RenewalSales: {
       /** Renewal sales data. */
       data?: {
@@ -82510,6 +82817,34 @@ export interface operations {
       403: reportsComponents["responses"]["Forbidden"];
     };
   };
+  /**
+   * Retrieves an Annual Recurring Revenue (ARR) report.
+   *
+   * Use ARR reports to view information on the predictable recurring revenue for your business over a period of months.
+   */
+  GetAnnualRecurringRevenueReport: {
+    parameters: {
+      query: {
+        /** Revenue currency. */
+        currency: reportsComponents["schemas"]["CurrencyCode"];
+        /** Date and time when the report starts. */
+        periodStart: string;
+        /** Date and time when the report ends. */
+        periodEnd: string;
+      };
+    };
+    responses: {
+      /** Report retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": reportsComponents["schemas"]["ReportAnnualRecurringRevenue"];
+        };
+      };
+      401: reportsComponents["responses"]["Unauthorized"];
+      403: reportsComponents["responses"]["Forbidden"];
+    };
+  };
   /** Retrieves a renewal sales report. */
   GetRenewalSaleReport: {
     parameters: {
@@ -86685,6 +87020,11 @@ declare module "resources/experimental/reports-resource" {
             limit?: any;
             offset?: any;
         }): rebilly.GetMonthlyRecurringRevenueReportResponsePromise;
+        getAnnualRecurringRevenue({ currency, periodStart, periodEnd }: {
+            currency: any;
+            periodStart: any;
+            periodEnd: any;
+        }): rebilly.GetAnnualRecurringRevenueReportResponsePromise;
         getRenewalSales({ periodStart, periodEnd, limit, offset }: {
             periodStart: any;
             periodEnd: any;
@@ -86940,6 +87280,11 @@ declare module "resources/experimental/experimental-resources" {
                 limit?: any;
                 offset?: any;
             }): rebilly.GetMonthlyRecurringRevenueReportResponsePromise;
+            getAnnualRecurringRevenue({ currency, periodStart, periodEnd }: {
+                currency: any;
+                periodStart: any;
+                periodEnd: any;
+            }): rebilly.GetAnnualRecurringRevenueReportResponsePromise;
             getRenewalSales({ periodStart, periodEnd, limit, offset }: {
                 periodStart: any;
                 periodEnd: any;