@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/public/Catalog/CatalogPublicValidator.d.ts

@@ -0,0 +1,55 @@
+export = CatalogPublicValidator;
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+declare class CatalogPublicValidator {
+    /** @returns {GetTaxonomyByLevelParam} */
+    static getTaxonomyByLevel(): GetTaxonomyByLevelParam;
+}
+declare namespace CatalogPublicValidator {
+    export { GetTaxonomyByLevelParam };
+}
+type GetTaxonomyByLevelParam = {
+    /**
+     * - The level of taxonomy hierarchy to fetch: 0: Fetch
+     * departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+     */
+    level: number;
+    /**
+     * - Level 0 (Department) slug of the taxonomy to
+     * filter results.
+     */
+    l0Slug?: string;
+    /**
+     * - Level 1 (L1 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l1Slug?: string;
+    /**
+     * - Level 2 (L2 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l2Slug?: string;
+    /**
+     * - Level 3 (L3 Category) slug of the taxonomy to
+     * filter results.
+     */
+    l3Slug?: string;
+    /**
+     * - Applied limit on the number of items to be
+     * returned. Default is 5000.
+     */
+    limit?: number;
+};

package/sdk/public/Catalog/CatalogPublicValidator.js

@@ -0,0 +1,35 @@
+const Joi = require("joi");
+
+const CatalogPublicModel = require("./CatalogPublicModel");
+
+/**
+ * @typedef GetTaxonomyByLevelParam
+ * @property {number} level - The level of taxonomy hierarchy to fetch: 0: Fetch
+ *   departments. 1: Fetch L1 categories. 2: Fetch L2 categories. 3: Fetch L3 categories.
+ * @property {string} [l0Slug] - Level 0 (Department) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l1Slug] - Level 1 (L1 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l2Slug] - Level 2 (L2 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {string} [l3Slug] - Level 3 (L3 Category) slug of the taxonomy to
+ *   filter results.
+ * @property {number} [limit] - Applied limit on the number of items to be
+ *   returned. Default is 5000.
+ */
+
+class CatalogPublicValidator {
+  /** @returns {GetTaxonomyByLevelParam} */
+  static getTaxonomyByLevel() {
+    return Joi.object({
+      level: Joi.number().required(),
+      l0Slug: Joi.string().allow(""),
+      l1Slug: Joi.string().allow(""),
+      l2Slug: Joi.string().allow(""),
+      l3Slug: Joi.string().allow(""),
+      limit: Joi.number(),
+    }).required();
+  }
+}
+
+module.exports = CatalogPublicValidator;

package/sdk/public/Configuration/ConfigurationPublicClient.d.ts

