rebilly-js-sdk 62.167.0 → 62.169.0

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

@@ -12241,59 +12241,6 @@ export interface coreComponents {
        */
       price: number;
     } | null;
-    /**
-     * Details of the one-time sale plan.
-     * Use this plan for non-recurring, one-time, sales.
-     */
-    OneTimeSalePlan: {
-      /**
-       * Name of the plan.
-       * This name is displayed on invoices and receipts.
-       */
-      name: string;
-      /**
-       * Plain-text description of the plan.
-       * This field accepts plain-text only.
-       */
-      description?: string;
-      /**
-       * Rich-text description of the plan.
-       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
-       */
-      richDescription?: string;
-      /** ID of the related product. */
-      productId: string;
-      /** Name-value pairs that specify the product options. */
-      productOptions?: { [key: string]: string } | null;
-      currency: coreComponents["schemas"]["CurrencyCode"];
-      /** Currency sign. */
-      currencySign?: string;
-      pricing: coreComponents["schemas"]["PlanPriceFormula"];
-      setup?: coreComponents["schemas"]["PlanSetup"];
-      customFields?: coreComponents["schemas"]["ResourceCustomFields"];
-      /** Specifies if the plan is active. */
-      isActive?: boolean;
-      /**
-       * Number of times the plan is modified.
-       * Compare this value with materialized subscription item revision values.
-       */
-      revision?: number;
-      /** Specifies if a plan is a trial that does not have recurring instructions. */
-      isTrialOnly?: boolean;
-      /** Service interval settings. */
-      recurringInterval?: { [key: string]: any };
-      /** Trial configuration setting. */
-      trial?: { [key: string]: any };
-      createdTime?: coreComponents["schemas"]["CreatedTime"];
-      updatedTime?: coreComponents["schemas"]["UpdatedTime"];
-      /** Related links. */
-      _links?: {
-        /** Link URL. */
-        href?: string;
-        /** Type of link. */
-        rel?: "self" | "attachments";
-      }[];
-    };
     SchedulingMethodDayAndMonthOfYear: {
       method: "day-and-month-of-year";
       /**
@@ -12388,6 +12335,15 @@ export interface coreComponents {
      * Use this plan for subscriptions or sales that reoccur over a period of time.
      */
     SubscriptionPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `subscription` when `recurringInterval` is present.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "subscription";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -12480,12 +12436,91 @@ export interface coreComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    SubscriptionPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & coreComponents["schemas"]["SubscriptionPlan"];
+    /**
+     * Details of the one-time sale plan.
+     * Use this plan for non-recurring, one-time, sales.
+     */
+    OneTimeSalePlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `one-time-sale` when both `recurringInterval` and `trial` are omitted.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "one-time-sale";
+      /**
+       * Name of the plan.
+       * This name is displayed on invoices and receipts.
+       */
+      name: string;
+      /**
+       * Plain-text description of the plan.
+       * This field accepts plain-text only.
+       */
+      description?: string;
+      /**
+       * Rich-text description of the plan.
+       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
+       */
+      richDescription?: string;
+      /** ID of the related product. */
+      productId: string;
+      /** Name-value pairs that specify the product options. */
+      productOptions?: { [key: string]: string } | null;
+      currency: coreComponents["schemas"]["CurrencyCode"];
+      /** Currency sign. */
+      currencySign?: string;
+      pricing: coreComponents["schemas"]["PlanPriceFormula"];
+      setup?: coreComponents["schemas"]["PlanSetup"];
+      customFields?: coreComponents["schemas"]["ResourceCustomFields"];
+      /** Specifies if the plan is active. */
+      isActive?: boolean;
+      /**
+       * Number of times the plan is modified.
+       * Compare this value with materialized subscription item revision values.
+       */
+      revision?: number;
+      /** Specifies if a plan is a trial that does not have recurring instructions. */
+      isTrialOnly?: boolean;
+      /** Service interval settings. */
+      recurringInterval?: { [key: string]: any };
+      /** Trial configuration setting. */
+      trial?: { [key: string]: any };
+      createdTime?: coreComponents["schemas"]["CreatedTime"];
+      updatedTime?: coreComponents["schemas"]["UpdatedTime"];
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "self" | "attachments";
+      }[];
+    };
+    OneTimeSalePlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & coreComponents["schemas"]["OneTimeSalePlan"];
     /**
      * Details of the trial-only plan.
      * Use this plan for limited-time product trials.
      * Trials may have a reduced fee, or may be free.
      */
     TrialOnlyPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `trial-only` when `trial` is present without `recurringInterval`.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "trial-only";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -12522,7 +12557,7 @@ export interface coreComponents {
       /** Service interval settings. */
       recurringInterval?: { [key: string]: any };
       /** Trial configuration settings. */
-      trial: coreComponents["schemas"]["PlanTrial"];
+      trial: { [key: string]: any } & coreComponents["schemas"]["PlanTrial"];
       /**
        * Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
        * For example, rent must be paid in advance,
@@ -12540,19 +12575,18 @@ export interface coreComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    TrialOnlyPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & coreComponents["schemas"]["TrialOnlyPlan"];
     Plan:
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & coreComponents["schemas"]["OneTimeSalePlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & coreComponents["schemas"]["SubscriptionPlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & coreComponents["schemas"]["TrialOnlyPlan"]);
+      | coreComponents["schemas"]["SubscriptionPlanDetails"]
+      | coreComponents["schemas"]["OneTimeSalePlanDetails"]
+      | coreComponents["schemas"]["TrialOnlyPlanDetails"];
+    PlanRequest:
+      | coreComponents["schemas"]["SubscriptionPlan"]
+      | coreComponents["schemas"]["OneTimeSalePlan"]
+      | coreComponents["schemas"]["TrialOnlyPlan"];
     /**
      * Products are the items that your business sells.
      * Products include digital goods, services, and physical goods.
@@ -35245,7 +35279,7 @@ export interface operations {
     /** Plan resource. */
     requestBody: {
       content: {
-        "application/json": coreComponents["schemas"]["Plan"];
+        "application/json": coreComponents["schemas"]["PlanRequest"];
       };
     };
   };
