@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.8

package/sdk/application/Communication/CommunicationApplicationModel.js

@@ -2,36 +2,48 @@ const Joi = require("joi");
 
 /**
  * @typedef CommunicationConsentReq
- * @property {string} [response]
- * @property {string} [action]
- * @property {string} [channel]
+ * @property {string} [response] - Whether the user has responded to the inquiry
+ *   regarding their preference for opting in or out of receiving communications.
+ * @property {string} [action] - The user's choice to opt in or opt out of
+ *   receiving communications.
+ * @property {string} [channel] - The channel of communication the user has
+ *   agreed to receive messages through.
  */
 
 /**
  * @typedef CommunicationConsentRes
- * @property {string} [app_id]
- * @property {string} [user_id]
+ * @property {string} [app_id] - The ID of the sales channel where the user has
+ *   given their consent.
+ * @property {string} [user_id] - Identifier which can uniquely identify the user.
  * @property {CommunicationConsentChannels} [channels]
  */
 
 /**
  * @typedef CommunicationConsentChannelsEmail
- * @property {string} [response]
- * @property {string} [display_name]
+ * @property {string} [response] - The user's choice to opt in or opt out of
+ *   receiving communications.
+ * @property {string} [display_name] - Name of the channel of communication the
+ *   user has agreed to receive messages through.
  */
 
 /**
  * @typedef CommunicationConsentChannelsSms
- * @property {string} [response]
- * @property {string} [display_name]
+ * @property {string} [response] - The user's choice to opt in or opt out of
+ *   receiving communications.
+ * @property {string} [display_name] - Name of the channel of communication the
+ *   user has agreed to receive messages through.
  */
 
 /**
  * @typedef CommunicationConsentChannelsWhatsapp
- * @property {string} [response]
- * @property {string} [display_name]
- * @property {string} [country_code]
- * @property {string} [phone_number]
+ * @property {string} [response] - The user's choice to opt in or opt out of
+ *   receiving communications.
+ * @property {string} [display_name] - Name of the channel of communication the
+ *   user has agreed to receive messages through.
+ * @property {string} [country_code] - Alphanumeric identification code for the
+ *   users country.
+ * @property {string} [phone_number] - Phone number of the user that the user
+ *   has accepted to receive communication through WhatsApp.
  */
 
 /**
@@ -43,39 +55,48 @@ const Joi = require("joi");
 
 /**
  * @typedef CommunicationConsent
- * @property {string} [app_id]
- * @property {string} [user_id]
+ * @property {string} [app_id] - The ID of the sales channel where the user has
+ *   given their consent.
+ * @property {string} [user_id] - Identifier which can uniquely identify the user.
  * @property {CommunicationConsentChannels} [channels]
  */
 
 /**
  * @typedef BadRequestSchema
- * @property {string} [status] - Response status.
- * @property {string} [message] - Failure message.
+ * @property {string} [status] - Error code indicating the type of issue.
+ * @property {string} [message] - Error message providing details about the error.
  */
 
 /**
  * @typedef PushtokenReq
- * @property {string} [action]
- * @property {string} [bundle_identifier]
- * @property {string} [push_token]
- * @property {string} [unique_device_id]
- * @property {string} [type]
+ * @property {string} [action] - The type of operation to perform with the push
+ *   token, such as create, update, or reset.
+ * @property {string} [bundle_identifier] - Unique identifier used to identify a bundle.
+ * @property {string} [push_token] - A string of codes containing comprehensive
+ *   data that identifies a identity of requester.
+ * @property {string} [unique_device_id] - Unique identifier used to identify a device.
+ * @property {string} [type] - Source address of the requestee.
  */
 
 /**
  * @typedef PushtokenRes
- * @property {string} [_id]
- * @property {string} [bundle_identifier]
- * @property {string} [push_token]
- * @property {string} [unique_device_id]
- * @property {string} [type]
- * @property {string} [platform]
- * @property {string} [application_id]
- * @property {string} [user_id]
- * @property {string} [created_at]
- * @property {string} [updated_at]
- * @property {string} [expired_at]
+ * @property {string} [_id] - Key used to uniquely identify document that
+ *   contains push token credentials.
+ * @property {string} [bundle_identifier] - Unique identifier used to identify a bundle.
+ * @property {string} [push_token] - A string of codes containing comprehensive
+ *   data that identifies a identity of requester.
+ * @property {string} [unique_device_id] - Unique identifier used to identify a device.
+ * @property {string} [type] - Source address of the requester.
+ * @property {string} [platform] - Source address of the requester.
+ * @property {string} [application_id] - The ID of the sales channel associated
+ *   with the push token.
+ * @property {string} [user_id] - Identifier which can uniquely identify the user.
+ * @property {string} [created_at] - The timestamp indicating when a record was
+ *   initially created.
+ * @property {string} [updated_at] - The timestamp indicating when a record was
+ *   last modified or updated.
+ * @property {string} [expired_at] - The timestamp indicating when a record is
+ *   set to expire or become invalid.
  */
 
 class CommunicationApplicationModel {

package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts

@@ -30,7 +30,7 @@ declare class Configuration {
      *   Success response
      * @name getAppCurrencies
      * @summary: Get currency configuration
-     * @description: Retrieve currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
+     * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
      */
     getAppCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppCurrencyResponse>;
     /**
@@ -41,7 +41,7 @@ declare class Configuration {
      *   Success response
      * @name getAppStaffList
      * @summary: List staff members
-     * @description: Retrieve a list of all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
+     * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
      */
     getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: ConfigurationApplicationValidator.GetAppStaffListParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffListResponse>;
     /**
@@ -52,7 +52,7 @@ declare class Configuration {
      *   Success response
      * @name getAppStaffs
      * @summary: Get staff member
-     * @description: Retrieve a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
+     * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
      */
     getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: ConfigurationApplicationValidator.GetAppStaffsParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppStaffResponse>;
     /**
@@ -62,7 +62,7 @@ declare class Configuration {
      * @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
      * @name getApplication
      * @summary: Get sales channel
-     * @description: Retrieve details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
+     * @description: Get details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
      */
     getApplication({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Application>;
     /**
@@ -73,7 +73,7 @@ declare class Configuration {
      *   Success response
      * @name getBasicDetails
      * @summary: Get Sales channel
-     * @description: Retrieve basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
+     * @description: Get basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
      */
     getBasicDetails({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationDetail>;
     /**
@@ -85,7 +85,7 @@ declare class Configuration {
      *
      * @name getContactInfo
      * @summary: Get sales channel contact
-     * @description: Retrieve contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
+     * @description: Get contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
      */
     getContactInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationInformation>;
     /**
@@ -96,7 +96,7 @@ declare class Configuration {
      *   Success response
      * @name getCurrencies
      * @summary: List currencies
-     * @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
+     * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
      */
     getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.CurrenciesResponse>;
     /**
@@ -106,7 +106,7 @@ declare class Configuration {
      * @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
      * @name getCurrencyById
      * @summary: Get a currency
-     * @description: Retrieve details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
+     * @description: Get details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
      */
     getCurrencyById({ id, requestHeaders }?: ConfigurationApplicationValidator.GetCurrencyByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.Currency>;
     /**
@@ -117,7 +117,7 @@ declare class Configuration {
      *   Success response
      * @name getFeatures
      * @summary: Get sales channel features
-     * @description: Retrieve configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
+     * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
      */
     getFeatures({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppFeatureResponse>;
     /**
@@ -130,7 +130,7 @@ declare class Configuration {
      *   Success response
      * @name getIntegrationTokens
      * @summary: Get API tokens
-     * @description: Retrieve tools integration token of the sales channel. For ex- Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
+     * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
      */
     getIntegrationTokens({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.AppTokenResponse>;
     /**
@@ -141,7 +141,7 @@ declare class Configuration {
      *   Success response
      * @name getLanguages
      * @summary: List languages
-     * @description: Retrieve a list of available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
+     * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
      */
     getLanguages({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.LanguageResponse>;
     /**
@@ -165,7 +165,7 @@ declare class Configuration {
      * @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
      * @name getOrderingStores
      * @summary: List order-enabled selling locations
-     * @description: Retrieve details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
+     * @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
      */
     getOrderingStores({ pageNo, pageSize, q, requestHeaders }?: ConfigurationApplicationValidator.GetOrderingStoresParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStores>;
     /**
@@ -177,7 +177,7 @@ declare class Configuration {
      *
      * @name getOwnerInfo
      * @summary: Get sales channel owner
-     * @description: Retrieve details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
+     * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
      */
     getOwnerInfo({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.ApplicationAboutResponse>;
     /**
@@ -188,7 +188,7 @@ declare class Configuration {
      * @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
      * @name getStoreDetailById
      * @summary: Get a selling location
-     * @description: Retrieve detail of a selling location (store) by it's Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
+     * @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
      */
     getStoreDetailById({ storeId, requestHeaders }?: ConfigurationApplicationValidator.GetStoreDetailByIdParam, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.OrderingStore>;
     /**
@@ -202,7 +202,7 @@ declare class Configuration {
      *
      * @name removeOrderingStoreCookie
      * @summary: Delete store cookie
-     * @description: Remove store cookie - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
+     * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
      */
     removeOrderingStoreCookie({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationApplicationModel.SuccessMessageResponse>;
 }

package/sdk/application/Configuration/ConfigurationApplicationClient.js

@@ -59,7 +59,7 @@ class Configuration {
    *   Success response
    * @name getAppCurrencies
    * @summary: Get currency configuration
-   * @description: Retrieve currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
+   * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
    */
   async getAppCurrencies(
     { requestHeaders } = { requestHeaders: {} },
@@ -140,7 +140,7 @@ class Configuration {
    *   Success response
    * @name getAppStaffList
    * @summary: List staff members
-   * @description: Retrieve a list of all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
+   * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
    */
   async getAppStaffList(
     {
@@ -235,7 +235,7 @@ class Configuration {
    *   Success response
    * @name getAppStaffs
    * @summary: Get staff member
-   * @description: Retrieve a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
+   * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
    */
   async getAppStaffs(
     { orderIncent, orderingStore, user, requestHeaders } = {
@@ -318,7 +318,7 @@ class Configuration {
    * @returns {Promise<ConfigurationApplicationModel.Application>} - Success response
    * @name getApplication
    * @summary: Get sales channel
-   * @description: Retrieve details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
+   * @description: Get details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
    */
   async getApplication(
     { requestHeaders } = { requestHeaders: {} },
@@ -399,7 +399,7 @@ class Configuration {
    *   Success response
    * @name getBasicDetails
    * @summary: Get Sales channel
-   * @description: Retrieve basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
+   * @description: Get basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
    */
   async getBasicDetails(
     { requestHeaders } = { requestHeaders: {} },
@@ -481,7 +481,7 @@ class Configuration {
    *
    * @name getContactInfo
    * @summary: Get sales channel contact
-   * @description: Retrieve contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
+   * @description: Get contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
    */
   async getContactInfo(
     { requestHeaders } = { requestHeaders: {} },
@@ -562,7 +562,7 @@ class Configuration {
    *   Success response
    * @name getCurrencies
    * @summary: List currencies
-   * @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
+   * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
    */
   async getCurrencies(
     { requestHeaders } = { requestHeaders: {} },
@@ -642,7 +642,7 @@ class Configuration {
    * @returns {Promise<ConfigurationApplicationModel.Currency>} - Success response
    * @name getCurrencyById
    * @summary: Get a currency
-   * @description: Retrieve details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
+   * @description: Get details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
    */
   async getCurrencyById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -723,7 +723,7 @@ class Configuration {
    *   Success response
    * @name getFeatures
    * @summary: Get sales channel features
-   * @description: Retrieve configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
+   * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
    */
   async getFeatures(
     { requestHeaders } = { requestHeaders: {} },
@@ -804,7 +804,7 @@ class Configuration {
    *   Success response
    * @name getIntegrationTokens
    * @summary: Get API tokens
-   * @description: Retrieve tools integration token of the sales channel. For ex- Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
+   * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
    */
   async getIntegrationTokens(
     { requestHeaders } = { requestHeaders: {} },
@@ -885,7 +885,7 @@ class Configuration {
    *   Success response
    * @name getLanguages
    * @summary: List languages
-   * @description: Retrieve a list of available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
+   * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
    */
   async getLanguages(
     { requestHeaders } = { requestHeaders: {} },
@@ -1047,7 +1047,7 @@ class Configuration {
    * @returns {Promise<ConfigurationApplicationModel.OrderingStores>} - Success response
    * @name getOrderingStores
    * @summary: List order-enabled selling locations
-   * @description: Retrieve details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
+   * @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
    */
   async getOrderingStores(
     { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -1132,7 +1132,7 @@ class Configuration {
    *
    * @name getOwnerInfo
    * @summary: Get sales channel owner
-   * @description: Retrieve details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
+   * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
    */
   async getOwnerInfo(
     { requestHeaders } = { requestHeaders: {} },
@@ -1211,7 +1211,7 @@ class Configuration {
    * @returns {Promise<ConfigurationApplicationModel.OrderingStore>} - Success response
    * @name getStoreDetailById
    * @summary: Get a selling location
-   * @description: Retrieve detail of a selling location (store) by it's Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
+   * @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
    */
   async getStoreDetailById(
     { storeId, requestHeaders } = { requestHeaders: {} },
@@ -1295,7 +1295,7 @@ class Configuration {
    *
    * @name removeOrderingStoreCookie
    * @summary: Delete store cookie
-   * @description: Remove store cookie - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
+   * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
    */
   async removeOrderingStoreCookie(
     { requestHeaders } = { requestHeaders: {} },