@gofynd/fdk-client-javascript 1.3.11-beta.6 → 1.3.11-beta.8

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

@@ -168,12 +168,14 @@ declare class Catalog {
      * @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
+     * @returns {Promise<CatalogPlatformModel.CommonResponseSchemaCollection>}
+     *   - Success response
+     *
      * @name deleteCollection
      * @summary: Delete a Collection
      * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
      */
-    deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.DeleteResponse>;
+    deleteCollection({ id, requestHeaders }?: CatalogPlatformApplicationValidator.DeleteCollectionParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CommonResponseSchemaCollection>;
     /**
      * @param {CatalogPlatformApplicationValidator.DeleteGroupConfigurationParam} arg
      *   - Arg object
@@ -282,7 +284,7 @@ declare class Catalog {
      * @summary: Get list of locations
      * @description: This API allows to view all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
      */
-    getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, requestHeaders }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
+    getAppLocations({ storeType, uid, q, stage, pageNo, pageSize, tags, storeTypes, requestHeaders, }?: CatalogPlatformApplicationValidator.GetAppLocationsParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.LocationListSerializer>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.companyId - Id of the company whose locations are to fetched
@@ -297,11 +299,13 @@ declare class Catalog {
      *   unverified companies.
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 20.
+     * @param {string[]} [arg.tags] - Get locations filtered by tags.
+     * @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
      * @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
      * @summary: Get list of locations
      * @description: This API allows to view all the locations asscoiated to a application.
      */
-    getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, }?: {
+    getAppLocationsPaginator({ companyId, applicationId, storeType, uid, q, stage, pageSize, tags, storeTypes, }?: {
         companyId: string;
         applicationId: string;
         storeType?: string;
@@ -309,6 +313,8 @@ declare class Catalog {
         q?: string;
         stage?: string;
         pageSize?: number;
+        tags?: string[];
+        storeTypes?: string[];
     }): Paginator<CatalogPlatformModel.LocationListSerializer>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetAppProductParam} arg - Arg object
@@ -608,13 +614,13 @@ declare class Catalog {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.CollectionDetailResponse>} -
+     * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
      *   Success response
      * @name getCollectionDetail
      * @summary: Get a particular collection
      * @description: Get the details of a collection by its `slug`. If successful, returns a Collection resource in the response body specified in `CollectionDetailResponse` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getCollectionDetail/).
      */
-    getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CollectionDetailResponse>;
+    getCollectionDetail({ slug, requestHeaders }?: CatalogPlatformApplicationValidator.GetCollectionDetailParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionDetailResponse>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetCollectionItemsParam} arg
      *   - Arg object
@@ -654,7 +660,7 @@ declare class Catalog {
      * @summary: Get configuration metadata details for catalog for admin panel
      * @description: Get the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
      */
-    getConfigurationMetadata({ configType, templateSlug, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
+    getConfigurationMetadata({ configType, templateSlug, pageNo, pageSize, q, requestHeaders }?: CatalogPlatformApplicationValidator.GetConfigurationMetadataParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetConfigMetadataResponse>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetConfigurationsParam} arg
      *   - Arg object
@@ -732,14 +738,12 @@ declare class Catalog {
      * @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>}
-     *   - Success response
-     *
+     * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
      * @name getQueryFilters
      * @summary: Get query filters to configure a collection
      * @description: Get query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
      */
-    getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>;
+    getQueryFilters({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetQueryFiltersResponse>;
     /**
      * @param {CatalogPlatformApplicationValidator.GetSearchConfigurationParam} arg
      *   - Arg object

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -1082,7 +1082,9 @@ class Catalog {
    * @param {CatalogPlatformApplicationValidator.DeleteCollectionParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.DeleteResponse>} - Success response
+   * @returns {Promise<CatalogPlatformModel.CommonResponseSchemaCollection>}
+   *   - Success response
+   *
    * @name deleteCollection
    * @summary: Delete a Collection
    * @description: Delete a collection by it's id. Returns an object that tells whether the collection was deleted successfully - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/deleteCollection/).
@@ -1138,10 +1140,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.DeleteResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = CatalogPlatformModel.CommonResponseSchemaCollection().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -1866,9 +1868,17 @@ class Catalog {
    * @description: This API allows to view all the locations asscoiated to a application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getAppLocations/).
    */
   async getAppLocations(
-    { storeType, uid, q, stage, pageNo, pageSize, requestHeaders } = {
-      requestHeaders: {},
-    },
+    {
+      storeType,
+      uid,
+      q,
+      stage,
+      pageNo,
+      pageSize,
+      tags,
+      storeTypes,
+      requestHeaders,
+    } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
@@ -1881,6 +1891,8 @@ class Catalog {
         stage,
         pageNo,
         pageSize,
+        tags,
+        storeTypes,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -1899,6 +1911,8 @@ class Catalog {
         stage,
         pageNo,
         pageSize,
+        tags,
+        storeTypes,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -1916,6 +1930,8 @@ class Catalog {
     query_params["stage"] = stage;
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
+    query_params["tags"] = tags;
+    query_params["store_types"] = storeTypes;
 
     const response = await PlatformAPIClient.execute(
       this.config,
@@ -1967,6 +1983,8 @@ class Catalog {
    *   unverified companies.
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 20.
+   * @param {string[]} [arg.tags] - Get locations filtered by tags.
+   * @param {string[]} [arg.storeTypes] - Get locations filtered by store types.
    * @returns {Paginator<CatalogPlatformModel.LocationListSerializer>}
    * @summary: Get list of locations
    * @description: This API allows to view all the locations asscoiated to a application.
@@ -1979,6 +1997,8 @@ class Catalog {
     q,
     stage,
     pageSize,
+    tags,
+    storeTypes,
   } = {}) {
     const paginator = new Paginator();
     const callback = async () => {
@@ -1994,6 +2014,8 @@ class Catalog {
         stage: stage,
         pageNo: pageNo,
         pageSize: pageSize,
+        tags: tags,
+        storeTypes: storeTypes,
       });
       paginator.setPaginator({
         hasNext: data.page.has_next ? true : false,
@@ -3428,7 +3450,7 @@ class Catalog {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.CollectionDetailResponse>} -
+   * @returns {Promise<CatalogPlatformModel.GetCollectionDetailResponse>} -
    *   Success response
    * @name getCollectionDetail
    * @summary: Get a particular collection
@@ -3485,10 +3507,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.CollectionDetailResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = CatalogPlatformModel.GetCollectionDetailResponse().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {
@@ -3691,7 +3713,9 @@ class Catalog {
    * @description: Get the configuraion metadata details for catalog. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getConfigurationMetadata/).
    */
   async getConfigurationMetadata(
-    { configType, templateSlug, requestHeaders } = { requestHeaders: {} },
+    { configType, templateSlug, pageNo, pageSize, q, requestHeaders } = {
+      requestHeaders: {},
+    },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
@@ -3700,6 +3724,9 @@ class Catalog {
       {
         configType,
         templateSlug,
+        pageNo,
+        pageSize,
+        q,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -3714,6 +3741,9 @@ class Catalog {
       {
         configType,
         templateSlug,
+        pageNo,
+        pageSize,
+        q,
       },
       { abortEarly: false, allowUnknown: false }
     );
@@ -3726,6 +3756,9 @@ class Catalog {
 
     const query_params = {};
     query_params["template_slug"] = templateSlug;
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["q"] = q;
 
     const response = await PlatformAPIClient.execute(
       this.config,
@@ -4293,9 +4326,7 @@ class Catalog {
    * @param {CatalogPlatformApplicationValidator.GetQueryFiltersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<CatalogPlatformModel.GetCollectionQueryOptionResponse>}
-   *   - Success response
-   *
+   * @returns {Promise<CatalogPlatformModel.GetQueryFiltersResponse>} - Success response
    * @name getQueryFilters
    * @summary: Get query filters to configure a collection
    * @description: Get query filters to configure a collection - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getQueryFilters/).
@@ -4347,10 +4378,10 @@ class Catalog {
 
     const {
       error: res_error,
-    } = CatalogPlatformModel.GetCollectionQueryOptionResponse().validate(
-      responseData,
-      { abortEarly: false, allowUnknown: true }
-    );
+    } = CatalogPlatformModel.GetQueryFiltersResponse().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
 
     if (res_error) {
       if (this.config.options.strictResponseCheck === true) {

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

@@ -119,6 +119,8 @@ export = CatalogPlatformApplicationValidator;
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 20.
+ * @property {string[]} [tags] - Get locations filtered by tags.
+ * @property {string[]} [storeTypes] - Get locations filtered by store types.
  */
 /**
  * @typedef GetAppProductParam
@@ -254,6 +256,10 @@ export = CatalogPlatformApplicationValidator;
  *   a specific type of configuration.
  * @property {string} [templateSlug] - Get configuration list filtered by
  *   `template_slug` string. This is for the details and comparision groups.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ * @property {string} [q] - Get configuration list filtered by `q` string.
  */
 /** @typedef GetConfigurationsParam */
 /** @typedef GetDepartmentsParam */
@@ -706,6 +712,14 @@ type GetAppLocationsParam = {
      * Default is 20.
      */
     pageSize?: number;
+    /**
+     * - Get locations filtered by tags.
+     */
+    tags?: string[];
+    /**
+     * - Get locations filtered by store types.
+     */
+    storeTypes?: string[];
 };
 type GetAppProductParam = {
     /**
@@ -962,6 +976,19 @@ type GetConfigurationMetadataParam = {
      * `template_slug` string. This is for the details and comparision groups.
      */
     templateSlug?: string;
+    /**
+     * - The page number to navigate through the given
+     * set of results.
+     */
+    pageNo?: number;
+    /**
+     * - Number of items to retrieve in each page.
+     */
+    pageSize?: number;
+    /**
+     * - Get configuration list filtered by `q` string.
+     */
+    q?: string;
 };
 type GetDiscountedInventoryBySizeIdentifierParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -144,6 +144,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   set of results
  * @property {number} [pageSize] - Number of items to retrieve in each page.
  *   Default is 20.
+ * @property {string[]} [tags] - Get locations filtered by tags.
+ * @property {string[]} [storeTypes] - Get locations filtered by store types.
  */
 
 /**
@@ -296,6 +298,10 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
  *   a specific type of configuration.
  * @property {string} [templateSlug] - Get configuration list filtered by
  *   `template_slug` string. This is for the details and comparision groups.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ * @property {string} [q] - Get configuration list filtered by `q` string.
  */
 
 /** @typedef GetConfigurationsParam */
@@ -626,6 +632,8 @@ class CatalogPlatformApplicationValidator {
       stage: Joi.string().allow(""),
       pageNo: Joi.number(),
       pageSize: Joi.number(),
+      tags: Joi.array().items(Joi.string().allow("")),
+      storeTypes: Joi.array().items(Joi.string().allow("")),
     }).required();
   }
 
@@ -771,6 +779,9 @@ class CatalogPlatformApplicationValidator {
     return Joi.object({
       configType: Joi.string().allow("").required(),
       templateSlug: Joi.string().allow(""),
+      pageNo: Joi.number(),
+      pageSize: Joi.number(),
+      q: Joi.string().allow(""),
     }).required();
   }
 

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

@@ -117,12 +117,12 @@ declare class Catalog {
      * @param {CatalogPlatformValidator.CreateProductParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<CatalogPlatformModel.SuccessResponse>} - Success response
+     * @returns {Promise<CatalogPlatformModel.SuccessResponse1>} - Success response
      * @name createProduct
      * @summary: Create a product.
      * @description: This API allows to create product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/createProduct/).
      */
-    createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse>;
+    createProduct({ body, requestHeaders }?: CatalogPlatformValidator.CreateProductParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.SuccessResponse1>;
     /**
      * @param {CatalogPlatformValidator.CreateProductAssetsInBulkParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -431,6 +431,16 @@ declare class Catalog {
      * @description: Use this API to fetch opt-in information for all the platforms. If successful, returns a logs in the response body as specified in `GetOptInPlatformSchema` - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaceOptinDetail/).
      */
     getMarketplaceOptinDetail({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetOptInPlatform>;
+    /**
+     * @param {CatalogPlatformValidator.GetMarketplacesParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CatalogPlatformModel.GetAllMarketplaces>} - Success response
+     * @name getMarketplaces
+     * @summary: List all marketplaces
+     * @description: This API allows to get marketplace information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getMarketplaces/).
+     */
+    getMarketplaces({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CatalogPlatformModel.GetAllMarketplaces>;
     /**
      * @param {CatalogPlatformValidator.GetOptimalLocationsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -596,7 +606,7 @@ declare class Catalog {
      * @summary: Get list of size guides
      * @description: This API allows to view all the size guides associated to the seller. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/getSizeGuides/).
      */
-    getSizeGuides({ active, q, tag, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
+    getSizeGuides({ active, q, tag, pageNo, pageSize, brandId, requestHeaders }?: CatalogPlatformValidator.GetSizeGuidesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.ListSizeGuide>;
     /**
      * @param {CatalogPlatformValidator.GetStoreDetailParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -626,7 +636,7 @@ declare class Catalog {
      * @summary: Get product categories list
      * @description: This API gets meta associated to product categories. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/listCategories/).
      */
-    listCategories({ level, departments, q, pageNo, pageSize, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
+    listCategories({ level, department, q, pageNo, pageSize, uids, requestHeaders }?: CatalogPlatformValidator.ListCategoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.CategoryResponse>;
     /**
      * @param {CatalogPlatformValidator.ListDepartmentsDataParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -747,6 +757,18 @@ declare class Catalog {
      * @description: This API allows add Inventory for particular size and store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateInventories/).
      */
     updateInventories({ body, requestHeaders }?: CatalogPlatformValidator.UpdateInventoriesParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.InventoryUpdateResponse>;
+    /**
+     * @param {CatalogPlatformValidator.UpdateMarketplaceOptinParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>}
+     *   - Success response
+     *
+     * @name updateMarketplaceOptin
+     * @summary: Update marketplace optin
+     * @description: This API allows to update marketplace optin for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/catalog/updateMarketplaceOptin/).
+     */
+    updateMarketplaceOptin({ marketplaceSlug, body, requestHeaders }?: CatalogPlatformValidator.UpdateMarketplaceOptinParam, { responseHeaders }?: object): Promise<CatalogPlatformModel.UpdateMarketplaceOptinResponse>;
     /**
      * @param {CatalogPlatformValidator.UpdateProductBundleParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`