@gofynd/fdk-client-javascript 1.4.5 → 1.4.7

package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts

@@ -44,8 +44,8 @@ export = CatalogPlatformValidator;
  */
 /**
  * @typedef CreateMarketplaceOptinParam
- * @property {string} marketplace - The marketplace for which the detail needs
- *   to be retrieved.
+ * @property {string} marketplaceSlug - The marketplace for which the detail
+ *   needs to be retrieved.
  * @property {CatalogPlatformModel.OptInPostRequest} body
  */
 /**
@@ -162,9 +162,25 @@ export = CatalogPlatformValidator;
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
+ * @property {string} [pageId] - Alphanumeric Page ID to retrieve next set of results.
+ * @property {string} [pageType] - Available pagination types are cursor or number.
  * @property {string} [q] - Search with help of store code.
  * @property {boolean} [sellable] - Filter on whether product is in stock or not.
  * @property {number[]} [storeIds] - The Store Id of products to fetch inventory.
+ * @property {number[]} [brandIds] - The Brand Id of products to fetch inventory.
+ * @property {string[]} [sellerIdentifiers] - The Seller Identifier or Primary
+ *   Identifier of the inventory.
+ * @property {number} [qtyGt] - This field allows you to filter for inventories
+ *   that have quantity greater than to the specified value based on qty_type filter.
+ * @property {number} [qtyLt] - This field allows you to filter for inventories
+ *   that have a quantity less than to the specified value based on qty_type filter.
+ * @property {string} [qtyType] - This field provides flexibility in selecting
+ *   filter for inventory quantity counts and date queries. For example, you
+ *   might use this field to specify "total" or "sellable" quantity.
+ * @property {string} [fromDate] - Inventory updated on filter to get
+ *   inventories greater then or equal to provided date based on qty_type value.
+ * @property {string} [toDate] - Inventory updated on filter to get inventories
+ *   less then or equal to provided date based on qty_type value.
  * @property {string} [sizeIdentifier] - Size Identifier (Seller Identifier or
  *   Primary Identifier) of which inventory is to get.
  */
@@ -174,6 +190,7 @@ export = CatalogPlatformValidator;
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
+ * @property {string} [search] - Search string to filter the results by batch id
  */
 /**
  * @typedef GetInventoryBySizeParam
@@ -420,7 +437,7 @@ export = CatalogPlatformValidator;
  * @property {string} department - Department of the product to be uploaded.
  * @property {string} productType - Product type of the product to be uploaded
  *   i.e. set, standard , digital.
- * @property {CatalogPlatformModel.BulkJob} body
+ * @property {CatalogPlatformModel.BulkProductJob} body
  */
 /**
  * @typedef ValidateProductTemplateParam
@@ -645,10 +662,10 @@ type CreateInventoryExportJobParam = {
 };
 type CreateMarketplaceOptinParam = {
     /**
-     * - The marketplace for which the detail needs
-     * to be retrieved.
+     * - The marketplace for which the detail
+     * needs to be retrieved.
      */