@@ -3,22 +3,11 @@ declare class Configuration {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
-        checkVersionIsUpToDate: string;
         getLocations: string;
         searchApplication: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
-    /**
-     * @param {ConfigurationPublicValidator.CheckVersionIsUpToDateParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPublicModel.VersionResponse>} - Success response
-     * @name checkVersionIsUpToDate
-     * @summary: Check application version
-     * @description: Check if the application version is up to date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/checkVersionIsUpToDate/).
-     */
-    checkVersionIsUpToDate({ body, requestHeaders }?: ConfigurationPublicValidator.CheckVersionIsUpToDateParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.VersionResponse>;
     /**
      * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -33,12 +22,13 @@ declare class Configuration {
      * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+     * @returns {Promise<ConfigurationPublicModel.ApplicationResponseSchema>} -
+     *   Success response
      * @name searchApplication
-     * @summary: Search application.
+     * @summary: Search application
      * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
      */
-    searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: ConfigurationPublicValidator.SearchApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPublicModel.ApplicationResponseSchema>;
 }
 import ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
 import ConfigurationPublicModel = require("./ConfigurationPublicModel");

package/sdk/public/Configuration/ConfigurationPublicClient.js

@@ -6,6 +6,7 @@ const {
 const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 const ConfigurationPublicValidator = require("./ConfigurationPublicValidator");
 const ConfigurationPublicModel = require("./ConfigurationPublicModel");
@@ -16,10 +17,9 @@ class Configuration {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      checkVersionIsUpToDate: "/service/public/configuration/v1.0/version",
-      getLocations: "/service/public/configuration/v1.0/location",
+      getLocations: "/service/common/configuration/v1.0/location",
       searchApplication:
-        "/service/public/configuration/v1.0/application/search-application",
+        "/service/common/configuration/v1.0/application/search-application",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -37,94 +37,6 @@ class Configuration {
     };
   }
 
-  /**
-   * @param {ConfigurationPublicValidator.CheckVersionIsUpToDateParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPublicModel.VersionResponse>} - Success response
-   * @name checkVersionIsUpToDate
-   * @summary: Check application version
-   * @description: Check if the application version is up to date. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/checkVersionIsUpToDate/).
-   */
-  async checkVersionIsUpToDate(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const {
-      error,
-    } = ConfigurationPublicValidator.checkVersionIsUpToDate().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,
-    } = ConfigurationPublicValidator.checkVersionIsUpToDate().validate(
-      { body },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for public > Configuration > checkVersionIsUpToDate \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await PublicAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["checkVersionIsUpToDate"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = ConfigurationPublicModel.VersionResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this._conf.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for public > Configuration > checkVersionIsUpToDate \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {ConfigurationPublicValidator.GetLocationsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -138,14 +50,6 @@ class Configuration {
     { locationType, id, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = ConfigurationPublicValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
@@ -217,23 +121,16 @@ class Configuration {
    * @param {ConfigurationPublicValidator.SearchApplicationParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PublicAPIClient").Options} - Options
-   * @returns {Promise<ConfigurationPublicModel.ApplicationResponse>} - Success response
+   * @returns {Promise<ConfigurationPublicModel.ApplicationResponseSchema>} -
+   *   Success response
    * @name searchApplication
-   * @summary: Search application.
+   * @summary: Search application
    * @description: Provide application name or domain url. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/configuration/searchApplication/).
    */
   async searchApplication(
     { authorization, query, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const { error } = ConfigurationPublicValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }
@@ -282,10 +179,10 @@ class Configuration {
 
     const {
       error: res_error,
-    } = ConfigurationPublicModel.ApplicationResponse().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
+    } = ConfigurationPublicModel.ApplicationResponseSchema().validate(
+      responseData,
+      { abortEarly: false, allowUnknown: true }
+    );
 
     if (res_error) {
       if (this._conf.options.strictResponseCheck === true) {

package/sdk/public/Configuration/ConfigurationPublicModel.d.ts

@@ -1,6 +1,6 @@
 export = ConfigurationPublicModel;
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
  */
 /**
@@ -10,8 +10,7 @@ export = ConfigurationPublicModel;
  * @property {boolean} [is_primary] - Indicates domain is primary or not.
  *   Primary domain is the default/main domain.
  * @property {boolean} [is_shortlink] - Shortlink is present or not for the domain
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
+ * @property {string} [_id] - The unique identifier of the domain
  * @property {string} [name]
  * @property {boolean} [is_predefined] - Domain is hosting domain or not
  */
@@ -53,45 +52,44 @@ export = ConfigurationPublicModel;
  * @property {ApplicationCors} [cors]
  * @property {ApplicationAuth} [auth]
  * @property {string} [description] - It contains detailed information about the
- *   sales channel.
+ *   sales channel
  * @property {string} [channel_type] - It indicates different channel types like
- *   store, website-and-mobile-apps. Default value is store
+ *   store, website-and-mobile-apps. Default value is store.
  * @property {number} [cache_ttl] - An integer value that specifies the number
  *   of seconds until the key expires
  * @property {boolean} [is_internal] - Indicates whether a sales channel is
  *   internal or not
- * @property {boolean} [is_active] - Indicates sales channel is active or not active
- * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
+ * @property {boolean} [is_active] - Indicates whether a sales channel is active
+ *   or not active
+ * @property {string} [_id] - The unique identifier of the sales channel
  * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {string} [owner] - The unique identifier (24-digit Mongo Object ID)
- *   of owner who owns the application
+ * @property {string} [owner] - The unique identifier of owner who owns the application
  * @property {number} [company_id] - Numeric ID allotted to a business account
  *   where the sales channel exists
- * @property {string} [token] - Random generated fix length string for sales
+ * @property {string} [token] - Randomly generated fixed-length string for sales
  *   channel. It is required and auto-generated.
  * @property {ApplicationRedirections[]} [redirections]
  * @property {ApplicationMeta[]} [meta]
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
- * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
  * @property {SecureUrl} [banner]
  * @property {SecureUrl} [logo]
  * @property {SecureUrl} [favicon]
  * @property {Domain[]} [domains]
- * @property {string} [app_type] - It shows application is live or in development mode.
+ * @property {string} [app_type] - It shows whether application is live or in
+ *   development mode
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  * @property {string} [slug]
- * @property {string} [mode]
- * @property {string} [status]
- * @property {TokenSchema[]} [tokens]
  */
 /**
- * @typedef TokenSchema
- * @property {string} [token]
- * @property {Object} [created_by]
- * @property {string} [created_at] - ISO 8601 timestamp of when token created
+ * @typedef NotFound
+ * @property {string} [message] - Response message for not found
+ */
+/**
+ * @typedef BadRequestSchema
+ * @property {string} [message] - Failure message (in a string format)
  */
 /**
  * @typedef LocationDefaultLanguage
@@ -128,45 +126,14 @@ export = ConfigurationPublicModel;
  * @typedef Locations
  * @property {LocationCountry[]} [items]
  */
-/**
- * @typedef VersionApplication
- * @property {string} [name]
- * @property {string} [version]
- */
-/**
- * @typedef VersionDeviceOS
- * @property {string} [name]
- */
-/**
- * @typedef VersionDevice
- * @property {VersionDeviceOS} [os]
- */
-/**
- * @typedef VersionRequest
- * @property {VersionApplication} application
- * @property {VersionDevice} device
- */
-/**
- * @typedef VersionUpdateDialogue
- * @property {string} [type]
- * @property {number} [interval]
- */
-/**
- * @typedef VersionResponse
- * @property {string} type
- * @property {string} title
- * @property {string} description
- * @property {VersionUpdateDialogue} update_dialog
- * @property {boolean} is_app_blocked
- */
 declare class ConfigurationPublicModel {
 }
 declare namespace ConfigurationPublicModel {
-    export { ApplicationResponse, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, TokenSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations, VersionApplication, VersionDeviceOS, VersionDevice, VersionRequest, VersionUpdateDialogue, VersionResponse };
+    export { ApplicationResponseSchema, Domain, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, NotFound, BadRequestSchema, LocationDefaultLanguage, LocationDefaultCurrency, LocationCountry, Locations };
 }
-/** @returns {ApplicationResponse} */
-declare function ApplicationResponse(): ApplicationResponse;
-type ApplicationResponse = {
+/** @returns {ApplicationResponseSchema} */
+declare function ApplicationResponseSchema(): ApplicationResponseSchema;
+type ApplicationResponseSchema = {
     application?: Application;
 };
 /** @returns {Domain} */
@@ -187,8 +154,7 @@ type Domain = {
      */
     is_shortlink?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * - The unique identifier of the domain
      */
     _id?: string;
     name?: string;
@@ -270,12 +236,12 @@ type Application = {
     auth?: ApplicationAuth;
     /**
      * - It contains detailed information about the
-     * sales channel.
+     * sales channel
      */
     description?: string;
     /**
      * - It indicates different channel types like
-     * store, website-and-mobile-apps. Default value is store
+     * store, website-and-mobile-apps. Default value is store.
      */
     channel_type?: string;
     /**
@@ -289,12 +255,12 @@ type Application = {
      */
     is_internal?: boolean;
     /**
-     * - Indicates sales channel is active or not active
+     * - Indicates whether a sales channel is active
+     * or not active
      */
     is_active?: boolean;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * - The unique identifier of the sales channel
      */
     _id?: string;
     /**
@@ -302,8 +268,7 @@ type Application = {
      */
     name?: string;
     /**
-     * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * - The unique identifier of owner who owns the application
      */
     owner?: string;
     /**
@@ -312,7 +277,7 @@ type Application = {
      */
     company_id?: number;
     /**
-     * - Random generated fix length string for sales
+     * - Randomly generated fixed-length string for sales
      * channel. It is required and auto-generated.
      */
     token?: string;
@@ -325,7 +290,7 @@ type Application = {
     /**
      * - ISO 8601 timestamp of sales channel updation
      */
-    modified_at?: string;
+    updated_at?: string;
     /**
      * - Version key for tracking revisions. Default value is zero.
      */
@@ -335,25 +300,29 @@ type Application = {
     favicon?: SecureUrl;
     domains?: Domain[];
     /**
-     * - It shows application is live or in development mode.
+     * - It shows whether application is live or in
+     * development mode
      */
     app_type?: string;
     mobile_logo?: SecureUrl;
     domain?: Domain;
     slug?: string;
-    mode?: string;
-    status?: string;
-    tokens?: TokenSchema[];
 };
-/** @returns {TokenSchema} */
-declare function TokenSchema(): TokenSchema;
-type TokenSchema = {
-    token?: string;
-    created_by?: any;
+/** @returns {NotFound} */
+declare function NotFound(): NotFound;
+type NotFound = {
     /**
-     * - ISO 8601 timestamp of when token created
+     * - Response message for not found
      */
-    created_at?: string;
+    message?: string;
+};
+/** @returns {BadRequestSchema} */
+declare function BadRequestSchema(): BadRequestSchema;
+type BadRequestSchema = {
+    /**
+     * - Failure message (in a string format)
+     */
+    message?: string;
 };
 /** @returns {LocationDefaultLanguage} */
 declare function LocationDefaultLanguage(): LocationDefaultLanguage;
@@ -394,40 +363,3 @@ declare function Locations(): Locations;
 type Locations = {
     items?: LocationCountry[];
 };
-/** @returns {VersionApplication} */
-declare function VersionApplication(): VersionApplication;
-type VersionApplication = {
-    name?: string;
-    version?: string;
-};
-/** @returns {VersionDeviceOS} */
-declare function VersionDeviceOS(): VersionDeviceOS;
-type VersionDeviceOS = {
-    name?: string;
-};
-/** @returns {VersionDevice} */
-declare function VersionDevice(): VersionDevice;
-type VersionDevice = {
-    os?: VersionDeviceOS;
-};
-/** @returns {VersionRequest} */
-declare function VersionRequest(): VersionRequest;
-type VersionRequest = {
-    application: VersionApplication;
-    device: VersionDevice;
-};
-/** @returns {VersionUpdateDialogue} */
-declare function VersionUpdateDialogue(): VersionUpdateDialogue;
-type VersionUpdateDialogue = {
-    type?: string;
-    interval?: number;
-};
-/** @returns {VersionResponse} */
-declare function VersionResponse(): VersionResponse;
-type VersionResponse = {
-    type: string;
-    title: string;
-    description: string;
-    update_dialog: VersionUpdateDialogue;
-    is_app_blocked: boolean;
-};