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

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

@@ -5,33 +5,33 @@ export = CommonApplicationModel;
  */
 /**
  * @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
@@ -40,93 +40,94 @@ export = CommonApplicationModel;
  */
 /**
  * @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.
  */
 /**
  * @typedef Application
  * @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.
  */
 declare class CommonApplicationModel {
 }
@@ -142,27 +143,31 @@ type ApplicationResponse = {
 declare function Domain(): Domain;
 type Domain = {
     /**
-     * - Indicates domain is verified or not. TXT and
-     * A records should propagate correctly.
+     * - Whether domain is verified or not. TXT and A
+     * records should propagate correctly.
      */
     verified?: boolean;
     /**
-     * - Indicates domain is primary or not.
-     * Primary domain is the default/main domain.
+     * - Whether domain is primary or not. Primary
+     * domain is the default/main domain.
      */
     is_primary?: boolean;
     /**
-     * - Shortlink is present or not for the domain
+     * - Whether shortlink is present or not for
+     * the domain.
      */
     is_shortlink?: boolean;
     /**
      * - The unique identifier (24-digit Mongo Object ID)
-     * of the domain
+     * of the domain.
      */
     _id?: string;
+    /**
+     * - The name of the domain.
+     */
     name?: string;
     /**
-     * - Domain is hosting domain or not
+     * - Whether domain is hosting domain or not.
      */
     is_predefined?: boolean;
 };
@@ -170,25 +175,27 @@ type Domain = {
 declare function ApplicationWebsite(): ApplicationWebsite;
 type ApplicationWebsite = {
     /**
-     * - Shows whether sales channel website URL is
-     * enabled or not
+     * - Whether sales channel website URL is enabled or not.
      */
     enabled?: boolean;
     /**
-     * - Base path for the current sales channel website
+     * - Base path for the current sales channel website.
      */
     basepath?: string;
 };
 /** @returns {ApplicationCors} */
 declare function ApplicationCors(): ApplicationCors;
 type ApplicationCors = {
+    /**
+     * - List of all domains added to the sales channel.
+     */
     domains?: string[];
 };
 /** @returns {ApplicationAuth} */
 declare function ApplicationAuth(): ApplicationAuth;
 type ApplicationAuth = {
     /**
-     * - Shows sales channel auth is enabled or not enabled.
+     * - Whether sales channel auth is enabled or not enabled.
      */
     enabled?: boolean;
 };
@@ -196,7 +203,7 @@ type ApplicationAuth = {
 declare function ApplicationRedirections(): ApplicationRedirections;
 type ApplicationRedirections = {
     /**
-     * - Old domain URL of the sales channel
+     * - Old domain URL of the sales channel.
      */
     redirect_from?: string;
     /**
@@ -215,11 +222,11 @@ type ApplicationRedirections = {
 declare function ApplicationMeta(): ApplicationMeta;
 type ApplicationMeta = {
     /**
-     * - Indicates the name of application meta
+     * - Indicates the name of application meta.
      */
     name?: string;
     /**
-     * - Value related to application meta name
+     * - Value related to application meta name.
      */
     value?: string;
 };
@@ -227,7 +234,7 @@ type ApplicationMeta = {
 declare function SecureUrl(): SecureUrl;
 type SecureUrl = {
     /**
-     * - Hosted URL of the image
+     * - Hosted URL of the image.
      */
     secure_url?: string;
 };
@@ -238,8 +245,7 @@ type Application = {
     cors?: ApplicationCors;
     auth?: ApplicationAuth;
     /**
-     * - It contains detailed information about the
-     * sales channel
+     * - Detailed information about the sales channel.
      */
     description?: string;
     /**
@@ -248,37 +254,34 @@ type Application = {
      */
     channel_type?: string;
     /**
-     * - An integer value that specifies the number
-     * of seconds until the key expires
+     * - Number of seconds until the key expires.
      */
     cache_ttl?: number;
     /**
-     * - Indicates whether a sales channel is
-     * internal or not
+     * - Whether a sales channel is internal or not.
      */
     is_internal?: boolean;
     /**
-     * - Indicates whether a sales channel is active
-     * or not active
+     * - Whether a sales channel is active or not active.
      */
     is_active?: boolean;
     /**
      * - The unique identifier (24-digit Mongo Object ID)
-     * of the sales channel
+     * of the sales channel.
      */
     _id?: string;
     /**
-     * - Name of the sales channel, e.g. Zenz Fashion
+     * - Name of the sales channel, e.g. Zenz Fashion.
      */
     name?: string;
     /**
      * - The unique identifier (24-digit Mongo Object ID)
-     * of owner who owns the application
+     * of owner who owns the application.
      */
     owner?: string;
     /**
      * - Numeric ID allotted to a business account
-     * where the sales channel exists
+     * where the sales channel exists.
      */
     company_id?: number;
     /**
@@ -286,14 +289,22 @@ type Application = {
      * channel. It is required and auto-generated.
      */
     token?: string;
+    /**
+     * - List of redirection
+     * configurations for the sales channel.
+     */
     redirections?: ApplicationRedirections[];
+    /**
+     * - List of metadata associated with the
+     * sales channel.
+     */
     meta?: ApplicationMeta[];
     /**
-     * - ISO 8601 timestamp of sales channel creation
+     * - ISO 8601 timestamp of sales channel creation.
      */
     created_at?: string;
     /**
-     * - ISO 8601 timestamp of sales channel updation
+     * - ISO 8601 timestamp of sales channel updation.
      */
     updated_at?: string;
     /**
@@ -303,10 +314,13 @@ type Application = {
     banner?: SecureUrl;
     logo?: SecureUrl;
     favicon?: SecureUrl;
+    /**
+     * - List of domains associated with the sales channel.
+     */
     domains?: Domain[];
     /**
      * - It shows whether application is live or in
-     * development mode
+     * development mode.
      */
     app_type?: string;
     mobile_logo?: SecureUrl;
@@ -316,7 +330,7 @@ type Application = {
 declare function NotFound(): NotFound;
 type NotFound = {
     /**
-     * - Response message for not found
+     * - Response message for not found.
      */
     message?: string;
 };
@@ -324,46 +338,112 @@ type NotFound = {
 declare function BadRequest(): BadRequest;
 type BadRequest = {
     /**
-     * - Failure message (in a string format)
+     * - Failure message (in a string format).
      */
     message?: string;
 };
 /** @returns {LocationDefaultLanguage} */
 declare function LocationDefaultLanguage(): LocationDefaultLanguage;
 type LocationDefaultLanguage = {
+    /**
+     * - Name of the language.
+     */
     name?: string;
+    /**
+     * - Code of the language.
+     */
     code?: string;
 };
 /** @returns {LocationDefaultCurrency} */
 declare function LocationDefaultCurrency(): LocationDefaultCurrency;
 type LocationDefaultCurrency = {
+    /**
+     * - The name of the currency.
+     */
     name?: string;
+    /**
+     * - The symbol representing the currency.
+     */
     symbol?: string;
+    /**
+     * - The ISO 4217 code for the currency.
+     */
     code?: string;
 };
 /** @returns {LocationCountry} */
 declare function LocationCountry(): LocationCountry;
 type LocationCountry = {
+    /**
+     * - The capital of the country.
+     */
     capital?: string;
+    /**
+     * - The currency code used in the country.
+     */
     currency?: string;
+    /**
+     * - The ISO 3166-1 alpha-2 code for the country.
+     */
     iso2?: string;
+    /**
+     * - The ISO 3166-1 alpha-3 code for the country.
+     */
     iso3?: string;
+    /**
+     * - The name of the country.
+     */
     name?: string;
+    /**
+     * - The parent country if this is a subnational
+     * entity (e.g., a territory or region).
+     */
     parent?: string;
+    /**
+     * - The international dialing code for the country.
+     */
     phone_code?: string;
+    /**
+     * - The type of location, which is a country in this context.
+     */
     type?: string;
+    /**
+     * - A unique identifier for the country.
+     */
     uid?: number;
+    /**
+     * - Version key for tracking revisions.
+     */
     __v?: number;
+    /**
+     * - The unique identifier (24-digit Mongo Object ID)
+     * for the country.
+     */
     _id?: string;
     default_currency?: LocationDefaultCurrency;
     default_language?: LocationDefaultLanguage;
+    /**
+     * - The code representing the state or region
+     * within the country, if applicable.
+     */
     state_code?: string;
+    /**
+     * - The country code used for the country.
+     */
     country_code?: string;
+    /**
+     * - The latitude of the store's location.
+     */
     latitude?: string;
+    /**
+     * - The longitude of the store's location.
+     */
     longitude?: string;
 };
 /** @returns {Locations} */
 declare function Locations(): Locations;
 type Locations = {
+    /**
+     * - A list of country location details.
+     */
     items?: LocationCountry[];
 };