@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js

@@ -16,8 +16,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {DomainAddRequest} arg.body
    * @returns {Promise<Domain>} - Success response
-   * @summary: Add new domain to application
-   * @description: Add new domain to application.
+   * @summary: Add new domain to current sales channel
+   * @description: Add a new domain to current sales channel, including pre-defined domain (free domain) or custom domain (owned by the brand)
    */
   async addDomain({ body } = {}) {
     const { error } = ConfigurationValidator.addDomain().validate(
@@ -75,8 +75,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {UpdateDomainTypeRequest} arg.body
    * @returns {Promise<DomainsResponse>} - Success response
-   * @summary: Change domain type
-   * @description: Change a domain to Primary or Shortlink domain
+   * @summary: Change the type of domain in the current sales channel
+   * @description: Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. Use this API to change a domain to either Primary or a Shortlink domain.
    */
   async changeDomainType({ body } = {}) {
     const { error } = ConfigurationValidator.changeDomainType().validate(
@@ -137,8 +137,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<TokenResponse>} - Success response
-   * @summary: Get social tokens
-   * @description: Get social tokens.
+   * @summary: Get social tokens for the sales channel
+   * @description: Use this API to retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. **Note** - Token values are encrypted with AES encryption using a secret key.
    */
   async getAppApiTokens({} = {}) {
     const { error } = ConfigurationValidator.getAppApiTokens().validate(
@@ -195,8 +195,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<ApplicationDetail>} - Success response
-   * @summary: Get basic application details
-   * @description: Get basic application details like name
+   * @summary: Get sales channel details
+   * @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information.
    */
   async getAppBasicDetails({} = {}) {
     const { error } = ConfigurationValidator.getAppBasicDetails().validate(
@@ -252,12 +252,14 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {number} [arg.uid] - Uid of companies to be fetched
-   * @param {number} [arg.pageNo] - Current page no
-   * @param {number} [arg.pageSize] - Current request items count
+   * @param {number} [arg.uid] - UID of companies to be fetched
+   * @param {number} [arg.pageNo] - The current page number to navigate
+   *   through the given set of results. Default value is 1.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
    * @returns {Promise<CompaniesResponse>} - Success response
-   * @summary: Application inventory enabled companies
-   * @description: Application inventory enabled companies.
+   * @summary: Get companies enabled in the sales channel inventory
+   * @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
    */
   async getAppCompanies({ uid, pageNo, pageSize } = {}) {
     const { error } = ConfigurationValidator.getAppCompanies().validate(
@@ -324,12 +326,15 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Current company id
-   * @param {string} arg.applicationId - Current application id
-   * @param {number} [arg.uid] - Uid of companies to be fetched
-   * @param {number} [arg.pageSize] - Current request items count
-   * @summary: Application inventory enabled companies
-   * @description: Application inventory enabled companies.
+   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   *   on Fynd Platform
+   * @param {string} arg.applicationId - Alphanumeric ID allotted to an
+   *   application (sales channel website) created within a business account
+   * @param {number} [arg.uid] - UID of companies to be fetched
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
+   * @summary: Get companies enabled in the sales channel inventory
+   * @description: Fetch info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel application
    */
   getAppCompaniesPaginator({ companyId, applicationId, uid, pageSize } = {}) {
     const paginator = new Paginator();
@@ -357,8 +362,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<ApplicationInformation>} - Success response
-   * @summary: Get application information
-   * @description: Get Application Current Information. This includes information about social links, address and contact information of company/seller/brand of the application.
+   * @summary: Get current information of the sales channel
+   * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
    */
   async getAppContactInfo({} = {}) {
     const { error } = ConfigurationValidator.getAppContactInfo().validate(
@@ -415,8 +420,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<AppSupportedCurrency>} - Success response
-   * @summary: Get application enabled currency list
-   * @description: Get application enabled currency list
+   * @summary: Get currencies supported in the application
+   * @description: Get a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the application.
    */
   async getAppCurrencyConfig({} = {}) {
     const { error } = ConfigurationValidator.getAppCurrencyConfig().validate(
@@ -473,8 +478,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<AppFeatureResponse>} - Success response
-   * @summary: Get features of application
-   * @description: Get features of application
+   * @summary: Get the sales channel configuration and features
+   * @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
    */
   async getAppFeatures({} = {}) {
     const { error } = ConfigurationValidator.getAppFeatures().validate(
@@ -530,11 +535,13 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageNo] - Current page no
-   * @param {number} [arg.pageSize] - Current request items count
+   * @param {number} [arg.pageNo] - The current page number to navigate
+   *   through the given set of results. Default value is 1.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
    * @returns {Promise<StoresResponse>} - Success response
-   * @summary: Application inventory enabled stores
-   * @description: Application inventory enabled stores.
+   * @summary: Get stores enabled in the sales channel inventory
+   * @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
    */
   async getAppStores({ pageNo, pageSize } = {}) {
     const { error } = ConfigurationValidator.getAppStores().validate(
@@ -596,11 +603,14 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Current company id
-   * @param {string} arg.applicationId - Current application id
-   * @param {number} [arg.pageSize] - Current request items count
-   * @summary: Application inventory enabled stores
-   * @description: Application inventory enabled stores.
+   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   *   on Fynd Platform
+   * @param {string} arg.applicationId - Alphanumeric ID allotted to an
+   *   application (sales channel website) created within a business account
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
+   * @summary: Get stores enabled in the sales channel inventory
+   * @description: Fetch info of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel application
    */
   getAppStoresPaginator({ companyId, applicationId, pageSize } = {}) {
     const paginator = new Paginator();
@@ -685,8 +695,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<Application>} - Success response
-   * @summary: Get application data from id
-   * @description: Get application data from id
+   * @summary: Get sales channel data by ID
+   * @description: Use application ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc.
    */
   async getApplicationById({} = {}) {
     const { error } = ConfigurationValidator.getApplicationById().validate(
@@ -742,10 +752,11 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.platformType - Current platform name
+   * @param {string} arg.platformType - The device platform for which the
+   *   mobile app is built, e.g. android, ios.
    * @returns {Promise<MobileAppConfiguration>} - Success response
-   * @summary: Get latest build config
-   * @description: Get latest build config
+   * @summary: Get configuration of latest mobile build
+   * @description: Fetch latest build configuration, such as app name, landing page image, splash image used in a mobile build.
    */
   async getBuildConfig({ platformType } = {}) {
     const { error } = ConfigurationValidator.getBuildConfig().validate(
@@ -807,8 +818,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {DomainStatusRequest} arg.body
    * @returns {Promise<DomainStatusResponse>} - Success response
-   * @summary: Get domain connected status.
-   * @description: Get domain connected status. Check if domain is live and mapped to appropriate IP to fynd servers.
+   * @summary: Get the status of connected domain
+   * @description: Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers.
    */
   async getDomainStatus({ body } = {}) {
     const { error } = ConfigurationValidator.getDomainStatus().validate(
@@ -869,8 +880,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<DomainsResponse>} - Success response
-   * @summary: Get attached domain list
-   * @description: Get attached domain list.
+   * @summary: Fetch all the domains added to an  application (sales channel website), including pre-defined domain (free domain) or custom domain (owned by the brand). Know the verification status of each domain name, and find out which one is the primary domain, short link domain, or both.
+   * @description: Get list of domains
    */
   async getDomains({} = {}) {
     const { error } = ConfigurationValidator.getDomains().validate(
@@ -925,8 +936,8 @@ class Configuration {
   /**
    * @param {Object} arg - Arg object.
    * @returns {Promise<ApplicationInventory>} - Success response
-   * @summary: Get application configuration
-   * @description: Get application configuration for various features and data
+   * @summary: Get sales channel configuration
+   * @description: Use this API to fetch configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
    */
   async getInventoryConfig({} = {}) {
     const { error } = ConfigurationValidator.getInventoryConfig().validate(
@@ -982,12 +993,14 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {number} [arg.pageNo] - Current page no
-   * @param {number} [arg.pageSize] - Current request items count
+   * @param {number} [arg.pageNo] - The page number to navigate through the
+   *   given set of results. Default value is 1.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
    * @param {FilterOrderingStoreRequest} arg.body
    * @returns {Promise<OrderingStores>} - Success response
    * @summary: Get ordering store by filter
-   * @description: Get ordering store by filter
+   * @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
    */
   async getOrderingStoresByFilter({ body, pageNo, pageSize } = {}) {
     const {
@@ -1055,12 +1068,15 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Current company id
-   * @param {string} arg.applicationId - Current application id
-   * @param {number} [arg.pageSize] - Current request items count
+   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   *   on Fynd Platform
+   * @param {string} arg.applicationId - Alphanumeric ID allotted to an
+   *   application (sales channel website) created within a business account
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each
+   *   page. Default value is 10.
    * @param {FilterOrderingStoreRequest} arg.body
    * @summary: Get ordering store by filter
-   * @description: Get ordering store by filter
+   * @description: Use this API to use filters and retrieve the details of the deployment stores (the selling locations where the application will be utilised for placing orders).
    */
   getOrderingStoresByFilterPaginator({
     companyId,
@@ -1092,10 +1108,11 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.platformType - Current platform name
+   * @param {string} arg.platformType - The device platform for which the
+   *   mobile app is built, e.g. android, ios.
    * @returns {Promise<BuildVersionHistory>} - Success response
-   * @summary: Get previous build versions
-   * @description: Get previous build versions
+   * @summary: Get details of previous mobile builds
+   * @description: Fetch version details of the app, this includes the build status, build date, version name, latest version, and a lot more.
    */
   async getPreviousVersions({ platformType } = {}) {
     const { error } = ConfigurationValidator.getPreviousVersions().validate(
@@ -1229,8 +1246,10 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.companyId - Current company id
-   * @param {string} arg.applicationId - Current application id
+   * @param {string} arg.companyId - Numeric ID allotted to a business account
+   *   on Fynd Platform
+   * @param {string} arg.applicationId - Alphanumeric ID allotted to an
+   *   application (sales channel website) created within a business account
    * @param {number} [arg.pageSize] - The number of items to retrieve in each
    *   page. Default value is 10.
    * @param {string} [arg.q] - Store code or name of the ordering store.
@@ -1332,8 +1351,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {AppInventoryPartialUpdate} arg.body
    * @returns {Promise<ApplicationInventory>} - Success response
-   * @summary: Partially update application configuration
-   * @description: Partially update application configuration for various features and data
+   * @summary: Partially update sales channel configuration
+   * @description: Partially update the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
    */
   async partiallyUpdateInventoryConfig({ body } = {}) {
     const {
@@ -1397,10 +1416,11 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.id - Domain _id
+   * @param {string} arg.id - The unique identifier (24-digit Mongo Object ID)
+   *   of the domain
    * @returns {Promise<SuccessMessageResponse>} - Success response
-   * @summary: Remove attached domain
-   * @description: Remove attached domain.
+   * @summary: Remove attached domain from current sales channel
+   * @description: Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain.
    */
   async removeDomainById({ id } = {}) {
     const { error } = ConfigurationValidator.removeDomainById().validate(
@@ -1462,8 +1482,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {TokenResponse} arg.body
    * @returns {Promise<TokenResponse>} - Success response
-   * @summary: Add social tokens
-   * @description: Add social tokens.
+   * @summary: Add or update social tokens for the sales channel
+   * @description: Use this API to add or edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth.
    */
   async updateAppApiTokens({ body } = {}) {
     const { error } = ConfigurationValidator.updateAppApiTokens().validate(
@@ -1525,8 +1545,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {ApplicationDetail} arg.body
    * @returns {Promise<ApplicationDetail>} - Success response
-   * @summary: Add or update application's basic details
-   * @description: Add or update application's basic details
+   * @summary: Update sales channel details
+   * @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information.
    */
   async updateAppBasicDetails({ body } = {}) {
     const { error } = ConfigurationValidator.updateAppBasicDetails().validate(
@@ -1588,8 +1608,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {ApplicationInformation} arg.body
    * @returns {Promise<ApplicationInformation>} - Success response
-   * @summary: Get application information
-   * @description: Save Application Current Information. This includes information about social links, address and contact information of an application.
+   * @summary: Save or update current information of the sales channel
+   * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the application.
    */
   async updateAppContactInfo({ body } = {}) {
     const { error } = ConfigurationValidator.updateAppContactInfo().validate(
@@ -1651,8 +1671,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {AppSupportedCurrency} arg.body
    * @returns {Promise<AppSupportedCurrency>} - Success response
-   * @summary: Add initial application supported currency
-   * @description: Add initial application supported currency for various features and data. Default INR will be enabled.
+   * @summary: Update initial sales channel supported currency
+   * @description: Use this API to add and edit the currencies supported in the application. Initially, INR will be enabled by default.
    */
   async updateAppCurrencyConfig({ body } = {}) {
     const { error } = ConfigurationValidator.updateAppCurrencyConfig().validate(
@@ -1714,8 +1734,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {AppFeatureRequest} arg.body
    * @returns {Promise<AppFeature>} - Success response
-   * @summary: Update features of application
-   * @description: Update features of application
+   * @summary: Update the sales channel configuration and features
+   * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more.
    */
   async updateAppFeatures({ body } = {}) {
     const { error } = ConfigurationValidator.updateAppFeatures().validate(
@@ -1775,11 +1795,12 @@ class Configuration {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.platformType - Current platform name
+   * @param {string} arg.platformType - The device platform for which the
+   *   mobile app is built, e.g. android, ios.
    * @param {MobileAppConfigRequest} arg.body
    * @returns {Promise<MobileAppConfiguration>} - Success response
-   * @summary: Update build config for next build
-   * @description: Update build config for next build
+   * @summary: Update the configuration for next mobile build
+   * @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build.
    */
   async updateBuildConfig({ platformType, body } = {}) {
     const { error } = ConfigurationValidator.updateBuildConfig().validate(
@@ -1843,8 +1864,8 @@ class Configuration {
    * @param {Object} arg - Arg object.
    * @param {ApplicationInventory} arg.body
    * @returns {Promise<ApplicationInventory>} - Success response
-   * @summary: Update application configuration
-   * @description: Update application configuration for various features and data
+   * @summary: Update sales channel configuration
+   * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc.
    */
   async updateInventoryConfig({ body } = {}) {
     const { error } = ConfigurationValidator.updateInventoryConfig().validate(
@@ -1907,7 +1928,7 @@ class Configuration {
    * @param {OrderingStoreConfig} arg.body
    * @returns {Promise<DeploymentMeta>} - Success response
    * @summary: Add/Update ordering store config
-   * @description: Add/Update ordering store config.
+   * @description: Use this API to edit the details of the deployment stores (the selling locations where the application will be utilised for placing orders)
    */
   async updateOrderingStoreConfig({ body } = {}) {
     const {