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

package/sdk/public/Configuration/ConfigurationPublicModel.js

@@ -1,7 +1,7 @@
 const Joi = require("joi");
 
 /**
- * @typedef ApplicationResponse
+ * @typedef ApplicationResponseSchema
  * @property {Application} [application]
  */
 
@@ -12,8 +12,7 @@ const Joi = require("joi");
  * @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
  */
@@ -62,46 +61,46 @@ const Joi = require("joi");
  * @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)
  */
 
 /**
@@ -143,46 +142,9 @@ const Joi = require("joi");
  * @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
- */
-
 class ConfigurationPublicModel {
-  /** @returns {ApplicationResponse} */
-  static ApplicationResponse() {
+  /** @returns {ApplicationResponseSchema} */
+  static ApplicationResponseSchema() {
     return Joi.object({
       application: ConfigurationPublicModel.Application(),
     });
@@ -267,7 +229,7 @@ class ConfigurationPublicModel {
       ),
       meta: Joi.array().items(ConfigurationPublicModel.ApplicationMeta()),
       created_at: Joi.string().allow(""),
-      modified_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
       __v: Joi.number(),
       banner: ConfigurationPublicModel.SecureUrl(),
       logo: ConfigurationPublicModel.SecureUrl(),
@@ -277,18 +239,20 @@ class ConfigurationPublicModel {
       mobile_logo: ConfigurationPublicModel.SecureUrl(),
       domain: ConfigurationPublicModel.Domain(),
       slug: Joi.string().allow(""),
-      mode: Joi.string().allow(""),
-      status: Joi.string().allow(""),
-      tokens: Joi.array().items(ConfigurationPublicModel.TokenSchema()),
     });
   }
 
-  /** @returns {TokenSchema} */
-  static TokenSchema() {
+  /** @returns {NotFound} */
+  static NotFound() {
     return Joi.object({
-      token: Joi.string().allow(""),
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
-      created_at: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {BadRequestSchema} */
+  static BadRequestSchema() {
+    return Joi.object({
+      message: Joi.string().allow(""),
     });
   }
 
@@ -338,54 +302,5 @@ class ConfigurationPublicModel {
       items: Joi.array().items(ConfigurationPublicModel.LocationCountry()),
     });
   }
-
-  /** @returns {VersionApplication} */
-  static VersionApplication() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-      version: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {VersionDeviceOS} */
-  static VersionDeviceOS() {
-    return Joi.object({
-      name: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {VersionDevice} */
-  static VersionDevice() {
-    return Joi.object({
-      os: ConfigurationPublicModel.VersionDeviceOS(),
-    });
-  }
-
-  /** @returns {VersionRequest} */
-  static VersionRequest() {
-    return Joi.object({
-      application: ConfigurationPublicModel.VersionApplication().required(),
-      device: ConfigurationPublicModel.VersionDevice().required(),
-    });
-  }
-
-  /** @returns {VersionUpdateDialogue} */
-  static VersionUpdateDialogue() {
-    return Joi.object({
-      type: Joi.string().allow(""),
-      interval: Joi.number(),
-    });
-  }
-
-  /** @returns {VersionResponse} */
-  static VersionResponse() {
-    return Joi.object({
-      type: Joi.string().allow("").required(),
-      title: Joi.string().allow("").required(),
-      description: Joi.string().allow("").required(),
-      update_dialog: ConfigurationPublicModel.VersionUpdateDialogue().required(),
-      is_app_blocked: Joi.boolean().required(),
-    });
-  }
 }
 module.exports = ConfigurationPublicModel;

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

@@ -1,8 +1,4 @@
 export = ConfigurationPublicValidator;
-/**
- * @typedef CheckVersionIsUpToDateParam
- * @property {ConfigurationPublicModel.VersionRequest} body
- */
 /**
  * @typedef GetLocationsParam
  * @property {string} [locationType] - Provide location type to query on.
@@ -17,19 +13,14 @@ export = ConfigurationPublicValidator;
  * @property {string} [query] - Provide application name
  */
 declare class ConfigurationPublicValidator {
-    /** @returns {CheckVersionIsUpToDateParam} */
-    static checkVersionIsUpToDate(): CheckVersionIsUpToDateParam;
     /** @returns {GetLocationsParam} */
     static getLocations(): GetLocationsParam;
     /** @returns {SearchApplicationParam} */
     static searchApplication(): SearchApplicationParam;
 }
 declare namespace ConfigurationPublicValidator {
-    export { CheckVersionIsUpToDateParam, GetLocationsParam, SearchApplicationParam };
+    export { GetLocationsParam, SearchApplicationParam };
 }
-type CheckVersionIsUpToDateParam = {
-    body: ConfigurationPublicModel.VersionRequest;
-};
 type GetLocationsParam = {
     /**
      * - Provide location type to query on.
@@ -50,4 +41,3 @@ type SearchApplicationParam = {
      */
     query?: string;
 };
-import ConfigurationPublicModel = require("./ConfigurationPublicModel");

package/sdk/public/Configuration/ConfigurationPublicValidator.js

@@ -2,11 +2,6 @@ const Joi = require("joi");
 
 const ConfigurationPublicModel = require("./ConfigurationPublicModel");
 
-/**
- * @typedef CheckVersionIsUpToDateParam
- * @property {ConfigurationPublicModel.VersionRequest} body
- */
-
 /**
  * @typedef GetLocationsParam
  * @property {string} [locationType] - Provide location type to query on.
@@ -23,13 +18,6 @@ const ConfigurationPublicModel = require("./ConfigurationPublicModel");
  */
 
 class ConfigurationPublicValidator {
-  /** @returns {CheckVersionIsUpToDateParam} */
-  static checkVersionIsUpToDate() {
-    return Joi.object({
-      body: ConfigurationPublicModel.VersionRequest().required(),
-    }).required();
-  }
-
   /** @returns {GetLocationsParam} */
   static getLocations() {
     return Joi.object({

package/sdk/public/Content/ContentPublicClient.d.ts

@@ -3,22 +3,33 @@ declare class Content {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
+        getAllLanguages: string;
         getAllTags: string;
+        getAllTranslatableResources: string;
         getAnalyticsTags: string;
         getBasicDetails: string;
         getCredentialsByEntity: string;
         getCustomPage: string;
         getFooterContent: string;
         getHomePageContent: string;
+        getLanguageByLocale: string;
         getMenuContent: string;
         getMenuContentByType: string;
         getNavbar: string;
         getPricingBanner: string;
-        getSDKDocumentation: string;
-        getSDKDocumentationByType: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
+    /**
+     * @param {ContentPublicValidator.GetAllLanguagesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name getAllLanguages
+     * @summary: Get All Languages
+     * @description: Fetches complete list of languages supported by the platform with their locale codes and text directions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllLanguages/).
+     */
+    getAllLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {ContentPublicValidator.GetAllTagsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -29,6 +40,16 @@ declare class Content {
      * @description: Retrieve custom tag with injected css/javascript info. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllTags/).
      */
     getAllTags({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.TagsSchema>;
+    /**
+     * @param {ContentPublicValidator.GetAllTranslatableResourcesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<Object>} - Success response
+     * @name getAllTranslatableResources
+     * @summary: Get Translatable Items
+     * @description: Retrieves all resources that can be translated across different languages in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getAllTranslatableResources/).
+     */
+    getAllTranslatableResources({ requestHeaders }?: any, { responseHeaders }?: object): Promise<any>;
     /**
      * @param {ContentPublicValidator.GetAnalyticsTagsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -58,7 +79,7 @@ declare class Content {
      * @summary: Get credentials to power chat support systems
      * @description: Get credentials for support system - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCredentialsByEntity/).
      */
-    getCredentialsByEntity({ entityType, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object): Promise<ContentPublicModel.CredentialsSchema>;
+    getCredentialsByEntity({ entityType, requestHeaders }?: ContentPublicValidator.GetCredentialsByEntityParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.CredentialsSchema>;
     /**
      * @param {ContentPublicValidator.GetCustomPageParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -68,7 +89,7 @@ declare class Content {
      * @summary: Retrieve info for custom page.
      * @description: Retrieve info of custom pagee to develop and manage custom webpages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getCustomPage/).
      */
-    getCustomPage({ slug, requestHeaders }?: ContentPublicValidator.GetCustomPageParam, { responseHeaders }?: object): Promise<ContentPublicModel.CustomPageBySlugSchema>;
+    getCustomPage({ slug, requestHeaders }?: ContentPublicValidator.GetCustomPageParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.CustomPageBySlugSchema>;
     /**
      * @param {ContentPublicValidator.GetFooterContentParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -89,6 +110,16 @@ declare class Content {
      * @description: Retrieve home page content for a specific page type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getHomePageContent/).
      */
     getHomePageContent({ pageType, requestHeaders }?: ContentPublicValidator.GetHomePageContentParam, { responseHeaders }?: object): Promise<ContentPublicModel.HomePageContentSchema>;
+    /**
+     * @param {ContentPublicValidator.GetLanguageByLocaleParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PublicAPIClient").Options} - Options
+     * @returns {Promise<ContentPublicModel.Language>} - Success response
+     * @name getLanguageByLocale
+     * @summary: Get Single Language
+     * @description: Retrieves detailed information about a specific language using its locale identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getLanguageByLocale/).
+     */
+    getLanguageByLocale({ locale, requestHeaders }?: ContentPublicValidator.GetLanguageByLocaleParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.Language>;
     /**
      * @param {ContentPublicValidator.GetMenuContentParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -108,7 +139,7 @@ declare class Content {
      * @summary: Get desktop menu content
      * @description: Retrieves the desktop menu content. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getMenuContentByType/).
      */
-    getMenuContentByType({ type, requestHeaders }?: ContentPublicValidator.GetMenuContentByTypeParam, { responseHeaders }?: object): Promise<ContentPublicModel.MenuTypeSchema>;
+    getMenuContentByType({ type, requestHeaders }?: ContentPublicValidator.GetMenuContentByTypeParam, { responseHeaders }?: object, ...args: any[]): Promise<ContentPublicModel.MenuTypeSchema>;
     /**
      * @param {ContentPublicValidator.GetNavbarParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -129,26 +160,6 @@ declare class Content {
      * @description: Retrieve pricing banner information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getPricingBanner/).
      */
     getPricingBanner({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.PricingBannerSchema>;
-    /**
-     * @param {ContentPublicValidator.GetSDKDocumentationParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<ContentPublicModel.SDKLinksResponseSchema>} - Success response
-     * @name getSDKDocumentation
-     * @summary: Get documentation link of Software Development Kit
-     * @description: Get documentation of SDK - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentation/).
-     */
-    getSDKDocumentation({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ContentPublicModel.SDKLinksResponseSchema>;
-    /**
-     * @param {ContentPublicValidator.GetSDKDocumentationByTypeParam} arg - Arg object.
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PublicAPIClient").Options} - Options
-     * @returns {Promise<ContentPublicModel.SDKbyTypeResponseSchema>} - Success response
-     * @name getSDKDocumentationByType
-     * @summary: Get documentation of Software Development Kit by its type
-     * @description: Get documentation of SDK by its type - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/content/getSDKDocumentationByType/).
-     */
-    getSDKDocumentationByType({ type, requestHeaders }?: ContentPublicValidator.GetSDKDocumentationByTypeParam, { responseHeaders }?: object): Promise<ContentPublicModel.SDKbyTypeResponseSchema>;
 }
 import ContentPublicModel = require("./ContentPublicModel");
 import ContentPublicValidator = require("./ContentPublicValidator");