@@ -35301,7 +35335,7 @@ export interface operations {
     /** Plan resource. */
     requestBody: {
       content: {
-        "application/json": coreComponents["schemas"]["Plan"];
+        "application/json": coreComponents["schemas"]["PlanRequest"];
       };
     };
   };
@@ -51930,59 +51964,6 @@ export interface storefrontComponents {
        */
       price: number;
     } | null;
-    /**
-     * Details of the one-time sale plan.
-     * Use this plan for non-recurring, one-time, sales.
-     */
-    OneTimeSalePlan: {
-      /**
-       * Name of the plan.
-       * This name is displayed on invoices and receipts.
-       */
-      name: string;
-      /**
-       * Plain-text description of the plan.
-       * This field accepts plain-text only.
-       */
-      description?: string;
-      /**
-       * Rich-text description of the plan.
-       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
-       */
-      richDescription?: string;
-      /** ID of the related product. */
-      productId: string;
-      /** Name-value pairs that specify the product options. */
-      productOptions?: { [key: string]: string } | null;
-      currency: storefrontComponents["schemas"]["CurrencyCode"];
-      /** Currency sign. */
-      currencySign?: string;
-      pricing: storefrontComponents["schemas"]["PlanPriceFormula"];
-      setup?: storefrontComponents["schemas"]["PlanSetup"];
-      customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
-      /** Specifies if the plan is active. */
-      isActive?: boolean;
-      /**
-       * Number of times the plan is modified.
-       * Compare this value with materialized subscription item revision values.
-       */
-      revision?: number;
-      /** Specifies if a plan is a trial that does not have recurring instructions. */
-      isTrialOnly?: boolean;
-      /** Service interval settings. */
-      recurringInterval?: { [key: string]: any };
-      /** Trial configuration setting. */
-      trial?: { [key: string]: any };
-      createdTime?: storefrontComponents["schemas"]["CreatedTime"];
-      updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
-      /** Related links. */
-      _links?: {
-        /** Link URL. */
-        href?: string;
-        /** Type of link. */
-        rel?: "self" | "attachments";
-      }[];
-    };
     SchedulingMethodDayAndMonthOfYear: {
       method: "day-and-month-of-year";
       /**
@@ -52077,6 +52058,15 @@ export interface storefrontComponents {
      * Use this plan for subscriptions or sales that reoccur over a period of time.
      */
     SubscriptionPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `subscription` when `recurringInterval` is present.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "subscription";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -52169,12 +52159,91 @@ export interface storefrontComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    SubscriptionPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & storefrontComponents["schemas"]["SubscriptionPlan"];
+    /**
+     * Details of the one-time sale plan.
+     * Use this plan for non-recurring, one-time, sales.
+     */
+    OneTimeSalePlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `one-time-sale` when both `recurringInterval` and `trial` are omitted.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "one-time-sale";
+      /**
+       * Name of the plan.
+       * This name is displayed on invoices and receipts.
+       */
+      name: string;
+      /**
+       * Plain-text description of the plan.
+       * This field accepts plain-text only.
+       */
+      description?: string;
+      /**
+       * Rich-text description of the plan.
+       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
+       */
+      richDescription?: string;
+      /** ID of the related product. */
+      productId: string;
+      /** Name-value pairs that specify the product options. */
+      productOptions?: { [key: string]: string } | null;
+      currency: storefrontComponents["schemas"]["CurrencyCode"];
+      /** Currency sign. */
+      currencySign?: string;
+      pricing: storefrontComponents["schemas"]["PlanPriceFormula"];
+      setup?: storefrontComponents["schemas"]["PlanSetup"];
+      customFields?: storefrontComponents["schemas"]["ResourceCustomFields"];
+      /** Specifies if the plan is active. */
+      isActive?: boolean;
+      /**
+       * Number of times the plan is modified.
+       * Compare this value with materialized subscription item revision values.
+       */
+      revision?: number;
+      /** Specifies if a plan is a trial that does not have recurring instructions. */
+      isTrialOnly?: boolean;
+      /** Service interval settings. */
+      recurringInterval?: { [key: string]: any };
+      /** Trial configuration setting. */
+      trial?: { [key: string]: any };
+      createdTime?: storefrontComponents["schemas"]["CreatedTime"];
+      updatedTime?: storefrontComponents["schemas"]["UpdatedTime"];
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "self" | "attachments";
+      }[];
+    };
+    OneTimeSalePlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & storefrontComponents["schemas"]["OneTimeSalePlan"];
     /**
      * Details of the trial-only plan.
      * Use this plan for limited-time product trials.
      * Trials may have a reduced fee, or may be free.
      */
     TrialOnlyPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `trial-only` when `trial` is present without `recurringInterval`.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "trial-only";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -52211,7 +52280,7 @@ export interface storefrontComponents {
       /** Service interval settings. */
       recurringInterval?: { [key: string]: any };
       /** Trial configuration settings. */
-      trial: storefrontComponents["schemas"]["PlanTrial"];
+      trial: { [key: string]: any } & storefrontComponents["schemas"]["PlanTrial"];
       /**
        * Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
        * For example, rent must be paid in advance,
@@ -52229,19 +52298,18 @@ export interface storefrontComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    TrialOnlyPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & storefrontComponents["schemas"]["TrialOnlyPlan"];
     Plan:
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & storefrontComponents["schemas"]["OneTimeSalePlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & storefrontComponents["schemas"]["SubscriptionPlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & storefrontComponents["schemas"]["TrialOnlyPlan"]);
+      | storefrontComponents["schemas"]["SubscriptionPlanDetails"]
+      | storefrontComponents["schemas"]["OneTimeSalePlanDetails"]
+      | storefrontComponents["schemas"]["TrialOnlyPlanDetails"];
+    PlanRequest:
+      | storefrontComponents["schemas"]["SubscriptionPlan"]
+      | storefrontComponents["schemas"]["OneTimeSalePlan"]
+      | storefrontComponents["schemas"]["TrialOnlyPlan"];
     /**
      * Products are the items that your business sells.
      * Products include digital goods, services, and physical goods.
@@ -78649,59 +78717,6 @@ export interface reportsComponents {
        */
       price: number;
     } | null;
