rebilly-js-sdk 62.196.0 → 62.196.2

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

@@ -3162,7 +3162,11 @@ export interface corePaths {
     };
   };
   "/invoices/{id}/abandon": {
-    /** Abandons an invoice with a specified ID. */
+    /**
+     * Abandons an invoice with a specified ID.
+     * This operation removes credit memo allocations from the invoice.
+     * Unused credit returns to the credit memo.
+     */
     post: operations["PostInvoiceAbandonment"];
     parameters: {
       path: {
@@ -3172,7 +3176,11 @@ export interface corePaths {
     };
   };
   "/invoices/{id}/void": {
-    /** Voids an invoice with a specified ID. */
+    /**
+     * Voids an invoice with a specified ID.
+     * This operation removes credit memo allocations from the invoice.
+     * Unused credit returns to the credit memo.
+     */
     post: operations["PostInvoiceVoid"];
     parameters: {
       path: {
@@ -13682,9 +13690,19 @@ export interface coreComponents {
       recentInvoiceId?: string | null;
       /** Details of items in the order. */
       items: coreComponents["schemas"]["SubscriptionOrOneTimeSaleItem"][];
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: coreComponents["schemas"]["ContactObject"] | null;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
       /** Date and time when the order is activated. */
       activationTime?: string | null;
@@ -14310,9 +14328,19 @@ export interface coreComponents {
       poNumber?: string | null;
       /** Notes for the customer that are displayed on the order invoice. */
       notes?: string;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: coreComponents["schemas"]["ContactObject"] | null;
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: coreComponents["schemas"]["ContactObject"] | null;
       /**
        * Length of time, in ISO-8601 durations format,
@@ -33346,7 +33374,11 @@ export interface operations {
       };
     };
   };
-  /** Abandons an invoice with a specified ID. */
+  /**
+   * Abandons an invoice with a specified ID.
+   * This operation removes credit memo allocations from the invoice.
+   * Unused credit returns to the credit memo.
+   */
   PostInvoiceAbandonment: {
     parameters: {
       path: {
@@ -33368,7 +33400,11 @@ export interface operations {
       429: coreComponents["responses"]["TooManyRequests"];
     };
   };
-  /** Voids an invoice with a specified ID. */
+  /**
+   * Voids an invoice with a specified ID.
+   * This operation removes credit memo allocations from the invoice.
+   * Unused credit returns to the credit memo.
+   */
   PostInvoiceVoid: {
     parameters: {
       path: {
@@ -53427,9 +53463,19 @@ export interface storefrontComponents {
       recentInvoiceId?: string | null;
       /** Details of items in the order. */
       items: storefrontComponents["schemas"]["SubscriptionOrOneTimeSaleItem"][];
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
       /** Date and time when the order is activated. */
       activationTime?: string | null;
@@ -54055,9 +54101,19 @@ export interface storefrontComponents {
       poNumber?: string | null;
       /** Notes for the customer that are displayed on the order invoice. */
       notes?: string;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: storefrontComponents["schemas"]["ContactObject"] | null;
       /**
        * Length of time, in ISO-8601 durations format,
@@ -80122,9 +80178,19 @@ export interface reportsComponents {
       recentInvoiceId?: string | null;
       /** Details of items in the order. */
       items: reportsComponents["schemas"]["SubscriptionOrOneTimeSaleItem"][];
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: reportsComponents["schemas"]["ContactObject"] | null;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: reportsComponents["schemas"]["ContactObject"] | null;
       /** Date and time when the order is activated. */
       activationTime?: string | null;
@@ -80750,9 +80816,19 @@ export interface reportsComponents {
       poNumber?: string | null;
       /** Notes for the customer that are displayed on the order invoice. */
       notes?: string;
-      /** Billing address of the order. */
+      /**
+       * Billing address of the order.
+       * Changes to the billing address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the billing address on an issued invoice that has no payment attempts or applied credits, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=billingaddress).
+       */
       billingAddress?: reportsComponents["schemas"]["ContactObject"] | null;
-      /** Delivery address of the order. */
+      /**
+       * Delivery address of the order.
+       * Changes to the delivery address apply to the upcoming invoice and to invoices created after the change.
+       * Issued invoices are not updated unless the order is `pending`.
+       * To change the delivery address on an unpaid, past-due, or partially paid invoice, use the [upsert an invoice API operation](https://www.rebilly.com/catalog/all/invoices/putinvoice#invoices/putinvoice/t=request&path=deliveryaddress).
+       */
       deliveryAddress?: reportsComponents["schemas"]["ContactObject"] | null;
       /**
        * Length of time, in ISO-8601 durations format,
@@ -105027,7 +105103,7 @@ declare module "resources/experimental/subscriptions-resource" {
         }): rebilly.GetSubscriptionSummaryMetricReportResponsePromise;
     };
 }
-declare module "resources/experimental/timelines-resource" {
+declare module "experimental/timelines-resource" {
     export default function TimelinesResource({ apiHandler }: {
         apiHandler: any;
     }): {
@@ -105036,7 +105112,7 @@ declare module "resources/experimental/timelines-resource" {
             limit?: number;
             offset?: number;
         }): any;
-        getTransaction({ id, eventTypes, limit, offset }: {
+        getTransaction({ id, eventTypes, limit, offset, }: {
             id?: string;
             eventTypes?: any;
             limit?: number;
@@ -105050,14 +105126,14 @@ declare module "resources/experimental/timelines-resource" {
         }): any;
     };
 }
-declare module "resources/experimental/location-resource" {
+declare module "experimental/location-resource" {
     export default function LocationResource({ apiHandler }: {
         apiHandler: any;
     }): {
         query(): any;
     };
 }
-declare module "resources/experimental/experimental-resources" {
+declare module "experimental/experimental-resources" {
     export class ExperimentalApiInstance {
         constructor({ apiHandler }: {
             apiHandler: any;
@@ -105333,7 +105409,7 @@ declare module "resources/experimental/experimental-resources" {
                 limit?: number;
                 offset?: number;
             }): any;
-            getTransaction({ id, eventTypes, limit, offset }: {
+            getTransaction({ id, eventTypes, limit, offset, }: {
                 id?: string;
                 eventTypes?: any;
                 limit?: number;
@@ -106043,7 +106119,7 @@ declare module "create-api-instance" {
         apiHandler: any;
     }): StorefrontApiInstance;
     import { ApiInstance } from "resources/api-instance";
-    import { ExperimentalApiInstance } from "resources/experimental/experimental-resources";
+    import { ExperimentalApiInstance } from "experimental/experimental-resources";
     import { StorefrontApiInstance } from "resources/storefront/storefront-api-instance";
 }
 declare module "rebilly-js-sdk" {
@@ -106069,7 +106145,7 @@ declare module "rebilly-js-sdk" {
         internalOptions?: InternalOptions;
     };
     import Errors from "errors/errors";
-    export function RebillyExperimentalAPI({ apiKey, sandbox, timeout, organizationId, urls, internalOptions, }?: ApiParams): import("resources/experimental/experimental-resources").ExperimentalApiInstance;
+    export function RebillyExperimentalAPI({ apiKey, sandbox, timeout, organizationId, urls, internalOptions, }?: ApiParams): import("experimental/experimental-resources").ExperimentalApiInstance;
     export function RebillyStorefrontAPI({ publishableKey, jwt, sandbox, timeout, organizationId, urls, internalOptions, }?: StorefrontApiParams): import("resources/storefront/storefront-api-instance").StorefrontApiInstance;
     import cancellation from "cancellation";
     export { Errors as RebillyErrors, cancellation };
@@ -106079,3 +106155,8 @@ declare module "request-headers" {
         let Accept: string;
     }
 }
+
+/** @deprecated Import from "experimental/experimental-resources" instead. */
+declare module "resources/experimental/experimental-resources" {
+    export * from "experimental/experimental-resources";
+}

package/dist/rebilly-js-sdk.es.mjs

@@ -489,7 +489,7 @@ function O({ options: t }) {
   }
   function o() {
     const a = {
-      "REB-API-CONSUMER": `${["Rebilly", t.appName, "js-sdk"].filter((m) => m).join("/")}@c669bc3`
+      "REB-API-CONSUMER": `${["Rebilly", t.appName, "js-sdk"].filter((m) => m).join("/")}@c040b79`
     };
     return t.apiKey && (a["REB-APIKEY"] = t.apiKey), a;
   }
@@ -4882,7 +4882,12 @@ function qs({ apiHandler: t }) {
       };
       return t.getAll("activity-feed", n);
     },
-    getTransaction({ id: e = "", eventTypes: s = null, limit: r = 1e3, offset: n = 0 }) {
+    getTransaction({
+      id: e = "",
+      eventTypes: s = null,
+      limit: r = 1e3,
+      offset: n = 0
+    }) {
       const u = {
         eventTypes: s,
         limit: r,
@@ -4918,11 +4923,17 @@ const b = {
 };
 class Ts {
   constructor({ apiHandler: e }) {
-    this.customers = b.CustomersResource({ apiHandler: e }), this.dataExports = b.DataExportsResource({
+    this.customers = b.CustomersResource({
+      apiHandler: e
+    }), this.dataExports = b.DataExportsResource({
+      apiHandler: e
+    }), this.histograms = b.HistogramsResource({
+      apiHandler: e
+    }), this.reports = b.ReportsResource({ apiHandler: e }), this.subscriptions = b.SubscriptionsResource({
       apiHandler: e
-    }), this.histograms = b.HistogramsResource({ apiHandler: e }), this.reports = b.ReportsResource({ apiHandler: e }), this.subscriptions = b.SubscriptionsResource({
+    }), this.timelines = b.TimelinesResource({
       apiHandler: e
-    }), this.timelines = b.TimelinesResource({ apiHandler: e }), this.location = b.LocationResource({ apiHandler: e }), this.addRequestInterceptor = e.addRequestInterceptor, this.removeRequestInterceptor = e.removeRequestInterceptor, this.addResponseInterceptor = e.addResponseInterceptor, this.removeResponseInterceptor = e.removeResponseInterceptor, this.setTimeout = e.setTimeout, this.setProxyAgent = e.setProxyAgent, this.setSessionToken = e.setSessionToken, this.setEndpoints = e.setEndpoints, this.getCancellationToken = e.getCancellationToken;
+    }), this.location = b.LocationResource({ apiHandler: e }), this.addRequestInterceptor = e.addRequestInterceptor, this.removeRequestInterceptor = e.removeRequestInterceptor, this.addResponseInterceptor = e.addResponseInterceptor, this.removeResponseInterceptor = e.removeResponseInterceptor, this.setTimeout = e.setTimeout, this.setProxyAgent = e.setProxyAgent, this.setSessionToken = e.setSessionToken, this.setEndpoints = e.setEndpoints, this.getCancellationToken = e.getCancellationToken;
   }
 }
 function Is({ apiHandler: t }) {