@spiffcommerce/core 11.1.2 → 11.2.0

package/dist/types.d.ts

@@ -1809,6 +1809,46 @@ export interface WorkflowExperience {
         [key: string]: string;
     }>;
 }
+/**
+ * A bundle serves as a container for a set of workflow experience.
+ */
+interface Bundle {
+    /**
+     * @returns The client that this bundle is associated with.
+     */
+    getClient(): SpiffCommerceClient;
+    /**
+     * @returns The id of the bundle entity in the Spiff Commerce system.
+     */
+    getId(): string;
+    /**
+     * Returns true when the bundle contains transactions with shared properties.
+     */
+    hasGlobalProperties(): boolean;
+    /**
+     * Get a handle to the global properties available within this bundle. Setting values
+     * via this method will make selections on all bundles that share the property.
+     */
+    getGlobalProperties(): any;
+    /**
+     * Add another workflow experience to this bundle.
+     * @param experience The workflow experience to add to this bundle.
+     */
+    addWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Remove a workflow experience from this bundle.
+     * @param experience The workflow experience to remove from this bundle.
+     */
+    removeWorkflowExperience(experience: WorkflowExperience): Promise<void>;
+    /**
+     * Sort the list of workflow experiences.
+     */
+    sortWorkflowExperiences(sortFunc: (expA: WorkflowExperience, expB: WorkflowExperience) => number): void;
+    /**
+     * @returns The number of workflow experiences in this bundle.
+     */
+    getWorkflowExperienceCount(): number;
+}
 export const getWorkflow: (id: string) => Promise<_Workflow1>;
 /**
  * Options that can be used during instantiation of the SpiffCommerce Javascript Client.
@@ -1906,6 +1946,16 @@ export class SpiffCommerceClient {
      * @returns True if the verification was successful, false otherwise.
      */
     verifyCode(emailAddress: string, verificationCode: string): Promise<boolean>;
+    /**
+     * @param configurationId The id of the configuration to be used for the bundle.
+     * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
+     */
+    getNewBundle(): Promise<Bundle>;
+    /**
+     * Retrieves an existing bundle from the API, by id.
+     * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
+     */
+    getExistingBundle(bundleId: string): Promise<Bundle>;
     /**
      * Creates a new instance of WorkflowExperience. A high level wrapper for workflows.
      * @param workflowId The id of the workflow to be run. Deprecated: Provide options instead.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "11.1.2",
+    "version": "11.2.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",