@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -3,30 +3,25 @@ declare class Common {
     constructor(config: any);
     config: any;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.locationType] - Provide location type to query on.
-     *   Possible values : country, state, city
-     * @param {string} [arg.id] - Field is optional when location_type is
-     *   country. If querying for state, provide id of country. If querying for
-     *   city, provide id of state.
-     * @returns {Promise<Locations>} - Success response
+     * @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:
+     * @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 }?: {
-        locationType?: string;
-        id?: string;
-    }): Promise<Locations>;
+    getLocations({ locationType, id, requestHeaders }?: CommonPlatformValidator.GetLocationsParam, { responseHeaders }?: object): Promise<CommonPlatformModel.Locations>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} [arg.authorization] -
-     * @param {string} [arg.query] - Provide application name
-     * @returns {Promise<ApplicationResponse>} - Success response
+     * @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
+     * @description: Provide application name or domain url - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/common/searchApplication/).
      */
-    searchApplication({ authorization, query }?: {
-        authorization?: string;
-        query?: string;
-    }): Promise<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

@@ -1,8 +1,8 @@
 const PlatformAPIClient = require("../PlatformAPIClient");
 const { FDKClientValidationError } = require("../../common/FDKError");
 const Paginator = require("../../common/Paginator");
-const CommonValidator = require("./CommonPlatformValidator");
-const CommonModel = require("./CommonPlatformModel");
+const CommonPlatformValidator = require("./CommonPlatformValidator");
+const CommonPlatformModel = require("./CommonPlatformModel");
 const { Logger } = require("./../../common/Logger");
 const Joi = require("joi");
 
