@spiffcommerce/core 22.12.0 → 22.13.0

package/dist/index.d.ts

@@ -1941,6 +1941,27 @@ declare class SpiffCommerceClient {
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
     duplicateBundle(bundleId: string, template?: boolean, duplicateTransactions?: boolean, options?: GetBundleOptions): Promise<Bundle$1>;
+    /**
+     * Fetches information about the currently authenticated customer's bundles.
+     * NOTE: This does not initialize a bundle for active use.
+     * You must call either `getExistingBundle` or `duplicateBundle` to actually interact with a bundle.
+     * @param options Options to configure the request.
+     * @returns A promise that resolves with an object containing:
+     * `items` - The bundles that matched the request.
+     * `total` - The total number of bundles on the server that match this query.
+     */
+    getBundlesForCustomer(options: {
+        /** Whether to include each bundle's metadata in the response. */
+        includeMetadata?: boolean;
+        /** The maximum amount of bundles to return in the response. */
+        limit: number;
+        /** The amount of items to skip over in the server query. */
+        offset: number;
+        /** Undefined: Any bundle, template or not. True: The bundle must be a template. False: The bundle must not be a template */
+        template?: boolean;
+        /** The status of the bundle template; "Active" or "Draft". */
+        templateStatus?: BundleTemplateStatus;
+    }): Promise<BundlesFeed>;
     /**
      * Retrieves all existing bundle stakeholders from the API, for the currently authenticated customer.
      * @returns An array of bundle stakeholders.
@@ -2782,6 +2803,19 @@ interface Stakeholder {
     transaction?: Transaction;
     customer?: Customer;
 }
+/**
+ * A wrapper for a list of bundles returned from the server.
+ */
+interface BundlesFeed {
+    /** The items. The size of this array will typically be limited by the request. */
+    items: Bundle[];
+    /** The total number of items available on the server that matched the initial request. */
+    total: number;
+}
+declare enum BundleTemplateStatus {
+    Draft = "Draft",
+    Active = "Active"
+}
 interface Bundle {
     id?: string;
     bundleOwnerId?: string;
@@ -2795,6 +2829,8 @@ interface Bundle {
     partner?: Partner;
     productCollection?: ProductCollectionResource;
     transactions?: Transaction[];
+    template?: boolean;
+    templateStatus?: BundleTemplateStatus;
 }
 interface BundleStakeholder {
     id: string;