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

package/sdk/application/Common/CommonApplicationModel.js

@@ -7,37 +7,37 @@ const Joi = require("joi");
 
 /**
  * @typedef Domain
- * @property {boolean} [verified] - Indicates domain is verified or not. TXT and
- *   A records should propagate correctly.
- * @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 {boolean} [verified] - Whether domain is verified or not. TXT and A
+ *   records should propagate correctly.
+ * @property {boolean} [is_primary] - Whether domain is primary or not. Primary
+ *   domain is the default/main domain.
+ * @property {boolean} [is_shortlink] - Whether shortlink is present or not for
+ *   the domain.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the domain
- * @property {string} [name]
- * @property {boolean} [is_predefined] - Domain is hosting domain or not
+ *   of the domain.
+ * @property {string} [name] - The name of the domain.
+ * @property {boolean} [is_predefined] - Whether domain is hosting domain or not.
  */
 
 /**
  * @typedef ApplicationWebsite
- * @property {boolean} [enabled] - Shows whether sales channel website URL is
- *   enabled or not
- * @property {string} [basepath] - Base path for the current sales channel website
+ * @property {boolean} [enabled] - Whether sales channel website URL is enabled or not.
+ * @property {string} [basepath] - Base path for the current sales channel website.
  */
 
 /**
  * @typedef ApplicationCors
- * @property {string[]} [domains]
+ * @property {string[]} [domains] - List of all domains added to the sales channel.
  */
 
 /**
  * @typedef ApplicationAuth
- * @property {boolean} [enabled] - Shows sales channel auth is enabled or not enabled.
+ * @property {boolean} [enabled] - Whether sales channel auth is enabled or not enabled.
  */
 
 /**
  * @typedef ApplicationRedirections
- * @property {string} [redirect_from] - Old domain URL of the sales channel
+ * @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
@@ -47,13 +47,13 @@ const Joi = require("joi");
 
 /**
  * @typedef ApplicationMeta
- * @property {string} [name] - Indicates the name of application meta
- * @property {string} [value] - Value related to application meta name
+ * @property {string} [name] - Indicates the name of application meta.
+ * @property {string} [value] - Value related to application meta name.
  */
 
 /**
  * @typedef SecureUrl
- * @property {string} [secure_url] - Hosted URL of the image
+ * @property {string} [secure_url] - Hosted URL of the image.
  */
 
 /**
@@ -61,87 +61,88 @@ const Joi = require("joi");
  * @property {ApplicationWebsite} [website]
  * @property {ApplicationCors} [cors]
  * @property {ApplicationAuth} [auth]
- * @property {string} [description] - It contains detailed information about the
- *   sales channel
+ * @property {string} [description] - Detailed information about the sales channel.
  * @property {string} [channel_type] - It indicates different channel types like
  *   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 whether a sales channel is active
- *   or not active
+ * @property {number} [cache_ttl] - Number of seconds until the key expires.
+ * @property {boolean} [is_internal] - Whether a sales channel is internal or not.
+ * @property {boolean} [is_active] - Whether a sales channel is active or not active.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
- * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
+ *   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
+ *   of owner who owns the application.
  * @property {number} [company_id] - Numeric ID allotted to a business account
- *   where the sales channel exists
+ *   where the sales channel exists.
  * @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} [updated_at] - ISO 8601 timestamp of sales channel updation
+ * @property {ApplicationRedirections[]} [redirections] - List of redirection
+ *   configurations for the sales channel.
+ * @property {ApplicationMeta[]} [meta] - List of metadata associated with the
+ *   sales channel.
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation.
+ * @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 {Domain[]} [domains] - List of domains associated with the sales channel.
  * @property {string} [app_type] - It shows whether application is live or in
- *   development mode
+ *   development mode.
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
  */
 
 /**
  * @typedef NotFound
- * @property {string} [message] - Response message for not found
+ * @property {string} [message] - Response message for not found.
  */
 
 /**
  * @typedef BadRequest
- * @property {string} [message] - Failure message (in a string format)
+ * @property {string} [message] - Failure message (in a string format).
  */
 
 /**
  * @typedef LocationDefaultLanguage
- * @property {string} [name]
- * @property {string} [code]
+ * @property {string} [name] - Name of the language.
+ * @property {string} [code] - Code of the language.
  */
 
 /**
  * @typedef LocationDefaultCurrency
- * @property {string} [name]
- * @property {string} [symbol]
- * @property {string} [code]
+ * @property {string} [name] - The name of the currency.
+ * @property {string} [symbol] - The symbol representing the currency.
+ * @property {string} [code] - The ISO 4217 code for the currency.
  */
 
 /**
  * @typedef LocationCountry
- * @property {string} [capital]
- * @property {string} [currency]
- * @property {string} [iso2]
- * @property {string} [iso3]
- * @property {string} [name]
- * @property {string} [parent]
- * @property {string} [phone_code]
- * @property {string} [type]
- * @property {number} [uid]
- * @property {number} [__v]
- * @property {string} [_id]
+ * @property {string} [capital] - The capital of the country.
+ * @property {string} [currency] - The currency code used in the country.
+ * @property {string} [iso2] - The ISO 3166-1 alpha-2 code for the country.
+ * @property {string} [iso3] - The ISO 3166-1 alpha-3 code for the country.
+ * @property {string} [name] - The name of the country.
+ * @property {string} [parent] - The parent country if this is a subnational
+ *   entity (e.g., a territory or region).
+ * @property {string} [phone_code] - The international dialing code for the country.
+ * @property {string} [type] - The type of location, which is a country in this context.
+ * @property {number} [uid] - A unique identifier for the country.
+ * @property {number} [__v] - Version key for tracking revisions.
+ * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
+ *   for the country.
  * @property {LocationDefaultCurrency} [default_currency]
  * @property {LocationDefaultLanguage} [default_language]
- * @property {string} [state_code]
- * @property {string} [country_code]
- * @property {string} [latitude]
- * @property {string} [longitude]
+ * @property {string} [state_code] - The code representing the state or region
+ *   within the country, if applicable.
+ * @property {string} [country_code] - The country code used for the country.
+ * @property {string} [latitude] - The latitude of the store's location.
+ * @property {string} [longitude] - The longitude of the store's location.
  */
 
 /**
  * @typedef Locations
- * @property {LocationCountry[]} [items]
+ * @property {LocationCountry[]} [items] - A list of country location details.
  */
 
 class CommonApplicationModel {

package/sdk/application/Common/CommonApplicationValidator.d.ts

@@ -2,15 +2,15 @@ export = CommonApplicationValidator;
 /**
  * @typedef GetLocationsParam
  * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
+ *   Possible values : country, state, city.
  * @property {string} [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.
  */
 /**
  * @typedef SearchApplicationParam
- * @property {string} [authorization]
- * @property {string} [query] - Provide application name
+ * @property {string} [authorization] - Basic auth string to access the api endpoint.
+ * @property {string} [query] - Provide application name.
  */
 declare class CommonApplicationValidator {
     /** @returns {GetLocationsParam} */
@@ -24,7 +24,7 @@ declare namespace CommonApplicationValidator {
 type GetLocationsParam = {
     /**
      * - Provide location type to query on.
-     * Possible values : country, state, city
+     * Possible values : country, state, city.
      */
     locationType?: string;
     /**
@@ -35,9 +35,12 @@ type GetLocationsParam = {
     id?: string;
 };
 type SearchApplicationParam = {
+    /**
+     * - Basic auth string to access the api endpoint.
+     */
     authorization?: string;
     /**
-     * - Provide application name
+     * - Provide application name.
      */
     query?: string;
 };

package/sdk/application/Common/CommonApplicationValidator.js

@@ -5,7 +5,7 @@ const CommonApplicationModel = require("./CommonApplicationModel");
 /**
  * @typedef GetLocationsParam
  * @property {string} [locationType] - Provide location type to query on.
- *   Possible values : country, state, city
+ *   Possible values : country, state, city.
  * @property {string} [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.
@@ -13,8 +13,8 @@ const CommonApplicationModel = require("./CommonApplicationModel");
 
 /**
  * @typedef SearchApplicationParam
- * @property {string} [authorization]
- * @property {string} [query] - Provide application name
+ * @property {string} [authorization] - Basic auth string to access the api endpoint.
+ * @property {string} [query] - Provide application name.
  */
 
 class CommonApplicationValidator {

package/sdk/application/Communication/CommunicationApplicationClient.d.ts

@@ -19,7 +19,7 @@ declare class Communication {
      *   Success response
      * @name getCommunicationConsent
      * @summary: Retrieve consent status
-     * @description: Retrieve the consent provided by the user for receiving communication - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
+     * @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
      */
     getCommunicationConsent({ requestHeaders }?: any, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsent>;
     /**
@@ -44,7 +44,7 @@ declare class Communication {
      *
      * @name upsertCommunicationConsent
      * @summary: Update or adds consent settings
-     * @description: Update or inserts the consent provided by the user for receiving communication messages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
+     * @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
      */
     upsertCommunicationConsent({ body, requestHeaders }?: CommunicationApplicationValidator.UpsertCommunicationConsentParam, { responseHeaders }?: object): Promise<CommunicationApplicationModel.CommunicationConsentRes>;
 }

package/sdk/application/Communication/CommunicationApplicationClient.js

@@ -46,7 +46,7 @@ class Communication {
    *   Success response
    * @name getCommunicationConsent
    * @summary: Retrieve consent status
-   * @description: Retrieve the consent provided by the user for receiving communication - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
+   * @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
    */
   async getCommunicationConsent(
     { requestHeaders } = { requestHeaders: {} },
@@ -211,7 +211,7 @@ class Communication {
    *
    * @name upsertCommunicationConsent
    * @summary: Update or adds consent settings
-   * @description: Update or inserts the consent provided by the user for receiving communication messages - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
+   * @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
    */
   async upsertCommunicationConsent(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/application/Communication/CommunicationApplicationModel.d.ts

@@ -1,32 +1,44 @@
 export = CommunicationApplicationModel;
 /**
  * @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.
  */
 /**
  * @typedef CommunicationConsentChannels
@@ -36,36 +48,45 @@ export = CommunicationApplicationModel;
  */
 /**
  * @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.
  */
 declare class CommunicationApplicationModel {
 }
@@ -75,35 +96,86 @@ declare namespace CommunicationApplicationModel {
 /** @returns {CommunicationConsentReq} */
 declare function CommunicationConsentReq(): CommunicationConsentReq;
 type CommunicationConsentReq = {
+    /**
+     * - Whether the user has responded to the inquiry
+     * regarding their preference for opting in or out of receiving communications.
+     */
     response?: string;
+    /**
+     * - The user's choice to opt in or opt out of
+     * receiving communications.
+     */
     action?: string;
+    /**
+     * - The channel of communication the user has
+     * agreed to receive messages through.
+     */
     channel?: string;
 };
 /** @returns {CommunicationConsentRes} */
 declare function CommunicationConsentRes(): CommunicationConsentRes;
 type CommunicationConsentRes = {
+    /**
+     * - The ID of the sales channel where the user has
+     * given their consent.
+     */
     app_id?: string;
+    /**
+     * - Identifier which can uniquely identify the user.
+     */
     user_id?: string;
     channels?: CommunicationConsentChannels;
 };
 /** @returns {CommunicationConsentChannelsEmail} */
 declare function CommunicationConsentChannelsEmail(): CommunicationConsentChannelsEmail;
 type CommunicationConsentChannelsEmail = {
+    /**
+     * - The user's choice to opt in or opt out of
+     * receiving communications.
+     */
     response?: string;
+    /**
+     * - Name of the channel of communication the
+     * user has agreed to receive messages through.
+     */
     display_name?: string;
 };
 /** @returns {CommunicationConsentChannelsSms} */
 declare function CommunicationConsentChannelsSms(): CommunicationConsentChannelsSms;
 type CommunicationConsentChannelsSms = {
+    /**
+     * - The user's choice to opt in or opt out of
+     * receiving communications.
+     */
     response?: string;
+    /**
+     * - Name of the channel of communication the
+     * user has agreed to receive messages through.
+     */
     display_name?: string;
 };
 /** @returns {CommunicationConsentChannelsWhatsapp} */
 declare function CommunicationConsentChannelsWhatsapp(): CommunicationConsentChannelsWhatsapp;
 type CommunicationConsentChannelsWhatsapp = {
+    /**
+     * - The user's choice to opt in or opt out of
+     * receiving communications.
+     */
     response?: string;
+    /**
+     * - Name of the channel of communication the
+     * user has agreed to receive messages through.
+     */
     display_name?: string;
+    /**
+     * - Alphanumeric identification code for the
+     * users country.
+     */
     country_code?: string;
+    /**
+     * - Phone number of the user that the user
+     * has accepted to receive communication through WhatsApp.
+     */
     phone_number?: string;
 };
 /** @returns {CommunicationConsentChannels} */
@@ -116,7 +188,14 @@ type CommunicationConsentChannels = {
 /** @returns {CommunicationConsent} */
 declare function CommunicationConsent(): CommunicationConsent;
 type CommunicationConsent = {
+    /**
+     * - The ID of the sales channel where the user has
+     * given their consent.
+     */
     app_id?: string;
+    /**
+     * - Identifier which can uniquely identify the user.
+     */
     user_id?: string;
     channels?: CommunicationConsentChannels;
 };
@@ -124,35 +203,91 @@ type CommunicationConsent = {
 declare function BadRequestSchema(): BadRequestSchema;
 type BadRequestSchema = {
     /**
-     * - Response status.
+     * - Error code indicating the type of issue.
      */
     status?: string;
     /**
-     * - Failure message.
+     * - Error message providing details about the error.
      */
     message?: string;
 };
 /** @returns {PushtokenReq} */
 declare function PushtokenReq(): PushtokenReq;
 type PushtokenReq = {
+    /**
+     * - The type of operation to perform with the push
+     * token, such as create, update, or reset.
+     */
     action?: string;
+    /**
+     * - Unique identifier used to identify a bundle.
+     */
     bundle_identifier?: string;
+    /**
+     * - A string of codes containing comprehensive
+     * data that identifies a identity of requester.
+     */
     push_token?: string;
+    /**
+     * - Unique identifier used to identify a device.
+     */
     unique_device_id?: string;
+    /**
+     * - Source address of the requestee.
+     */
     type?: string;
 };
 /** @returns {PushtokenRes} */
 declare function PushtokenRes(): PushtokenRes;
 type PushtokenRes = {
+    /**
+     * - Key used to uniquely identify document that
+     * contains push token credentials.
+     */
     _id?: string;
+    /**
+     * - Unique identifier used to identify a bundle.
+     */
     bundle_identifier?: string;
+    /**
+     * - A string of codes containing comprehensive
+     * data that identifies a identity of requester.
+     */
     push_token?: string;
+    /**
+     * - Unique identifier used to identify a device.
+     */
     unique_device_id?: string;
+    /**
+     * - Source address of the requester.
+     */
     type?: string;
+    /**
+     * - Source address of the requester.
+     */
     platform?: string;
+    /**
+     * - The ID of the sales channel associated
+     * with the push token.
+     */
     application_id?: string;
+    /**
+     * - Identifier which can uniquely identify the user.
+     */
     user_id?: string;
+    /**
+     * - The timestamp indicating when a record was
+     * initially created.
+     */
     created_at?: string;
+    /**
+     * - The timestamp indicating when a record was
+     * last modified or updated.
+     */
     updated_at?: string;
+    /**
+     * - The timestamp indicating when a record is
+     * set to expire or become invalid.
+     */
     expired_at?: string;
 };