@@ -12,18 +12,19 @@ class Common {
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.locationType] - Provide location type to query on.
-   *   Possible values : country, state, city
-   * @param {string} [arg.id] - Field is optional when location_type is
-   *   country. If querying for state, provide id of country. If querying for
-   *   city, provide id of state.
-   * @returns {Promise<Locations>} - Success response
+   * @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:
+   * @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 } = {}) {
-    const { error } = CommonValidator.getLocations().validate(
+  async getLocations(
+    { locationType, id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = CommonPlatformValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: true }
     );
@@ -32,16 +33,15 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.getLocations().validate(
+    const { error: warrning } = CommonPlatformValidator.getLocations().validate(
       { locationType, id },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getLocations",
+        message: `Parameter Validation warrnings for platform > Common > getLocations \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -56,10 +56,18 @@ class Common {
       `/service/common/configuration/v1.0/location`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
-    const { error: res_error } = CommonModel.Locations().validate(response, {
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = CommonPlatformModel.Locations().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -67,24 +75,27 @@ class Common {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getLocations",
+        message: `Response Validation Warnnings for platform > Common > getLocations \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;
   }
 
   /**
-   * @param {Object} arg - Arg object.
-   * @param {string} [arg.authorization] -
-   * @param {string} [arg.query] - Provide application name
-   * @returns {Promise<ApplicationResponse>} - Success response
+   * @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
+   * @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 } = {}) {
-    const { error } = CommonValidator.searchApplication().validate(
+  async searchApplication(
+    { authorization, query, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = CommonPlatformValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: true }
     );
@@ -93,16 +104,17 @@ class Common {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = CommonValidator.searchApplication().validate(
+    const {
+      error: warrning,
+    } = CommonPlatformValidator.searchApplication().validate(
       { authorization, query },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for searchApplication",
+        message: `Parameter Validation warrnings for platform > Common > searchApplication \n ${warrning}`,
       });
-      Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
@@ -117,12 +129,18 @@ class Common {
       `/service/common/configuration/v1.0/application/search-application`,
       query_params,
       undefined,
-      xHeaders
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
     const {
       error: res_error,
-    } = CommonModel.ApplicationResponse().validate(response, {
+    } = CommonPlatformModel.ApplicationResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -130,9 +148,8 @@ class Common {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for searchApplication",
+        message: `Response Validation Warnnings for platform > Common > searchApplication \n ${res_error}`,
       });
-      Logger({ level: "WARN", message: res_error });
     }
 
     return response;

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

@@ -1,20 +1,424 @@
-export = CommonModel;
-declare class CommonModel {
-    static Application(): any;
-    static ApplicationAuth(): any;
-    static ApplicationCors(): any;
-    static ApplicationMeta(): any;
-    static ApplicationRedirections(): any;
-    static ApplicationResponse(): any;
-    static ApplicationWebsite(): any;
-    static BadRequest(): any;
-    static Currency(): any;
-    static Domain(): any;
-    static LocationCountry(): any;
-    static LocationDefaultCurrency(): any;
-    static LocationDefaultLanguage(): any;
-    static Locations(): any;
-    static NotFound(): any;
-    static Page(): any;
-    static SecureUrl(): any;
+export = CommonPlatformModel;
+/**
+ * @typedef Application
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
+ *   of the sales channel
+ * @property {string} [app_type] - It shows whether application is live or in
+ *   development mode
+ * @property {ApplicationAuth} [auth]
+ * @property {SecureUrl} [banner]
+ * @property {number} [cache_ttl] - An integer value that specifies the number
+ *   of seconds until the key expires
+ * @property {string} [channel_type] - It indicates different channel types like
+ *   store, website-and-mobile-apps. Default value is store.
+ * @property {number} [company_id] - Numeric ID allotted to a business account
+ *   where the sales channel exists
+ * @property {ApplicationCors} [cors]
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
+ * @property {string} [description] - It contains detailed information about the
+ *   sales channel
+ * @property {Domain} [domain]
+ * @property {Domain[]} [domains]
+ * @property {SecureUrl} [favicon]
+ * @property {boolean} [is_active] - Indicates whether a sales channel is active
+ *   or not active
+ * @property {boolean} [is_internal] - Indicates whether a sales channel is
+ *   internal or not
+ * @property {SecureUrl} [logo]
+ * @property {ApplicationMeta[]} [meta]
+ * @property {SecureUrl} [mobile_logo]
+ * @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 {ApplicationRedirections[]} [redirections]
+ * @property {string} [token] - Randomly generated fixed-length string for sales
+ *   channel. It is required and auto-generated.
+ * @property {string} [updated_at] - ISO 8601 timestamp of sales channel updation
+ * @property {ApplicationWebsite} [website]
+ */
+/**
+ * @typedef ApplicationAuth
+ * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
+ */
+/**
+ * @typedef ApplicationCors
+ * @property {string[]} [domains]
+ */
+/**
+ * @typedef ApplicationMeta
+ * @property {string} [name] - Indicates the name of application meta
+ * @property {string} [value] - Value related to application meta name
+ */
+/**
+ * @typedef ApplicationRedirections
+ * @property {string} [redirect_from] - Old domain URL of the sales channel
+ * @property {string} [redirect_to] - New domain URL of the sales channel. Users
+ *   will be automatically redirected from old domain to new domain.
+ * @property {string} [type] - It shows domain redirection type. Permanent
+ *   redirection is for long time period redirection, and temporary redirection
+ *   for a short time period.
+ */
+/**
+ * @typedef ApplicationResponse
+ * @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
+ * @property {number} [decimal_digits] - Acceptable decimal limits for a given
+ *   currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
+ *   value of a currency.
+ * @property {boolean} [is_active] - Shows currency is enabled or not in current
+ *   sales channel
+ * @property {string} [name] - Name of the currency, e.g. Indian Rupee
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
+ * @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)
+ *   of the domain
+ * @property {boolean} [is_predefined] - Domain is hosting domain or not
+ * @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} [name]
+ * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
+ *   A records should propagate correctly.
+ */
+/**
+ * @typedef LocationCountry
+ * @property {number} [__v]
+ * @property {string} [_id]
+ * @property {string} [capital]
+ * @property {string} [country_code]
+ * @property {string} [currency]
+ * @property {LocationDefaultCurrency} [default_currency]
+ * @property {LocationDefaultLanguage} [default_language]
+ * @property {string} [iso2]
+ * @property {string} [iso3]
+ * @property {string} [latitude]
+ * @property {string} [longitude]
+ * @property {string} [name]
+ * @property {string} [parent]
+ * @property {string} [phone_code]
+ * @property {string} [state_code]
+ * @property {string} [type]
+ * @property {number} [uid]
+ */
+/**
+ * @typedef LocationDefaultCurrency
+ * @property {string} [code]
+ * @property {string} [name]
+ * @property {string} [symbol]
+ */
+/**
+ * @typedef LocationDefaultLanguage
+ * @property {string} [code]
+ * @property {string} [name]
+ */
+/**
+ * @typedef Locations
+ * @property {LocationCountry[]} [items] - Object Containing Country Locations Details
+ */
+/**
+ * @typedef NotFound
+ * @property {string} [message] - Response message for not found
+ */
+/**
+ * @typedef SecureUrl
+ * @property {string} [secure_url] - Hosted URL of the image
+ */
+declare class CommonPlatformModel {
 }
+declare namespace CommonPlatformModel {
+    export { Application, ApplicationAuth, ApplicationCors, ApplicationMeta, ApplicationRedirections, ApplicationResponse, ApplicationWebsite, BadRequest, Domain, LocationCountry, LocationDefaultCurrency, LocationDefaultLanguage, Locations, NotFound, SecureUrl };
+}
+/** @returns {Application} */
+declare function Application(): Application;
+type Application = {
+    /**
+     * - Version key for tracking revisions. Default value is zero.
+     */
+    __v?: number;
+    /**
+     * - The unique identifier (24-digit Mongo Object ID)
+     * of the sales channel
+     */
+    _id?: string;
+    /**
+     * - It shows whether application is live or in
+     * development mode
+     */
+    app_type?: string;
+    auth?: ApplicationAuth;
+    banner?: SecureUrl;
+    /**
+     * - An integer value that specifies the number
+     * of seconds until the key expires
+     */
+    cache_ttl?: number;
+    /**
+     * - It indicates different channel types like
+     * store, website-and-mobile-apps. Default value is store.
+     */
+    channel_type?: string;
+    /**
+     * - Numeric ID allotted to a business account
+     * where the sales channel exists
+     */
+    company_id?: number;
+    cors?: ApplicationCors;
+    /**
+     * - ISO 8601 timestamp of sales channel creation
+     */
+    created_at?: string;
+    /**
+     * - It contains detailed information about the
+     * sales channel
+     */
+    description?: string;
+    domain?: Domain;
+    domains?: Domain[];
+    favicon?: SecureUrl;
+    /**
+     * - Indicates whether a sales channel is active
+     * or not active
+     */
+    is_active?: boolean;
+    /**
+     * - Indicates whether a sales channel is
+     * internal or not
+     */
+    is_internal?: boolean;
+    logo?: SecureUrl;
+    meta?: ApplicationMeta[];
+    mobile_logo?: SecureUrl;
+    /**
+     * - Name of the sales channel, e.g. Zenz Fashion
+     */
+    name?: string;
+    /**
+     * - The unique identifier (24-digit Mongo Object ID)
+     * of owner who owns the application
+     */
+    owner?: string;
+    redirections?: ApplicationRedirections[];
+    /**
+     * - Randomly generated fixed-length string for sales
+     * channel. It is required and auto-generated.
+     */
+    token?: string;
+    /**
+     * - ISO 8601 timestamp of sales channel updation
+     */
+    updated_at?: string;
+    website?: ApplicationWebsite;
+};
+/** @returns {ApplicationAuth} */
+declare function ApplicationAuth(): ApplicationAuth;
+type ApplicationAuth = {
+    /**
+     * - Shows sales channel auth is enabled or not enabled.
+     */
+    enabled?: boolean;
+};
+/** @returns {ApplicationCors} */
+declare function ApplicationCors(): ApplicationCors;
+type ApplicationCors = {
+    domains?: string[];
+};
+/** @returns {ApplicationMeta} */
+declare function ApplicationMeta(): ApplicationMeta;
+type ApplicationMeta = {
+    /**
+     * - Indicates the name of application meta
+     */
+    name?: string;
+    /**
+     * - Value related to application meta name
+     */
+    value?: string;
+};
+/** @returns {ApplicationRedirections} */
+declare function ApplicationRedirections(): ApplicationRedirections;
+type ApplicationRedirections = {
+    /**
+     * - Old domain URL of the sales channel
+     */
+    redirect_from?: string;
+    /**
+     * - New domain URL of the sales channel. Users
+     * will be automatically redirected from old domain to new domain.
+     */
+    redirect_to?: string;
+    /**
+     * - It shows domain redirection type. Permanent
+     * redirection is for long time period redirection, and temporary redirection
+     * for a short time period.
+     */
+    type?: string;
+};
+/** @returns {ApplicationResponse} */
+declare function ApplicationResponse(): ApplicationResponse;
+type ApplicationResponse = {
+    /**
+     * - 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.
+     */
+    code?: string;
+    /**
+     * - ISO 8601 timestamp of sales channel support
+     * currency creation
+     */
+    created_at?: string;
+    /**
+     * - Acceptable decimal limits for a given
+     * currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
+     * value of a currency.
+     */
+    decimal_digits?: number;
+    /**
+     * - Shows currency is enabled or not in current
+     * sales channel
+     */
+    is_active?: boolean;
+    /**
+     * - Name of the currency, e.g. Indian Rupee
+     */
+    name?: string;
+    /**
+     * - Unique symbol for identifying the currency, e.g. ₹
+     */
+    symbol?: string;
+    /**
+     * - ISO 8601 timestamp of sales channel support
+     * currency updation
+     */
+    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 = {
+    /**
+     * - The unique identifier (24-digit Mongo Object ID)
+     * of the domain
+     */
+    _id?: string;
+    /**
+     * - Domain is hosting domain or not
+     */
+    is_predefined?: boolean;
+    /**
+     * - Indicates domain is primary or not.
+     * Primary domain is the default/main domain.
+     */
+    is_primary?: boolean;
+    /**
+     * - Shortlink is present or not for the domain
+     */
+    is_shortlink?: boolean;
+    name?: string;
+    /**
+     * - Indicates domain is verified or not. TXT and
+     * A records should propagate correctly.
+     */
+    verified?: boolean;
+};
+/** @returns {LocationCountry} */
+declare function LocationCountry(): LocationCountry;
+type LocationCountry = {
+    __v?: number;
+    _id?: string;
+    capital?: string;
+    country_code?: string;
+    currency?: string;
+    default_currency?: LocationDefaultCurrency;
+    default_language?: LocationDefaultLanguage;
+    iso2?: string;
+    iso3?: string;
+    latitude?: string;
+    longitude?: string;
+    name?: string;
+    parent?: string;
+    phone_code?: string;
+    state_code?: string;
+    type?: string;
+    uid?: number;
+};
+/** @returns {LocationDefaultCurrency} */
+declare function LocationDefaultCurrency(): LocationDefaultCurrency;
+type LocationDefaultCurrency = {
+    code?: string;
+    name?: string;
+    symbol?: string;
+};
+/** @returns {LocationDefaultLanguage} */
+declare function LocationDefaultLanguage(): LocationDefaultLanguage;
+type LocationDefaultLanguage = {
+    code?: string;
+    name?: string;
+};
+/** @returns {Locations} */
+declare function Locations(): Locations;
+type Locations = {
+    /**
+     * - Object Containing Country Locations Details
+     */
+    items?: LocationCountry[];
+};
+/** @returns {NotFound} */
+declare function NotFound(): NotFound;
+type NotFound = {
+    /**
+     * - Response message for not found
+     */
+    message?: string;
+};
+/** @returns {SecureUrl} */
+declare function SecureUrl(): SecureUrl;
+type SecureUrl = {
+    /**
+     * - Hosted URL of the image
+     */
+    secure_url?: string;
+};