@elasticpath/js-sdk 7.0.0 → 8.0.0

package/dist/index.cjs.js

@@ -530,7 +530,7 @@ if (!globalThis.fetch) {
   globalThis.Response = fetch$1.Response;
 }
 
-var version = "7.0.0";
+var version = "8.0.0";
 
 var LocalStorageFactory = /*#__PURE__*/function () {
   function LocalStorageFactory() {
@@ -1801,6 +1801,53 @@ var PCMJobs = /*#__PURE__*/function (_CRUDExtend) {
   return PCMJobs;
 }(CRUDExtend);
 
+var PCMCustomRelationshipEndpoint = /*#__PURE__*/function () {
+  function PCMCustomRelationshipEndpoint(endpoint) {
+    _classCallCheck(this, PCMCustomRelationshipEndpoint);
+    var config = _objectSpread2({}, endpoint);
+    this.request = new RequestFactory(config);
+    config.version = 'pcm';
+    this.endpoint = 'custom-relationships';
+  }
+  _createClass(PCMCustomRelationshipEndpoint, [{
+    key: "All",
+    value: function All(productId) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'GET');
+    }
+  }, {
+    key: "AttachCustomRelationship",
+    value: function AttachCustomRelationship(productId, body) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'POST', body);
+    }
+  }, {
+    key: "DetachCustomRelationship",
+    value: function DetachCustomRelationship(productId, body) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'DELETE', body);
+    }
+  }, {
+    key: "AssociateProductsToCustomRelationship",
+    value: function AssociateProductsToCustomRelationship(productId, customRelationshipSlug, productsToAssociate) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'POST', productsToAssociate);
+    }
+  }, {
+    key: "DissociateProductsFromCustomRelationship",
+    value: function DissociateProductsFromCustomRelationship(productId, customRelationshipSlug, productsToDissociate) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'DELETE', productsToDissociate);
+    }
+  }, {
+    key: "GetProductsForCustomRelationship",
+    value: function GetProductsForCustomRelationship(productId, customRelationshipSlug) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug, "/products"), 'GET');
+    }
+  }, {
+    key: "GetProductIdsForCustomRelationship",
+    value: function GetProductIdsForCustomRelationship(productId, customRelationshipSlug) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'GET');
+    }
+  }]);
+  return PCMCustomRelationshipEndpoint;
+}();
+
 var PCMEndpoint = /*#__PURE__*/function (_CRUDExtend) {
   _inherits(PCMEndpoint, _CRUDExtend);
   var _super = _createSuper(PCMEndpoint);
@@ -1814,6 +1861,7 @@ var PCMEndpoint = /*#__PURE__*/function (_CRUDExtend) {
     _this.VariationsRelationships = new PCMVariationsRelationshipsEndpoint(config);
     _this.TemplateRelationships = new PCMTemplateRelationshipEndpoint(config);
     _this.MainImageRelationships = new PCMMainImageRelationshipEndpoint(config);
+    _this.CustomRelationships = new PCMCustomRelationshipEndpoint(config);
     _this.Jobs = new PCMJobs(config);
     _this.endpoint = 'products';
     return _this;

package/dist/index.d.ts

@@ -673,6 +673,221 @@ interface PcmMainImageRelationshipEndpoint {
   ): Promise<void>
 }
 
+/**
+ * Custom Relationships
+ * Description: Custom Relationships
+ */
+
+
+interface CustomRelationshipBaseAttributes {
+  name: string
+  description?: string
+  slug: string
+}
+
+interface CustomRelationshipBase {
+  type: 'custom-relationship'
+  attributes: CustomRelationshipBaseAttributes
+  meta: {
+    owner: 'organization' | 'store'
+    timestamps: {
+      created_at: string
+      updated_at: string
+    }
+  }
+}
+
+interface CustomRelationship
+  extends Identifiable,
+    CustomRelationshipBase {}
+
+interface CreateCustomRelationshipBody
+  extends Pick<CustomRelationshipBase, 'attributes'> {}
+
+interface UpdateCustomRelationshipBody
+  extends Identifiable,
+    Pick<CustomRelationshipBase, 'attributes'> {}
+
+interface CustomRelationshipsFilter {
+  eq?: {
+    owner?: 'organization' | 'store'
+  }
+}
+
+interface CustomRelationshipsListResponse
+  extends ResourceList<CustomRelationship> {
+  links?: { [key: string]: string | null } | {}
+  meta: {
+    results: {
+      total: number
+    }
+  }
+}
+
+interface CustomRelationshipsEndpoint {
+  endpoint: 'custom-relationships'
+  /**
+   * List Custom Relationships
+   */
+  All(): Promise<CustomRelationshipsListResponse>
+
+  /**
+   * Get Custom Relationship
+   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
+   */
+  Get(slug: string): Promise<Resource<CustomRelationship>>
+
+  /**
+   * Create Custom Relationship
+   * @param body - The base attributes of the Custom Relationships
+   */
+  Create(
+    body: CreateCustomRelationshipBody
+  ): Promise<Resource<CustomRelationship>>
+
+  /**
+   * Update Custom Relationship
+   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
+   * @param body - The base attributes of the Custom Relationships.
+   * The Slug attribute cannot be updated and the slug within this object should match this function's first argument.
+   */
+  Update(
+    slug: string,
+    body: UpdateCustomRelationshipBody
+  ): Promise<Resource<CustomRelationship>>
+
+  /**
+   * Delete Custom Relationship
+   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
+   */
+  Delete(slug: string): Promise<{}>
+
+  /**
+   * Custom Relationship filtering
+   * @param filter - The filter object.
+   * Currently supports the 'eq' filter operator for the 'owner' field of the Custom Relationship.
+   */
+  Filter(filter: CustomRelationshipsFilter): CustomRelationshipsEndpoint
+
+  Limit(value: number): CustomRelationshipsEndpoint
+
+  Offset(value: number): CustomRelationshipsEndpoint
+}
+
+/**
+ * Product Custom Relationships
+ */
+
+
+interface PcmProductEntry extends Identifiable {
+  type: 'product'
+}
+
+interface CustomRelationshipEntry {
+  type: 'custom-relationship'
+  slug: string
+}
+
+interface PcmRelatedProductResponse<T> extends ResourceList<T> {
+  meta: {
+    results: {
+      total: number
+    }
+  }
+}
+
+interface NonAssociatedProductEntry extends Identifiable {
+    details: string
+}
+
+interface ProductAssociationResponse {
+  meta: {
+    associated_products: string[]
+    products_not_associated: NonAssociatedProductEntry[]
+    owner: 'organization' | 'store'
+    timestamps: {
+      created_at: string
+      updated_at: string
+    }
+  }
+}
+
+interface PcmCustomRelationshipEndpoint {
+  endpoint: 'custom-relationships'
+
+  /**
+   * Get all of a product's custom relationships
+   * @param productId
+   */
+  All(productId: string): Promise<CustomRelationshipsListResponse>
+
+  /**
+   * Attach a custom relationship to a product
+   * @param productId
+   * @param body
+   */
+  AttachCustomRelationship(
+    productId: string,
+    body: CustomRelationshipEntry
+  ): Promise<CustomRelationshipsListResponse>
+
+  /**
+   * Detach one or multiple custom relationships from a product
+   * @param productId
+   * @param body
+   */
+  DetachCustomRelationship(
+    productId: string,
+    body: CustomRelationshipEntry[]
+  ): Promise<void>
+
+  /**
+   * Associate a product with other products under a custom relationship
+   * @param productId
+   * @param customRelationshipSlug
+   * @param productsToAssociate
+   * @returns
+   */
+  AssociateProductsToCustomRelationship(
+    productId: string,
+    customRelationshipSlug: string,
+    productsToAssociate: PcmProductEntry[]
+  ): Promise<ProductAssociationResponse>
+
+  /**
+   * Dissociate related products from a product under a custom relationship
+   * @param productId
+   * @param customRelationshipSlug
+   * @param productsToDissociate
+   */
+  DissociateProductsFromCustomRelationship(
+    productId: string,
+    customRelationshipSlug: string,
+    productsToDissociate: PcmProductEntry[]
+  ): Promise<void>
+
+  /**
+   * Get all related products of a product under a custom relationship
+   * @param productId
+   * @param customRelationshipSlug
+   */
+  GetProductsForCustomRelationship(
+    productId: string,
+    customRelationshipSlug: string
+  ): Promise<PcmRelatedProductResponse<PcmProduct>>
+
+  /**
+   * Get all IDs of a product's related products under a custom relationship
+   * @param productId
+   * @param customRelationshipSlug
+   *  TODO CHECK RETURN VALUE
+   */
+  GetProductIdsForCustomRelationship(
+    productId: string,
+    customRelationshipSlug: string
+  ): Promise<PcmRelatedProductResponse<PcmProductEntry>>
+}
+
 /**
  * PCM Jobs
  */
@@ -1146,6 +1361,7 @@ interface PcmProductsEndpoint
   TemplateRelationships: PcmTemplateRelationshipEndpoint
   VariationsRelationships: PcmVariationsRelationshipsEndpoint
   MainImageRelationships: PcmMainImageRelationshipEndpoint
+  CustomRelationships: PcmCustomRelationshipEndpoint
   Jobs: PcmJobsEndpoint
 
   Limit(value: number): PcmProductsEndpoint
@@ -8226,107 +8442,6 @@ interface SubscriptionProrationPoliciesEndpoint
   endpoint: 'proration-policies'
 }
 
