@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

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

@@ -227,7 +227,6 @@ export = CatalogPlatformModel;
  * @property {string} [description]
  * @property {AttributeMasterDetails} details
  * @property {boolean} [enabled_for_end_consumer]
- * @property {string} [example]
  * @property {AttributeMasterFilter} filters
  * @property {boolean} [is_nested]
  * @property {string} [logo]
@@ -381,7 +380,7 @@ export = CatalogPlatformModel;
  * @property {UserInfo1} [created_by] - The user who created the item.
  * @property {string} created_on - The date and time when the item was created.
  * @property {boolean} [is_active] - Whether the item is active or not.
- * @property {UserInfo1} [modified_by] - The user who last modified the item.
+ * @property {string} [modified_by] - The user who last modified the item.
  * @property {string} [modified_on] - The date and time when the item was last modified.
  */
 /**
@@ -1551,7 +1550,7 @@ export = CatalogPlatformModel;
  * @property {BrandMeta} brand - The metadata of the brand.
  * @property {CompanyMeta} company - The metadata of the company.
  * @property {string} country_of_origin - The country of origin of the article.
- * @property {UserSerializer} [created_by] - The user who created the article.
+ * @property {string} [created_by] - The user who created the article.
  * @property {DimensionResponse} dimension - The dimensions of the article.
  * @property {string} [expiration_date] - The expiration date of the article.
  * @property {boolean} fragile - Indicates if the article is fragile.
@@ -1564,7 +1563,7 @@ export = CatalogPlatformModel;
  * @property {number} item_id - The ID of the item.
  * @property {ManufacturerResponse} manufacturer - The manufacturer of the article.
  * @property {Object} [meta] - Additional metadata for the article.
- * @property {UserSerializer} [modified_by] - The user who modified the article.
+ * @property {string} [modified_by] - The user who modified the article.
  * @property {PriceMeta} price - The price metadata of the article.
  * @property {Quantities} [quantities]
  * @property {Object} [raw_meta] - The raw metadata of the article.
@@ -2074,7 +2073,7 @@ export = CatalogPlatformModel;
  * @property {number} brand_uid
  * @property {string} [bulk_job_id]
  * @property {string} category_slug
- * @property {Object} [change_request_id]
+ * @property {string} [change_request_id]
  * @property {number} company_id
  * @property {string} country_of_origin
  * @property {string} currency
@@ -2697,7 +2696,7 @@ export = CatalogPlatformModel;
  * @property {boolean} [is_visible]
  * @property {CollectionImage} [logo]
  * @property {Object} [meta]
- * @property {UserInfo} [modified_by]
+ * @property {string} [modified_by]
  * @property {string} [name]
  * @property {number} [priority]
  * @property {boolean} [published]
@@ -3159,7 +3158,6 @@ type AttributeMasterSerializer = {
     description?: string;
     details: AttributeMasterDetails;
     enabled_for_end_consumer?: boolean;
-    example?: string;
     filters: AttributeMasterFilter;
     is_nested?: boolean;
     logo?: string;
@@ -3362,7 +3360,7 @@ type BulkResponse = {
     /**
      * - The user who last modified the item.
      */
-    modified_by?: UserInfo1;
+    modified_by?: string;
     /**
      * - The date and time when the item was last modified.
      */
