@spiffcommerce/core 12.3.1 → 12.4.0

package/dist/types.d.ts

@@ -1019,6 +1019,7 @@ interface Bundle {
     }[];
     name?: string;
     partner?: Partner;
+    productCollection?: ProductCollection;
     transactions?: Transaction[];
 }
 interface BundleStakeholder {
@@ -1031,6 +1032,11 @@ interface BundleStakeholderInput {
     type: StakeholderType;
     customerDetails: CustomerDetailsInput;
 }
+type ProductCollection = {
+    id: string;
+    name: string;
+    products: Product[];
+};
 interface StorageService {
     /**
      * Get a value.
@@ -1893,6 +1899,11 @@ interface _Bundle1 {
      * Return the total in subunits for this bundle. This is the sum of the total for all individual transactions.
      */
     getTotalSubunits(): number;
+    /**
+     * Retrieves the product collection associated with this bundle.
+     * If the bundle is not associated with a product collection, this method will return undefined.
+     */
+    getProductCollection(): ProductCollection | undefined;
     /**
      * Add another workflow experience to this bundle.
      * @param experience The workflow experience to add to this bundle.
@@ -2034,10 +2045,10 @@ export class SpiffCommerceClient {
      */
     verifyCode(emailAddress: string, verificationCode: string): Promise<boolean>;
     /**
-     * @param configurationId The id of the configuration to be used for the bundle.
+     * @param collectionId Optional: The id of the product collection that the bundle can use.
      * @returns A bundle to be used for grouping and operating on large amounts of workflow experiences.
      */
-    getNewBundle(): Promise<_Bundle1>;
+    getNewBundle(collectionId?: string): Promise<_Bundle1>;
     /**
      * 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.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@spiffcommerce/core",
-    "version": "12.3.1",
+    "version": "12.4.0",
     "description": "Core client API for interacting with the Spiff Commerce backend.",
     "source": "src/index.ts",
     "main": "dist/main.js",
@@ -87,7 +87,7 @@
     },
     "dependencies": {
         "@apollo/client": "^3.7.0",
-        "@spiffcommerce/papyrus": "^2.0.4",
+        "@spiffcommerce/papyrus": "^2.0.5",
         "cross-fetch": "^3.1.5",
         "graphql": "^16.6.0",
         "lodash.clonedeep": "^4.5.0",