-/**
- * Custom Relationships
- * Description: Custom Relationships
- */
-
-
-interface CustomRelationshipBaseAttributes {
-  name: string
-  description?: string
-  slug: string
-}
-
-interface CustomRelationshipBase {
-  type: 'custom-relationship'
-  attributes: CustomRelationshipBaseAttributes
-  meta: {
-    owner: 'organization' | 'store'
-    timestamps: {
-      created_at: string
-      updated_at: string
-    }
-  }
-}
-
-interface CustomRelationship
-  extends Identifiable,
-    CustomRelationshipBase {}
-
-interface CreateCustomRelationshipBody
-  extends Pick<CustomRelationshipBase, 'attributes'> {}
-
-interface UpdateCustomRelationshipBody
-  extends Identifiable,
-    Pick<CustomRelationshipBase, 'attributes'> {}
-
-interface CustomRelationshipsFilter {
-  eq?: {
-    owner?: 'organization' | 'store'
-  }
-}
-
-interface CustomRelationshipsListResponse
-  extends ResourceList<CustomRelationship> {
-  links?: { [key: string]: string | null } | {}
-  meta: {
-    results: {
-      total: number
-    }
-  }
-}
-
-interface CustomRelationshipsEndpoint {
-  endpoint: 'custom-relationships'
-  /**
-   * List Custom Relationships
-   */
-  All(): Promise<CustomRelationshipsListResponse>
-
-  /**
-   * Get Custom Relationship
-   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
-   */
-  Get(slug: string): Promise<Resource<CustomRelationship>>
-
-  /**
-   * Create Custom Relationship
-   * @param body - The base attributes of the Custom Relationships
-   */
-  Create(
-    body: CreateCustomRelationshipBody
-  ): Promise<Resource<CustomRelationship>>
-
-  /**
-   * Update Custom Relationship
-   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
-   * @param body - The base attributes of the Custom Relationships.
-   * The Slug attribute cannot be updated and the slug within this object should match this function's first argument.
-   */
-  Update(
-    slug: string,
-    body: UpdateCustomRelationshipBody
-  ): Promise<Resource<CustomRelationship>>
-
-  /**
-   * Delete Custom Relationship
-   * @param slug - The slug of the Custom Relationship. It should always be prefixed with 'CRP_'
-   */
-  Delete(slug: string): Promise<{}>
-
-  /**
-   * Custom Relationship filtering
-   * @param filter - The filter object.
-   * Currently supports the 'eq' filter operator for the 'owner' field of the Custom Relationship.
-   */
-  Filter(filter: CustomRelationshipsFilter): CustomRelationshipsEndpoint
-
-  Limit(value: number): CustomRelationshipsEndpoint
-
-  Offset(value: number): CustomRelationshipsEndpoint
-}
-
 // Type definitions for @elasticpath/js-sdk
 
 