-    marketplace: string;
+    marketplaceSlug: string;
     body: CatalogPlatformModel.OptInPostRequest;
 };
 type CreateProductParam = {
@@ -834,6 +851,14 @@ type GetInventoriesParam = {
      * Default is 12.
      */
     pageSize?: number;
+    /**
+     * - Alphanumeric Page ID to retrieve next set of results.
+     */
+    pageId?: string;
+    /**
+     * - Available pagination types are cursor or number.
+     */
+    pageType?: string;
     /**
      * - Search with help of store code.
      */
@@ -846,6 +871,41 @@ type GetInventoriesParam = {
      * - The Store Id of products to fetch inventory.
      */
     storeIds?: number[];
+    /**
+     * - The Brand Id of products to fetch inventory.
+     */
+    brandIds?: number[];
+    /**
+     * - The Seller Identifier or Primary
+     * Identifier of the inventory.
+     */
+    sellerIdentifiers?: string[];
+    /**
+     * - This field allows you to filter for inventories
+     * that have quantity greater than to the specified value based on qty_type filter.
+     */
+    qtyGt?: number;
+    /**
+     * - This field allows you to filter for inventories
+     * that have a quantity less than to the specified value based on qty_type filter.
+     */
+    qtyLt?: number;
+    /**
+     * - This field provides flexibility in selecting
+     * filter for inventory quantity counts and date queries. For example, you
+     * might use this field to specify "total" or "sellable" quantity.
+     */
+    qtyType?: string;
+    /**
+     * - Inventory updated on filter to get
+     * inventories greater then or equal to provided date based on qty_type value.
+     */
+    fromDate?: string;
+    /**
+     * - Inventory updated on filter to get inventories
+     * less then or equal to provided date based on qty_type value.
+     */
+    toDate?: string;
     /**
      * - Size Identifier (Seller Identifier or
      * Primary Identifier) of which inventory is to get.
@@ -863,6 +923,10 @@ type GetInventoryBulkUploadHistoryParam = {
      * Default is 12.
      */
     pageSize?: number;
+    /**
+     * - Search string to filter the results by batch id
+     */
+    search?: string;
 };
 type GetInventoryBySizeParam = {
     /**
@@ -1345,7 +1409,7 @@ type UploadBulkProductsParam = {
      * i.e. set, standard , digital.
      */
     productType: string;
-    body: CatalogPlatformModel.BulkJob;
+    body: CatalogPlatformModel.BulkProductJob;
 };
 type ValidateProductTemplateParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -57,8 +57,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 
 /**
  * @typedef CreateMarketplaceOptinParam
- * @property {string} marketplace - The marketplace for which the detail needs
- *   to be retrieved.
+ * @property {string} marketplaceSlug - The marketplace for which the detail
+ *   needs to be retrieved.
  * @property {CatalogPlatformModel.OptInPostRequest} body
  */
 
@@ -199,9 +199,25 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
+ * @property {string} [pageId] - Alphanumeric Page ID to retrieve next set of results.
+ * @property {string} [pageType] - Available pagination types are cursor or number.
  * @property {string} [q] - Search with help of store code.
  * @property {boolean} [sellable] - Filter on whether product is in stock or not.
  * @property {number[]} [storeIds] - The Store Id of products to fetch inventory.
+ * @property {number[]} [brandIds] - The Brand Id of products to fetch inventory.
+ * @property {string[]} [sellerIdentifiers] - The Seller Identifier or Primary
+ *   Identifier of the inventory.
+ * @property {number} [qtyGt] - This field allows you to filter for inventories
+ *   that have quantity greater than to the specified value based on qty_type filter.
+ * @property {number} [qtyLt] - This field allows you to filter for inventories
+ *   that have a quantity less than to the specified value based on qty_type filter.
+ * @property {string} [qtyType] - This field provides flexibility in selecting
+ *   filter for inventory quantity counts and date queries. For example, you
+ *   might use this field to specify "total" or "sellable" quantity.
+ * @property {string} [fromDate] - Inventory updated on filter to get
+ *   inventories greater then or equal to provided date based on qty_type value.
+ * @property {string} [toDate] - Inventory updated on filter to get inventories
+ *   less then or equal to provided date based on qty_type value.
  * @property {string} [sizeIdentifier] - Size Identifier (Seller Identifier or
  *   Primary Identifier) of which inventory is to get.
  */
@@ -212,6 +228,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 12.
+ * @property {string} [search] - Search string to filter the results by batch id
  */
 
 /**
@@ -498,7 +515,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  * @property {string} department - Department of the product to be uploaded.
  * @property {string} productType - Product type of the product to be uploaded
  *   i.e. set, standard , digital.
- * @property {CatalogPlatformModel.BulkJob} body
+ * @property {CatalogPlatformModel.BulkProductJob} body
  */
 
 /**
@@ -595,7 +612,7 @@ class CatalogPlatformValidator {
   /** @returns {CreateMarketplaceOptinParam} */
   static createMarketplaceOptin() {
     return Joi.object({
-      marketplace: Joi.string().allow("").required(),
+      marketplaceSlug: Joi.string().allow("").required(),
       body: CatalogPlatformModel.OptInPostRequest().required(),
     }).required();
   }
@@ -778,9 +795,18 @@ class CatalogPlatformValidator {
       size: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      pageId: Joi.string().allow(""),
+      pageType: Joi.string().allow(""),
       q: Joi.string().allow(""),
       sellable: Joi.boolean(),
       storeIds: Joi.array().items(Joi.number()),
+      brandIds: Joi.array().items(Joi.number()),
+      sellerIdentifiers: Joi.array().items(Joi.string().allow("")),
+      qtyGt: Joi.number(),
+      qtyLt: Joi.number(),
+      qtyType: Joi.string().allow(""),
+      fromDate: Joi.string().allow(""),
+      toDate: Joi.string().allow(""),
       sizeIdentifier: Joi.string().allow(""),
     }).required();
   }