@@ -5198,7 +5196,7 @@ type InventorySellerResponse = {
     /**
      * - The user who created the article.
      */
-    created_by?: UserSerializer;
+    created_by?: string;
     /**
      * - The dimensions of the article.
      */
@@ -5247,7 +5245,7 @@ type InventorySellerResponse = {
     /**
      * - The user who modified the article.
      */
-    modified_by?: UserSerializer;
+    modified_by?: string;
     /**
      * - The price metadata of the article.
      */
@@ -5947,7 +5945,7 @@ type ProductCreateUpdateSchemaV2 = {
     brand_uid: number;
     bulk_job_id?: string;
     category_slug: string;
-    change_request_id?: any;
+    change_request_id?: string;
     company_id: number;
     country_of_origin: string;
     currency: string;
@@ -6701,7 +6699,7 @@ type UpdateCollection = {
     is_visible?: boolean;
     logo?: CollectionImage;
     meta?: any;
-    modified_by?: UserInfo;
+    modified_by?: string;
     name?: string;
     priority?: number;
     published?: boolean;

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -258,7 +258,6 @@ const Joi = require("joi");
  * @property {string} [description]
  * @property {AttributeMasterDetails} details
  * @property {boolean} [enabled_for_end_consumer]
- * @property {string} [example]
  * @property {AttributeMasterFilter} filters
  * @property {boolean} [is_nested]
  * @property {string} [logo]
@@ -431,7 +430,7 @@ const Joi = require("joi");
  * @property {UserInfo1} [created_by] - The user who created the item.
  * @property {string} created_on - The date and time when the item was created.
  * @property {boolean} [is_active] - Whether the item is active or not.
- * @property {UserInfo1} [modified_by] - The user who last modified the item.
+ * @property {string} [modified_by] - The user who last modified the item.
  * @property {string} [modified_on] - The date and time when the item was last modified.
  */
 
@@ -1736,7 +1735,7 @@ const Joi = require("joi");
  * @property {BrandMeta} brand - The metadata of the brand.
  * @property {CompanyMeta} company - The metadata of the company.
  * @property {string} country_of_origin - The country of origin of the article.
- * @property {UserSerializer} [created_by] - The user who created the article.
+ * @property {string} [created_by] - The user who created the article.
  * @property {DimensionResponse} dimension - The dimensions of the article.
  * @property {string} [expiration_date] - The expiration date of the article.
  * @property {boolean} fragile - Indicates if the article is fragile.
@@ -1749,7 +1748,7 @@ const Joi = require("joi");
  * @property {number} item_id - The ID of the item.
  * @property {ManufacturerResponse} manufacturer - The manufacturer of the article.
  * @property {Object} [meta] - Additional metadata for the article.
- * @property {UserSerializer} [modified_by] - The user who modified the article.
+ * @property {string} [modified_by] - The user who modified the article.
  * @property {PriceMeta} price - The price metadata of the article.
  * @property {Quantities} [quantities]
  * @property {Object} [raw_meta] - The raw metadata of the article.
@@ -2317,7 +2316,7 @@ const Joi = require("joi");
  * @property {number} brand_uid
  * @property {string} [bulk_job_id]
  * @property {string} category_slug
- * @property {Object} [change_request_id]
+ * @property {string} [change_request_id]
  * @property {number} company_id
  * @property {string} country_of_origin
  * @property {string} currency
@@ -3005,7 +3004,7 @@ const Joi = require("joi");
  * @property {boolean} [is_visible]
  * @property {CollectionImage} [logo]
  * @property {Object} [meta]
- * @property {UserInfo} [modified_by]
+ * @property {string} [modified_by]
  * @property {string} [name]
  * @property {number} [priority]
  * @property {boolean} [published]
@@ -3511,7 +3510,6 @@ class CatalogPlatformModel {
       description: Joi.string().allow(""),
       details: CatalogPlatformModel.AttributeMasterDetails().required(),
       enabled_for_end_consumer: Joi.boolean(),
-      example: Joi.string().allow(""),
       filters: CatalogPlatformModel.AttributeMasterFilter().required(),
       is_nested: Joi.boolean(),
       logo: Joi.string().allow(""),
@@ -3721,7 +3719,7 @@ class CatalogPlatformModel {
       created_by: CatalogPlatformModel.UserInfo1(),
       created_on: Joi.string().allow("").required(),
       is_active: Joi.boolean(),
-      modified_by: CatalogPlatformModel.UserInfo1(),
+      modified_by: Joi.string().allow("").allow(null),
       modified_on: Joi.string().allow(""),
     });
   }
@@ -5280,7 +5278,7 @@ class CatalogPlatformModel {
       brand: CatalogPlatformModel.BrandMeta().required(),
       company: CatalogPlatformModel.CompanyMeta().required(),
       country_of_origin: Joi.string().allow("").required(),
-      created_by: CatalogPlatformModel.UserSerializer(),
+      created_by: Joi.string().allow("").allow(null),
       dimension: CatalogPlatformModel.DimensionResponse().required(),
       expiration_date: Joi.string().allow(""),
       fragile: Joi.boolean().required(),
@@ -5293,7 +5291,7 @@ class CatalogPlatformModel {
       item_id: Joi.number().required(),
       manufacturer: CatalogPlatformModel.ManufacturerResponse().required(),
       meta: Joi.any().allow(null),
-      modified_by: CatalogPlatformModel.UserSerializer(),
+      modified_by: Joi.string().allow("").allow(null),
       price: CatalogPlatformModel.PriceMeta().required(),
       quantities: CatalogPlatformModel.Quantities(),
       raw_meta: Joi.any(),
@@ -5979,7 +5977,7 @@ class CatalogPlatformModel {
       brand_uid: Joi.number().required(),
       bulk_job_id: Joi.string().allow(""),
       category_slug: Joi.string().allow("").required(),
-      change_request_id: Joi.any(),
+      change_request_id: Joi.string().allow("").allow(null),
       company_id: Joi.number().required(),
       country_of_origin: Joi.string().allow("").required(),
       currency: Joi.string().allow("").required(),
@@ -6800,7 +6798,7 @@ class CatalogPlatformModel {
       is_visible: Joi.boolean(),
       logo: CatalogPlatformModel.CollectionImage(),
       meta: Joi.any(),
-      modified_by: CatalogPlatformModel.UserInfo(),
+      modified_by: Joi.string().allow("").allow(null),
       name: Joi.string().allow(""),
       priority: Joi.number(),
       published: Joi.boolean(),

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

@@ -111,6 +111,9 @@ export = CatalogPlatformValidator;
 /**
  * @typedef DownloadProductTemplateViewsParam
  * @property {string} slug - A `slug` is a unique identifier for a particular template.
+ * @property {string} [itemType] - An `item_type` defines the type of item. The
+ *   default value is standard.
+ * @property {string} [type] - Format type of the sample file. The default value is excel.
  */
 /**
  * @typedef EditProductParam
@@ -419,6 +422,12 @@ export = CatalogPlatformValidator;
 /**
  * @typedef ValidateProductTemplateParam
  * @property {string} slug - A `slug` is a unique identifier for a particular template.
+ * @property {string} [itemType] - An `item_type` defines the type of item. The
+ *   default value is standard.
+ * @property {boolean} [bulk] - This specification determines the schema type to
+ *   be retrieved. When set to true, it will return the schema for bulk data;
+ *   when set to false, it will provide the schema for a single product. The
+ *   default value is false.
  */
 /**
  * @typedef ValidateProductTemplateSchemaParam
@@ -725,6 +734,15 @@ type DownloadProductTemplateViewsParam = {
      * - A `slug` is a unique identifier for a particular template.
      */
     slug: string;
+    /**
+     * - An `item_type` defines the type of item. The
+     * default value is standard.
+     */
+    itemType?: string;
+    /**
+     * - Format type of the sample file. The default value is excel.
+     */
+    type?: string;
 };
 type EditProductParam = {
     /**
@@ -1321,6 +1339,18 @@ type ValidateProductTemplateParam = {
      * - A `slug` is a unique identifier for a particular template.
      */
     slug: string;
+    /**
+     * - An `item_type` defines the type of item. The
+     * default value is standard.
+     */
+    itemType?: string;
+    /**
+     * - This specification determines the schema type to
+     * be retrieved. When set to true, it will return the schema for bulk data;
+     * when set to false, it will provide the schema for a single product. The
+     * default value is false.
+     */
+    bulk?: boolean;
 };
 type ValidateProductTemplateSchemaParam = {
     /**

package/sdk/platform/Catalog/CatalogPlatformValidator.js

@@ -138,6 +138,9 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef DownloadProductTemplateViewsParam
  * @property {string} slug - A `slug` is a unique identifier for a particular template.
+ * @property {string} [itemType] - An `item_type` defines the type of item. The
+ *   default value is standard.
+ * @property {string} [type] - Format type of the sample file. The default value is excel.
  */
 
 /**
@@ -497,6 +500,12 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
 /**
  * @typedef ValidateProductTemplateParam
  * @property {string} slug - A `slug` is a unique identifier for a particular template.
+ * @property {string} [itemType] - An `item_type` defines the type of item. The
+ *   default value is standard.
+ * @property {boolean} [bulk] - This specification determines the schema type to
+ *   be retrieved. When set to true, it will return the schema for bulk data;
+ *   when set to false, it will provide the schema for a single product. The
+ *   default value is false.
  */
 
 /**
@@ -688,6 +697,8 @@ class CatalogPlatformValidator {
   static downloadProductTemplateViews() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
+      itemType: Joi.string().allow(""),
+      type: Joi.string().allow(""),
     }).required();
   }
 
@@ -1109,6 +1120,8 @@ class CatalogPlatformValidator {
   static validateProductTemplate() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
+      itemType: Joi.string().allow(""),
+      bulk: Joi.boolean(),
     }).required();
   }
 

package/sdk/platform/Common/CommonPlatformClient.d.ts

@@ -4,22 +4,24 @@ declare class Common {
     config: any;
     /**
      * @param {CommonPlatformValidator.GetLocationsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<CommonPlatformModel.Locations>} - Success response
      * @name getLocations
      * @summary: Get countries, states, cities
-     * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
+     * @description: Retrieve a list of countries, states, or cities based on the provided location_type and id parameters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
      */
-    getLocations({ locationType, id }?: CommonPlatformValidator.GetLocationsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommonPlatformModel.Locations>;
+    getLocations({ locationType, id, requestHeaders }?: CommonPlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonPlatformModel.Locations>;
     /**
      * @param {CommonPlatformValidator.SearchApplicationParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
      * @name searchApplication
      * @summary: Search Application
      * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
      */
-    searchApplication({ authorization, query }?: CommonPlatformValidator.SearchApplicationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<CommonPlatformModel.ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: CommonPlatformValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<CommonPlatformModel.ApplicationResponse>;
 }
 import CommonPlatformValidator = require("./CommonPlatformValidator");
 import CommonPlatformModel = require("./CommonPlatformModel");

package/sdk/platform/Common/CommonPlatformClient.js

@@ -13,15 +13,16 @@ class Common {
 
   /**
    * @param {CommonPlatformValidator.GetLocationsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<CommonPlatformModel.Locations>} - Success response
    * @name getLocations
    * @summary: Get countries, states, cities
-   * @description: - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
+   * @description: Retrieve a list of countries, states, or cities based on the provided location_type and id parameters. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/getLocations/).
    */
   async getLocations(
-    { locationType, id } = {},
-    { headers } = { headers: false }
+    { locationType, id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = CommonPlatformValidator.getLocations().validate(
       { locationType, id },
@@ -55,12 +56,12 @@ class Common {
       `/service/common/configuration/v1.0/location`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -83,6 +84,7 @@ class Common {
 
   /**
    * @param {CommonPlatformValidator.SearchApplicationParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<CommonPlatformModel.ApplicationResponse>} - Success response
    * @name searchApplication
@@ -90,8 +92,8 @@ class Common {
    * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
    */
   async searchApplication(
-    { authorization, query } = {},
-    { headers } = { headers: false }
+    { authorization, query, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = CommonPlatformValidator.searchApplication().validate(
       { authorization, query },
@@ -127,12 +129,12 @@ class Common {
       `/service/common/configuration/v1.0/application/search-application`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

package/sdk/platform/Common/CommonPlatformModel.d.ts

@@ -61,22 +61,9 @@ export = CommonPlatformModel;
  */
 /**
  * @typedef ApplicationResponse
- * @property {Application} [application]
- */
-/**
- * @typedef ApplicationWebsite
- * @property {string} [basepath] - Base path for the current sales channel website
- * @property {boolean} [enabled] - Shows whether sales channel website URL is
- *   enabled or not
- */
-/**
- * @typedef BadRequest
- * @property {string} [message] - Failure message (in a string format)
- */
-/**
- * @typedef Currency
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
  *   of the current sales channel supported currency
+ * @property {Application} [application]
  * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
  *   currency creation
@@ -90,6 +77,16 @@ export = CommonPlatformModel;
  * @property {string} [updated_at] - ISO 8601 timestamp of sales channel support
  *   currency updation
  */
+/**
+ * @typedef ApplicationWebsite
+ * @property {string} [basepath] - Base path for the current sales channel website
+ * @property {boolean} [enabled] - Shows whether sales channel website URL is
+ *   enabled or not
+ */
+/**
+ * @typedef BadRequest
+ * @property {string} [message] - Failure message (in a string format)
+ */
 /**
  * @typedef Domain
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
@@ -135,22 +132,12 @@ export = CommonPlatformModel;
  */
 /**
  * @typedef Locations
- * @property {Object[]} [items]
+ * @property {LocationCountry[]} [items] - Object Containing Country Locations Details
  */
 /**
  * @typedef NotFound
  * @property {string} [message] - Response message for not found
  */
-/**
- * @typedef Page
- * @property {number} [current]
- * @property {boolean} [has_next]
- * @property {boolean} [has_previous]
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {number} [size]
- * @property {string} type
- */
 /**
  * @typedef SecureUrl
  * @property {string} [secure_url] - Hosted URL of the image
@@ -158,7 +145,7 @@ export = CommonPlatformModel;
 declare class CommonPlatformModel {
 }
 declare namespace CommonPlatformModel {
-    export { Application, ApplicationAuth, ApplicationCors, ApplicationMeta, ApplicationRedirections, ApplicationResponse, ApplicationWebsite, BadRequest, Currency, Domain, LocationCountry, LocationDefaultCurrency, LocationDefaultLanguage, Locations, NotFound, Page, SecureUrl };
+    export { Application, ApplicationAuth, ApplicationCors, ApplicationMeta, ApplicationRedirections, ApplicationResponse, ApplicationWebsite, BadRequest, Domain, LocationCountry, LocationDefaultCurrency, LocationDefaultLanguage, Locations, NotFound, SecureUrl };
 }
 /** @returns {Application} */
 declare function Application(): Application;
@@ -288,37 +275,12 @@ type ApplicationRedirections = {
 /** @returns {ApplicationResponse} */
 declare function ApplicationResponse(): ApplicationResponse;
 type ApplicationResponse = {
-    application?: Application;
-};
-/** @returns {ApplicationWebsite} */
-declare function ApplicationWebsite(): ApplicationWebsite;
-type ApplicationWebsite = {
-    /**
-     * - Base path for the current sales channel website
-     */
-    basepath?: string;
-    /**
-     * - Shows whether sales channel website URL is
-     * enabled or not
-     */
-    enabled?: boolean;
-};
-/** @returns {BadRequest} */
-declare function BadRequest(): BadRequest;
-type BadRequest = {
-    /**
-     * - Failure message (in a string format)
-     */
-    message?: string;
-};
-/** @returns {Currency} */
-declare function Currency(): Currency;
-type Currency = {
     /**
      * - The unique identifier (24-digit Mongo Object ID)
      * of the current sales channel supported currency
      */
     _id?: string;
+    application?: Application;
     /**
      * - 3-character currency code, e.g. INR, USD, EUR.
      */
@@ -353,6 +315,27 @@ type Currency = {
      */
     updated_at?: string;
 };
+/** @returns {ApplicationWebsite} */
+declare function ApplicationWebsite(): ApplicationWebsite;
+type ApplicationWebsite = {
+    /**
+     * - Base path for the current sales channel website
+     */
+    basepath?: string;
+    /**
+     * - Shows whether sales channel website URL is
+     * enabled or not
+     */
+    enabled?: boolean;
+};
+/** @returns {BadRequest} */
+declare function BadRequest(): BadRequest;
+type BadRequest = {
+    /**
+     * - Failure message (in a string format)
+     */
+    message?: string;
+};
 /** @returns {Domain} */
 declare function Domain(): Domain;
 type Domain = {
@@ -418,7 +401,10 @@ type LocationDefaultLanguage = {
 /** @returns {Locations} */
 declare function Locations(): Locations;
 type Locations = {
-    items?: any[];
+    /**
+     * - Object Containing Country Locations Details
+     */
+    items?: LocationCountry[];
 };
 /** @returns {NotFound} */
 declare function NotFound(): NotFound;
@@ -428,17 +414,6 @@ type NotFound = {
      */
     message?: string;
 };
-/** @returns {Page} */
-declare function Page(): Page;
-type Page = {
-    current?: number;
-    has_next?: boolean;
-    has_previous?: boolean;
-    item_total?: number;
-    next_id?: string;
-    size?: number;
-    type: string;
-};
 /** @returns {SecureUrl} */
 declare function SecureUrl(): SecureUrl;
 type SecureUrl = {