package/dist/index.esm.js

@@ -519,7 +519,7 @@ if (!globalThis.fetch) {
   globalThis.Response = Response;
 }
 
-var version = "7.0.0";
+var version = "8.0.0";
 
 var LocalStorageFactory = /*#__PURE__*/function () {
   function LocalStorageFactory() {
@@ -1790,6 +1790,53 @@ var PCMJobs = /*#__PURE__*/function (_CRUDExtend) {
   return PCMJobs;
 }(CRUDExtend);
 
+var PCMCustomRelationshipEndpoint = /*#__PURE__*/function () {
+  function PCMCustomRelationshipEndpoint(endpoint) {
+    _classCallCheck(this, PCMCustomRelationshipEndpoint);
+    var config = _objectSpread2({}, endpoint);
+    this.request = new RequestFactory(config);
+    config.version = 'pcm';
+    this.endpoint = 'custom-relationships';
+  }
+  _createClass(PCMCustomRelationshipEndpoint, [{
+    key: "All",
+    value: function All(productId) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'GET');
+    }
+  }, {
+    key: "AttachCustomRelationship",
+    value: function AttachCustomRelationship(productId, body) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'POST', body);
+    }
+  }, {
+    key: "DetachCustomRelationship",
+    value: function DetachCustomRelationship(productId, body) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'DELETE', body);
+    }
+  }, {
+    key: "AssociateProductsToCustomRelationship",
+    value: function AssociateProductsToCustomRelationship(productId, customRelationshipSlug, productsToAssociate) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'POST', productsToAssociate);
+    }
+  }, {
+    key: "DissociateProductsFromCustomRelationship",
+    value: function DissociateProductsFromCustomRelationship(productId, customRelationshipSlug, productsToDissociate) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'DELETE', productsToDissociate);
+    }
+  }, {
+    key: "GetProductsForCustomRelationship",
+    value: function GetProductsForCustomRelationship(productId, customRelationshipSlug) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug, "/products"), 'GET');
+    }
+  }, {
+    key: "GetProductIdsForCustomRelationship",
+    value: function GetProductIdsForCustomRelationship(productId, customRelationshipSlug) {
+      return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'GET');
+    }
+  }]);
+  return PCMCustomRelationshipEndpoint;
+}();
+
 var PCMEndpoint = /*#__PURE__*/function (_CRUDExtend) {
   _inherits(PCMEndpoint, _CRUDExtend);
   var _super = _createSuper(PCMEndpoint);
@@ -1803,6 +1850,7 @@ var PCMEndpoint = /*#__PURE__*/function (_CRUDExtend) {
     _this.VariationsRelationships = new PCMVariationsRelationshipsEndpoint(config);
     _this.TemplateRelationships = new PCMTemplateRelationshipEndpoint(config);
     _this.MainImageRelationships = new PCMMainImageRelationshipEndpoint(config);
+    _this.CustomRelationships = new PCMCustomRelationshipEndpoint(config);
     _this.Jobs = new PCMJobs(config);
     _this.endpoint = 'products';
     return _this;

package/dist/index.js

@@ -1085,7 +1085,7 @@
     globalThis.Response = browserPonyfill.exports.Response;
   }
 
-  var version = "7.0.0";
+  var version = "8.0.0";
 
   var LocalStorageFactory = /*#__PURE__*/function () {
     function LocalStorageFactory() {
@@ -2958,6 +2958,53 @@
     return PCMJobs;
   }(CRUDExtend);
 
+  var PCMCustomRelationshipEndpoint = /*#__PURE__*/function () {
+    function PCMCustomRelationshipEndpoint(endpoint) {
+      _classCallCheck(this, PCMCustomRelationshipEndpoint);
+      var config = _objectSpread2({}, endpoint);
+      this.request = new RequestFactory(config);
+      config.version = 'pcm';
+      this.endpoint = 'custom-relationships';
+    }
+    _createClass(PCMCustomRelationshipEndpoint, [{
+      key: "All",
+      value: function All(productId) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'GET');
+      }
+    }, {
+      key: "AttachCustomRelationship",
+      value: function AttachCustomRelationship(productId, body) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'POST', body);
+      }
+    }, {
+      key: "DetachCustomRelationship",
+      value: function DetachCustomRelationship(productId, body) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint), 'DELETE', body);
+      }
+    }, {
+      key: "AssociateProductsToCustomRelationship",
+      value: function AssociateProductsToCustomRelationship(productId, customRelationshipSlug, productsToAssociate) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'POST', productsToAssociate);
+      }
+    }, {
+      key: "DissociateProductsFromCustomRelationship",
+      value: function DissociateProductsFromCustomRelationship(productId, customRelationshipSlug, productsToDissociate) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'DELETE', productsToDissociate);
+      }
+    }, {
+      key: "GetProductsForCustomRelationship",
+      value: function GetProductsForCustomRelationship(productId, customRelationshipSlug) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug, "/products"), 'GET');
+      }
+    }, {
+      key: "GetProductIdsForCustomRelationship",
+      value: function GetProductIdsForCustomRelationship(productId, customRelationshipSlug) {
+        return this.request.send("products/".concat(productId, "/").concat(this.endpoint, "/").concat(customRelationshipSlug), 'GET');
+      }
+    }]);
+    return PCMCustomRelationshipEndpoint;
+  }();
+
   var PCMEndpoint = /*#__PURE__*/function (_CRUDExtend) {
     _inherits(PCMEndpoint, _CRUDExtend);
     var _super = _createSuper(PCMEndpoint);
@@ -2971,6 +3018,7 @@
       _this.VariationsRelationships = new PCMVariationsRelationshipsEndpoint(config);
       _this.TemplateRelationships = new PCMTemplateRelationshipEndpoint(config);
       _this.MainImageRelationships = new PCMMainImageRelationshipEndpoint(config);
+      _this.CustomRelationships = new PCMCustomRelationshipEndpoint(config);
       _this.Jobs = new PCMJobs(config);
       _this.endpoint = 'products';
       return _this;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@elasticpath/js-sdk",
   "description": "SDK for the Elastic Path eCommerce API",
-  "version": "7.0.0",
+  "version": "8.0.0",
   "homepage": "https://github.com/elasticpath/js-sdk",
   "author": "Elastic Path (https://elasticpath.com/)",
   "files": [