@@ -790,6 +816,7 @@ class CatalogPlatformValidator {
     return Joi.object({
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      search: Joi.string().allow(""),
     }).required();
   }
 
@@ -1124,7 +1151,7 @@ class CatalogPlatformValidator {
     return Joi.object({
       department: Joi.string().allow("").required(),
       productType: Joi.string().allow("").required(),
-      body: CatalogPlatformModel.BulkJob().required(),
+      body: CatalogPlatformModel.BulkProductJob().required(),
     }).required();
   }
 

package/sdk/platform/Content/ContentPlatformModel.d.ts

@@ -189,6 +189,7 @@ export = ContentPlatformModel;
  * @property {boolean} [published]
  * @property {string} [reading_time]
  * @property {string} [slug]
+ * @property {string} [publish_date]
  * @property {string[]} [tags]
  * @property {SEO} [seo]
  * @property {CronSchedule} [_schedule]
@@ -1446,6 +1447,7 @@ type BlogSchema = {
     published?: boolean;
     reading_time?: string;
     slug?: string;
+    publish_date?: string;
     tags?: string[];
     seo?: SEO;
     _schedule?: CronSchedule;

package/sdk/platform/Content/ContentPlatformModel.js

@@ -215,6 +215,7 @@ const Joi = require("joi");
  * @property {boolean} [published]
  * @property {string} [reading_time]
  * @property {string} [slug]
+ * @property {string} [publish_date]
  * @property {string[]} [tags]
  * @property {SEO} [seo]
  * @property {CronSchedule} [_schedule]
@@ -1651,6 +1652,7 @@ class ContentPlatformModel {
       published: Joi.boolean(),
       reading_time: Joi.string().allow(""),
       slug: Joi.string().allow(""),
+      publish_date: Joi.string().allow(""),
       tags: Joi.array().items(Joi.string().allow("")),
       seo: ContentPlatformModel.SEO(),
       _schedule: ContentPlatformModel.CronSchedule(),

package/sdk/platform/Order/OrderPlatformClient.d.ts

@@ -73,7 +73,7 @@ declare class Order {
      * @summary: Dispatch manifest
      * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
      */
-    dispatchManifests({ manifestId, body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
+    dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
     /**
      * @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -159,6 +159,16 @@ declare class Order {
      * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
      */
     generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
+    /**
+     * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
+     * @name generateProcessManifest
+     * @summary: Process Order Manifest
+     * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
+     */
+    generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
     /**
      * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Order/OrderPlatformClient.js

@@ -524,12 +524,11 @@ class Order {
    * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
    */
   async dispatchManifests(
-    { manifestId, body, requestHeaders } = { requestHeaders: {} },
+    { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = OrderPlatformValidator.dispatchManifests().validate(
       {
-        manifestId,
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -543,7 +542,6 @@ class Order {
       error: warrning,
     } = OrderPlatformValidator.dispatchManifests().validate(
       {
-        manifestId,
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -562,7 +560,7 @@ class Order {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/${manifestId}/dispatch`,
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/dispatch`,
       query_params,
       body,
       { ...xHeaders, ...requestHeaders },
@@ -1247,6 +1245,85 @@ class Order {
     return response;
   }
 
+  /**
+   * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
+   * @name generateProcessManifest
+   * @summary: Process Order Manifest
+   * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
+   */
+  async generateProcessManifest(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = OrderPlatformValidator.generateProcessManifest().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = OrderPlatformValidator.generateProcessManifest().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Order > generateProcessManifest \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const xHeaders = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/process-manifest`,
+      query_params,
+      body,
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = OrderPlatformModel.ManifestResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Order > generateProcessManifest \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2376,7 +2453,7 @@ class Order {
     const response = await PlatformAPIClient.execute(
       this.config,
       "get",
-      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifests/shipments`,
+      `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/shipments-listing`,
       query_params,
       undefined,
       { ...xHeaders, ...requestHeaders },