rebilly-js-sdk 60.0.4 → 60.2.0

package/CHANGELOG.md

@@ -1 +1,6 @@
-## [60.0.4](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v60.0.3...rebilly-js-sdk-v60.0.4) (2025-07-23)
+## [60.2.0](https://github.com/Rebilly/rebilly/compare/rebilly-js-sdk-v60.1.0...rebilly-js-sdk-v60.2.0) (2025-07-25)
+
+
+### Features
+
+* **api-metadata, rebilly-js-sdk:** Update resources based on latest api definitions ([#13800](https://github.com/Rebilly/rebilly/issues/13800)) ([7f48310](https://github.com/Rebilly/rebilly/commit/7f48310cbcb1e2d56dbcde9c51d6c32343b79f2f))

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

@@ -487,6 +487,25 @@ declare namespace rebilly {
   type PutJournalEntryResponse = operations['PutJournalEntry']['responses']['201']['content']['application/json']
   type PutJournalEntryResponsePromise = Promise<{fields: PutJournalEntryResponse}>
   
+  type GetJournalRecordCollectionBCRequest = operations['GetJournalRecordCollectionBC']['parameters'] & { id: string }
+  
+  type GetJournalRecordCollectionBCResponse = operations['GetJournalRecordCollectionBC']['responses']['200']['content']['application/json']
+  type GetJournalRecordCollectionBCResponsePromise = Promise<{fields: GetJournalRecordCollectionBCResponse}>
+  type PostJournalRecordBCRequest = operations['PostJournalRecordBC']['requestBody']['content']['application/json']
+  type CreateJournalRecordBCRequest = { id?: string,  data: PostJournalRecordBCRequest, expand?: string }
+  type PostJournalRecordBCResponse = operations['PostJournalRecordBC']['responses']['201']['content']['application/json']
+  type PostJournalRecordBCResponsePromise = Promise<{fields: PostJournalRecordBCResponse}>
+  
+  type GetJournalRecordBCRequest = { id: string,journalRecordId: string }
+
+  type GetJournalRecordBCResponse = operations['GetJournalRecordBC']['responses']['200']['content']['application/json']
+  type GetJournalRecordBCResponsePromise = Promise<{fields: GetJournalRecordBCResponse}>
+  type PutJournalRecordBCRequest = operations['PutJournalRecordBC']['requestBody']['content']['application/json']
+  type PutJournalRecordBCResponse = operations['PutJournalRecordBC']['responses']['201']['content']['application/json']
+  type PutJournalRecordBCResponsePromise = Promise<{fields: PutJournalRecordBCResponse}>
+  type DeleteJournalRecordBCResponse = operations['DeleteJournalRecordBC']['responses']['204']
+  type DeleteJournalRecordBCResponsePromise = Promise<{fields: DeleteJournalRecordBCResponse}>
+  
   type GetJournalRecordCollectionRequest = operations['GetJournalRecordCollection']['parameters']["query"] & (operations['GetJournalRecordCollection']['parameters'] extends {path: {}} ? operations['GetJournalRecordCollection']['parameters']["path"] : {}) & { id: string }
   
   type GetJournalRecordCollectionResponse = operations['GetJournalRecordCollection']['responses']['200']['content']['application/json'][0]
@@ -3094,6 +3113,34 @@ export interface corePaths {
     };
   };
   "/journal-entries/{id}/records": {
+    /** Retrieves a list of journal records. */
+    get: operations["GetJournalRecordCollectionBC"];
+    /** Creates a journal record. */
+    post: operations["PostJournalRecordBC"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+  };
+  "/journal-entries/{id}/records/{journalRecordId}": {
+    /** Retrieves a journal record with a specified ID. */
+    get: operations["GetJournalRecordBC"];
+    /** Creates or updates (upsert) a journal record. */
+    put: operations["PutJournalRecordBC"];
+    /** Deletes a journal record. */
+    delete: operations["DeleteJournalRecordBC"];
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** ID of the journal record. */
+        journalRecordId: coreComponents["parameters"]["journalRecordId"];
+      };
+    };
+  };
+  "/journal-entries/{id}/records/": {
     /** Retrieves a list of journal records. */
     get: operations["GetJournalRecordCollection"];
     /** Creates a journal record. */
@@ -3105,7 +3152,7 @@ export interface corePaths {
       };
     };
   };