-    /**
-     * Details of the one-time sale plan.
-     * Use this plan for non-recurring, one-time, sales.
-     */
-    OneTimeSalePlan: {
-      /**
-       * Name of the plan.
-       * This name is displayed on invoices and receipts.
-       */
-      name: string;
-      /**
-       * Plain-text description of the plan.
-       * This field accepts plain-text only.
-       */
-      description?: string;
-      /**
-       * Rich-text description of the plan.
-       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
-       */
-      richDescription?: string;
-      /** ID of the related product. */
-      productId: string;
-      /** Name-value pairs that specify the product options. */
-      productOptions?: { [key: string]: string } | null;
-      currency: reportsComponents["schemas"]["CurrencyCode"];
-      /** Currency sign. */
-      currencySign?: string;
-      pricing: reportsComponents["schemas"]["PlanPriceFormula"];
-      setup?: reportsComponents["schemas"]["PlanSetup"];
-      customFields?: reportsComponents["schemas"]["ResourceCustomFields"];
-      /** Specifies if the plan is active. */
-      isActive?: boolean;
-      /**
-       * Number of times the plan is modified.
-       * Compare this value with materialized subscription item revision values.
-       */
-      revision?: number;
-      /** Specifies if a plan is a trial that does not have recurring instructions. */
-      isTrialOnly?: boolean;
-      /** Service interval settings. */
-      recurringInterval?: { [key: string]: any };
-      /** Trial configuration setting. */
-      trial?: { [key: string]: any };
-      createdTime?: reportsComponents["schemas"]["CreatedTime"];
-      updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
-      /** Related links. */
-      _links?: {
-        /** Link URL. */
-        href?: string;
-        /** Type of link. */
-        rel?: "self" | "attachments";
-      }[];
-    };
     SchedulingMethodDayAndMonthOfYear: {
       method: "day-and-month-of-year";
       /**
@@ -78796,6 +78811,15 @@ export interface reportsComponents {
      * Use this plan for subscriptions or sales that reoccur over a period of time.
      */
     SubscriptionPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `subscription` when `recurringInterval` is present.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "subscription";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -78888,12 +78912,91 @@ export interface reportsComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    SubscriptionPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & reportsComponents["schemas"]["SubscriptionPlan"];
+    /**
+     * Details of the one-time sale plan.
+     * Use this plan for non-recurring, one-time, sales.
+     */
+    OneTimeSalePlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `one-time-sale` when both `recurringInterval` and `trial` are omitted.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "one-time-sale";
+      /**
+       * Name of the plan.
+       * This name is displayed on invoices and receipts.
+       */
+      name: string;
+      /**
+       * Plain-text description of the plan.
+       * This field accepts plain-text only.
+       */
+      description?: string;
+      /**
+       * Rich-text description of the plan.
+       * This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.
+       */
+      richDescription?: string;
+      /** ID of the related product. */
+      productId: string;
+      /** Name-value pairs that specify the product options. */
+      productOptions?: { [key: string]: string } | null;
+      currency: reportsComponents["schemas"]["CurrencyCode"];
+      /** Currency sign. */
+      currencySign?: string;
+      pricing: reportsComponents["schemas"]["PlanPriceFormula"];
+      setup?: reportsComponents["schemas"]["PlanSetup"];
+      customFields?: reportsComponents["schemas"]["ResourceCustomFields"];
+      /** Specifies if the plan is active. */
+      isActive?: boolean;
+      /**
+       * Number of times the plan is modified.
+       * Compare this value with materialized subscription item revision values.
+       */
+      revision?: number;
+      /** Specifies if a plan is a trial that does not have recurring instructions. */
+      isTrialOnly?: boolean;
+      /** Service interval settings. */
+      recurringInterval?: { [key: string]: any };
+      /** Trial configuration setting. */
+      trial?: { [key: string]: any };
+      createdTime?: reportsComponents["schemas"]["CreatedTime"];
+      updatedTime?: reportsComponents["schemas"]["UpdatedTime"];
+      /** Related links. */
+      _links?: {
+        /** Link URL. */
+        href?: string;
+        /** Type of link. */
+        rel?: "self" | "attachments";
+      }[];
+    };
+    OneTimeSalePlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & reportsComponents["schemas"]["OneTimeSalePlan"];
     /**
      * Details of the trial-only plan.
      * Use this plan for limited-time product trials.
      * Trials may have a reduced fee, or may be free.
      */
     TrialOnlyPlan: {
+      /**
+       * Variant of the plan.
+       * This field is optional in create and update requests.
+       * The variant is `trial-only` when `trial` is present without `recurringInterval`.
+       * If included, this field must match the applicable variant.
+       * A mismatch results in an HTTP `422` response.
+       * Responses always include this field.
+       */
+      type?: "trial-only";
       /**
        * Name of the plan.
        * This name is displayed on invoices and receipts.
@@ -78930,7 +79033,7 @@ export interface reportsComponents {
       /** Service interval settings. */
       recurringInterval?: { [key: string]: any };
       /** Trial configuration settings. */
-      trial: reportsComponents["schemas"]["PlanTrial"];
+      trial: { [key: string]: any } & reportsComponents["schemas"]["PlanTrial"];
       /**
        * Use invoice time shift to adjust the invoice issue and due date when billing must occur before the service period changes.
        * For example, rent must be paid in advance,
@@ -78948,19 +79051,18 @@ export interface reportsComponents {
         rel?: "self" | "attachments";
       }[];
     };
+    TrialOnlyPlanDetails: {
+      /** ID of the plan. */
+      id: string;
+    } & reportsComponents["schemas"]["TrialOnlyPlan"];
     Plan:
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & reportsComponents["schemas"]["OneTimeSalePlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & reportsComponents["schemas"]["SubscriptionPlan"])
-      | ({
-          /** ID of the plan. */
-          id: string;
-        } & reportsComponents["schemas"]["TrialOnlyPlan"]);
+      | reportsComponents["schemas"]["SubscriptionPlanDetails"]
+      | reportsComponents["schemas"]["OneTimeSalePlanDetails"]
+      | reportsComponents["schemas"]["TrialOnlyPlanDetails"];
+    PlanRequest:
+      | reportsComponents["schemas"]["SubscriptionPlan"]
+      | reportsComponents["schemas"]["OneTimeSalePlan"]
+      | reportsComponents["schemas"]["TrialOnlyPlan"];
     /**
      * Products are the items that your business sells.
      * Products include digital goods, services, and physical goods.
@@ -104930,6 +105032,13 @@ declare module "resources/experimental/reports-resource" {
             offset?: any;
             filter?: any;
         }): rebilly.GetTransactionReportResponsePromise;
+        downloadAmlAuditReport({ personId, periodStart, periodEnd, filter, accept, }: {
+            personId: any;
+            periodStart?: any;
+            periodEnd?: any;
+            filter?: any;
+            accept?: string;
+        }): any;
     };
 }
 declare module "resources/experimental/subscriptions-resource" {
@@ -105228,6 +105337,13 @@ declare module "resources/experimental/experimental-resources" {
                 offset?: any;
                 filter?: any;
             }): rebilly.GetTransactionReportResponsePromise;
+            downloadAmlAuditReport({ personId, periodStart, periodEnd, filter, accept, }: {
+                personId: any;
+                periodStart?: any;
+                periodEnd?: any;
+                filter?: any;
+                accept?: string;
+            }): any;
         };
         subscriptions: {
             getSubscriptionSummaryMetrics({ subscriptionId }: {