-  "/journal-entries/{id}/records/{journalRecordId}": {
+  "/journal-entries/{id}/records/{journalRecordId}/": {
     /** Retrieves a journal record with a specified ID. */
     get: operations["GetJournalRecord"];
     /** Creates or updates (upsert) a journal record. */
@@ -6919,22 +6966,22 @@ export interface coreComponents {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        previousValue?: string;
-        newValue?: string;
+        previousValue?: { [key: string]: any };
+        newValue?: { [key: string]: any };
       }[];
     };
     TwoColumnsTimelineTable: coreComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     OneColumnTimelineTable: coreComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     ListTimelineTable: coreComponents["schemas"]["TimelineTable"] & {
@@ -7757,6 +7804,7 @@ export interface coreComponents {
           | "PandaGateway"
           | "Pay4Fun"
           | "PayCash"
+          | "Paycly"
           | "PayClub"
           | "PayCom"
           | "PayEcards"
@@ -8979,6 +9027,10 @@ export interface coreComponents {
         /** Type of link. */
         rel?: "self" | "customer" | "invoice";
       }[];
+      /** Embedded objects that are requested by the `expand` query parameter. */
+      _embedded?: {
+        customer?: { [key: string]: any };
+      };
     };
     /** Patch credit memo object. */
     PatchCreditMemo: {
@@ -12942,9 +12994,17 @@ export interface coreComponents {
     Usage: {
       /** ID of the usage record. */
       id?: string;
-      /** ID of the subscription for which a usage is reported. */
+      /**
+       * Subscription ID for which the usage is reported.
+       *
+       * > **Note:** Passing order ID in the `subscriptionId` field is deprecated and will be removed shortly. In the response, the order ID will be returned in this field until the deprecation is complete.
+       */
       subscriptionId: string;
-      /** ID of the plan for which a usage is reported. */
+      /**
+       * Leave this field blank and specify the subscription ID for which a usage is reported in the `subscriptionId` field.
+       *
+       * > **Note:** This field is deprecated and will be removed from this operation shortly. In the response, the plan ID will be returned in this field until the deprecation is complete.
+       */
       planId: string;
       /** ID of the invoice to which usage is applied. This value is populated when the invoice is issued. */
       invoiceId?: string | null;
@@ -28797,6 +28857,14 @@ export interface operations {
         offset?: coreComponents["parameters"]["collectionOffset"];
         /** Use this field to perform a partial search of text fields. */
         q?: coreComponents["parameters"]["collectionQuery"];
+        /**
+         * Expands a request to include embedded objects within the `_embedded`
+         * property of the response. This field accepts a comma-separated list of objects.
+         *
+         * For more information, see
+         * [Expand to include embedded objects](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
+         */
+        expand?: coreComponents["parameters"]["collectionExpand"];
       };
     };
     responses: {
@@ -29275,6 +29343,161 @@ export interface operations {
     };
   };
   /** Retrieves a list of journal records. */
+  GetJournalRecordCollectionBC: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+      query: {
+        /** Limits the number of collection items to be returned. */
+        limit?: coreComponents["parameters"]["collectionLimit"];
+        /** Specifies the starting point within the collection of items to be returned. */
+        offset?: coreComponents["parameters"]["collectionOffset"];
+        /**
+         * Filters the collection items. This field requires
+         * a special format. Use `,` for multiple allowed values.  Use `;` for multiple fields.
+         *
+         * For more information, see
+         * [Using filter with collections](https://www.rebilly.com/docs/dev-docs/search-filters).
+         */
+        filter?: coreComponents["parameters"]["collectionFilter"];
+        /**
+         * Sorts and orders the collection of items. To sort in descending
+         * order, prefix with `-`. Multiple fields can be sorted by separating each with `,`.
+         */
+        sort?: coreComponents["parameters"]["collectionSort"];
+        /**
+         * Expands a request to include embedded objects within the `_embedded`
+         * property of the response. This field accepts a comma-separated list of objects.
+         *
+         * For more information, see
+         * [Expand to include embedded objects](https://www.rebilly.com/docs/dev-docs/expand-embedded-resources).
+         */
+        expand?: coreComponents["parameters"]["collectionExpand"];
+      };
+    };
+    responses: {
+      /** List of journal records retrieved. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["JournalRecord"][];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+    };
+  };
+  /** Creates a journal record. */
+  PostJournalRecordBC: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+      };
+    };
+    responses: {
+      /** Journal record created. */
+      201: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["JournalRecord"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+    /** Journal record resource. */
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["JournalRecord"];
+      };
+    };
+  };
+  /** Retrieves a journal record with a specified ID. */
+  GetJournalRecordBC: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** ID of the journal record. */
+        journalRecordId: coreComponents["parameters"]["journalRecordId"];
+      };
+    };
+    responses: {
+      /** Journal record retrieved. */
+      200: {
+        content: {
+          "application/json": coreComponents["schemas"]["JournalRecord"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+    };
+  };
+  /** Creates or updates (upsert) a journal record. */
+  PutJournalRecordBC: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** ID of the journal record. */
+        journalRecordId: coreComponents["parameters"]["journalRecordId"];
+      };
+    };
+    responses: {
+      /** Journal record updated. */
+      200: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["JournalRecord"];
+        };
+      };
+      /** Journal record created. */
+      201: {
+        headers: {};
+        content: {
+          "application/json": coreComponents["schemas"]["JournalRecord"];
+        };
+      };
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+    /** Journal record resource. */
+    requestBody: {
+      content: {
+        "application/json": coreComponents["schemas"]["JournalRecord"];
+      };
+    };
+  };
+  /** Deletes a journal record. */
+  DeleteJournalRecordBC: {
+    parameters: {
+      path: {
+        /** ID of the resource. */
+        id: coreComponents["parameters"]["resourceId"];
+        /** ID of the journal record. */
+        journalRecordId: coreComponents["parameters"]["journalRecordId"];
+      };
+    };
+    responses: {
+      /** Journal record deleted. */
+      204: never;
+      401: coreComponents["responses"]["Unauthorized"];
+      403: coreComponents["responses"]["Forbidden"];
+      404: coreComponents["responses"]["NotFound"];
+      422: coreComponents["responses"]["ValidationError"];
+      429: coreComponents["responses"]["TooManyRequests"];
+    };
+  };
+  /** Retrieves a list of journal records. */
   GetJournalRecordCollection: {
     parameters: {
       path: {
@@ -40527,22 +40750,22 @@ export interface storefrontComponents {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        previousValue?: string;
-        newValue?: string;
+        previousValue?: { [key: string]: any };
+        newValue?: { [key: string]: any };
       }[];
     };
     TwoColumnsTimelineTable: storefrontComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     OneColumnTimelineTable: storefrontComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     ListTimelineTable: storefrontComponents["schemas"]["TimelineTable"] & {
@@ -41365,6 +41588,7 @@ export interface storefrontComponents {
           | "PandaGateway"
           | "Pay4Fun"
           | "PayCash"
+          | "Paycly"
           | "PayClub"
           | "PayCom"
           | "PayEcards"
@@ -42587,6 +42811,10 @@ export interface storefrontComponents {
         /** Type of link. */
         rel?: "self" | "customer" | "invoice";
       }[];
+      /** Embedded objects that are requested by the `expand` query parameter. */
+      _embedded?: {
+        customer?: { [key: string]: any };
+      };
     };
     /** Patch credit memo object. */
     PatchCreditMemo: {
@@ -46550,9 +46778,17 @@ export interface storefrontComponents {
     Usage: {
       /** ID of the usage record. */
       id?: string;
-      /** ID of the subscription for which a usage is reported. */
+      /**
+       * Subscription ID for which the usage is reported.
+       *
+       * > **Note:** Passing order ID in the `subscriptionId` field is deprecated and will be removed shortly. In the response, the order ID will be returned in this field until the deprecation is complete.
+       */
       subscriptionId: string;
-      /** ID of the plan for which a usage is reported. */
+      /**
+       * Leave this field blank and specify the subscription ID for which a usage is reported in the `subscriptionId` field.
+       *
+       * > **Note:** This field is deprecated and will be removed from this operation shortly. In the response, the plan ID will be returned in this field until the deprecation is complete.
+       */
       planId: string;
       /** ID of the invoice to which usage is applied. This value is populated when the invoice is issued. */
       invoiceId?: string | null;
@@ -63052,22 +63288,22 @@ export interface reportsComponents {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        previousValue?: string;
-        newValue?: string;
+        previousValue?: { [key: string]: any };
+        newValue?: { [key: string]: any };
       }[];
     };
     TwoColumnsTimelineTable: reportsComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     OneColumnTimelineTable: reportsComponents["schemas"]["TimelineTable"] & {
       /** Table data. Each array element represents a table row. */
       data?: {
         attribute?: string;
-        value?: string;
+        value?: { [key: string]: any };
       }[];
     };
     ListTimelineTable: reportsComponents["schemas"]["TimelineTable"] & {
@@ -63890,6 +64126,7 @@ export interface reportsComponents {
           | "PandaGateway"
           | "Pay4Fun"
           | "PayCash"
+          | "Paycly"
           | "PayClub"
           | "PayCom"
           | "PayEcards"
@@ -65112,6 +65349,10 @@ export interface reportsComponents {
         /** Type of link. */
         rel?: "self" | "customer" | "invoice";
       }[];
+      /** Embedded objects that are requested by the `expand` query parameter. */
+      _embedded?: {
+        customer?: { [key: string]: any };
+      };
     };
     /** Patch credit memo object. */
     PatchCreditMemo: {
@@ -69075,9 +69316,17 @@ export interface reportsComponents {
     Usage: {
       /** ID of the usage record. */
       id?: string;
-      /** ID of the subscription for which a usage is reported. */
+      /**
+       * Subscription ID for which the usage is reported.
+       *
+       * > **Note:** Passing order ID in the `subscriptionId` field is deprecated and will be removed shortly. In the response, the order ID will be returned in this field until the deprecation is complete.
+       */
       subscriptionId: string;
-      /** ID of the plan for which a usage is reported. */
+      /**
+       * Leave this field blank and specify the subscription ID for which a usage is reported in the `subscriptionId` field.
+       *
+       * > **Note:** This field is deprecated and will be removed from this operation shortly. In the response, the plan ID will be returned in this field until the deprecation is complete.
+       */
       planId: string;
       /** ID of the invoice to which usage is applied. This value is populated when the invoice is issued. */
       invoiceId?: string | null;
@@ -83765,7 +84014,7 @@ declare module "resources/credit-memos-resource" {
     export default function CreditMemosResource({ apiHandler }: {
         apiHandler: any;
     }): {
-        getAll({ filter, sort, limit, offset, q, }?: rebilly.GetCreditMemoCollectionRequest): rebilly.GetCreditMemoCollectionResponsePromise;
+        getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetCreditMemoCollectionRequest): rebilly.GetCreditMemoCollectionResponsePromise;
         create({ id, data }: rebilly.CreateCreditMemoRequest): rebilly.PostCreditMemoResponsePromise;
         get({ id }: {
             id: any;
@@ -84492,6 +84741,31 @@ declare module "resources/journal-entries-resource" {
             id: any;
             data: any;
         }): rebilly.PutJournalEntryResponsePromise;
+        getAllRecordsBC({ id, limit, offset, filter, sort, expand, }: {
+            id: any;
+            limit?: any;
+            offset?: any;
+            filter?: any;
+            sort?: any;
+            expand?: any;
+        }): rebilly.GetJournalRecordCollectionBCResponsePromise;
+        createRecordBC({ id, data }: {
+            id: any;
+            data: any;
+        }): any;
+        getRecordBC({ id, journalRecordId }: {
+            id: any;
+            journalRecordId: any;
+        }): rebilly.GetJournalRecordBCResponsePromise;
+        updateRecordBC({ id, journalRecordId, data }: {
+            id: any;
+            journalRecordId: any;
+            data: any;
+        }): rebilly.PutJournalRecordBCResponsePromise;
+        deleteRecordBC({ id, journalRecordId }: {
+            id: any;
+            journalRecordId: any;
+        }): any;
         getAllRecords({ id, limit, offset, filter, sort, expand, }: rebilly.GetJournalRecordCollectionRequest): rebilly.GetJournalRecordCollectionResponsePromise;
         createRecord({ id, data }: {
             id: any;
@@ -85536,7 +85810,7 @@ declare module "resources/api-instance" {
             }): any;
         };
         creditMemos: {
-            getAll({ filter, sort, limit, offset, q, }?: rebilly.GetCreditMemoCollectionRequest): rebilly.GetCreditMemoCollectionResponsePromise;
+            getAll({ filter, sort, limit, offset, q, expand, }?: rebilly.GetCreditMemoCollectionRequest): rebilly.GetCreditMemoCollectionResponsePromise;
             create({ id, data }: rebilly.CreateCreditMemoRequest): rebilly.PostCreditMemoResponsePromise;
             get({ id }: {
                 id: any;
@@ -86175,6 +86449,31 @@ declare module "resources/api-instance" {
                 id: any;
                 data: any;
             }): rebilly.PutJournalEntryResponsePromise;
+            getAllRecordsBC({ id, limit, offset, filter, sort, expand, }: {
+                id: any;
+                limit?: any;
+                offset?: any;
+                filter?: any;
+                sort?: any;
+                expand?: any;
+            }): rebilly.GetJournalRecordCollectionBCResponsePromise;
+            createRecordBC({ id, data }: {
+                id: any;
+                data: any;
+            }): any;
+            getRecordBC({ id, journalRecordId }: {
+                id: any;
+                journalRecordId: any;
+            }): rebilly.GetJournalRecordBCResponsePromise;
+            updateRecordBC({ id, journalRecordId, data }: {
+                id: any;
+                journalRecordId: any;
+                data: any;
+            }): rebilly.PutJournalRecordBCResponsePromise;
+            deleteRecordBC({ id, journalRecordId }: {
+                id: any;
+                journalRecordId: any;
+            }): any;
             getAllRecords({ id, limit, offset, filter, sort, expand, }: rebilly.GetJournalRecordCollectionRequest): rebilly.GetJournalRecordCollectionResponsePromise;
             createRecord({ id, data }: {
                 id: any;