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

package/sdk/application/Configuration/ConfigurationApplicationModel.js

@@ -10,75 +10,76 @@ const Joi = require("joi");
  * @property {CompanyInfo} [company_info]
  * @property {OwnerInfo} [owner_info]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of application information
+ *   of application information.
  * @property {Domain} [domain]
  * @property {ApplicationWebsite} [website]
  * @property {ApplicationCors} [cors]
  * @property {string} [description] - It contains details information about the
- *   sales channel
- * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion
- * @property {ApplicationMeta[]} [meta]
+ *   sales channel.
+ * @property {string} [name] - Name of the sales channel, e.g. Zenz Fashion.
+ * @property {ApplicationMeta[]} [meta] - Metadata related to the application.
  * @property {string} [token] - Random generated fix length string for sales
  *   channel. It is required and auto-generated.
  * @property {string} [secret] - Random generated fix length string for sales
  *   channel. It is required and auto-generated.
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel
- *   information creation
+ *   information creation.
  * @property {SecureUrl} [banner]
  * @property {SecureUrl} [logo]
  * @property {boolean} [is_active] - Indicates whether sales channel is active
- *   or not active
- * @property {string} [mode]
- * @property {TokenSchema[]} [tokens]
- * @property {Domain[]} [domains]
+ *   or not active.
+ * @property {string} [mode] - Mode of the application.
+ * @property {TokenSchema[]} [tokens] - List of tokens associated with the application.
+ * @property {Domain[]} [domains] - List of domains associated with the application.
  * @property {SecureUrl} [favicon]
  * @property {SecureUrl} [mobile_logo]
- * @property {string} [slug]
+ * @property {string} [slug] - Slug identifier for the application.
  */
 
 /**
  * @typedef CompanyInfo
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of company information
- * @property {number} [uid] - Company UID
- * @property {string} [created_on] - ISO 8601 timestamp of company information creation
- * @property {boolean} [is_active] - Indicates company is active or not active
- * @property {string} [name] - Name of the company, Reliance Retail Limited
- * @property {CompanyAboutAddress[]} [addresses]
- * @property {string[]} [notification_emails]
+ *   of company information.
+ * @property {number} [uid] - Unique identifier for the company.
+ * @property {string} [created_on] - ISO 8601 timestamp of company information creation.
+ * @property {boolean} [is_active] - Indicates company is active or not active.
+ * @property {string} [name] - Name of the company, Reliance Retail Limited.
+ * @property {CompanyAboutAddress[]} [addresses] - List of addresses associated
+ *   with the company.
+ * @property {string[]} [notification_emails] - List of emails to notify.
  */
 
 /**
  * @typedef OwnerInfo
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of owner info
- * @property {UserEmail[]} [emails]
- * @property {UserPhoneNumber[]} [phone_numbers]
- * @property {string} [first_name] - First name of the owner
- * @property {string} [last_name] - Last name of the owner
- * @property {string} [profile_pic] - Hosted URL of profile pic
+ *   of owner info.
+ * @property {UserEmail[]} [emails] - List of email addresses of the owner.
+ * @property {UserPhoneNumber[]} [phone_numbers] - List of phone numbers of the owner.
+ * @property {string} [first_name] - First name of the owner.
+ * @property {string} [last_name] - Last name of the owner.
+ * @property {string} [profile_pic] - Hosted URL of profile pic.
  */
 
 /**
  * @typedef SupportedLanguage
- * @property {string} [name] - Name of the supported language, e.g. हिन्दी
- * @property {string} [code] - Unique code of supported language, e.g. hi-IN
+ * @property {string} [name] - Name of the supported language, e.g. हिन्दी.
+ * @property {string} [code] - Unique code of supported language, e.g. hi-IN.
  */
 
 /**
  * @typedef LanguageResponse
- * @property {SupportedLanguage[]} [items]
+ * @property {SupportedLanguage[]} [items] - List of supported languages.
  */
 
 /**
  * @typedef AppStaffResponse
- * @property {AppStaff[]} [staff_users]
+ * @property {AppStaff[]} [staff_users] - List of staff users.
  */
 
 /**
  * @typedef AppStaffListResponse
  * @property {Page} [page]
- * @property {AppStaff[]} [items]
+ * @property {AppStaff[]} [items] - List of staff users.
  */
 
 /**
@@ -93,31 +94,32 @@ const Joi = require("joi");
 
 /**
  * @typedef AppStaff
- * @property {string} [_id] - The unique identifier for the sales channel staff member
+ * @property {string} [_id] - The unique identifier for the sales channel staff member.
  * @property {boolean} [order_incent] - This is a boolean value. `true` to
  *   retrieve the staff members eligible for getting incentives on orders.
- * @property {number[]} [stores]
+ * @property {number[]} [stores] - List of IDs of the ordering stores where the
+ *   staff member works.
  * @property {string} [application] - The unique identifier (24-digit Mongo
- *   Object ID) of the current sales channel
- * @property {string} [title] - Tittle for the staff member like owner, staff.
+ *   Object ID) of the current sales channel.
+ * @property {string} [title] - Title for the staff member like owner, staff.
  * @property {string} [user] - Mongo ID of the staff. Helps in retrieving the
  *   details of a particular staff member.
  * @property {string} [employee_code] - Employee code of sales channel staff
  *   member. It has unique value.
- * @property {string} [first_name] - First name the staff member
- * @property {string} [last_name] - Last name the staff member
- * @property {string} [profile_pic_url] - Profile image hosted url of the staff member
+ * @property {string} [first_name] - First name the staff member.
+ * @property {string} [last_name] - Last name the staff member.
+ * @property {string} [profile_pic_url] - Profile image hosted url of the staff member.
  */
 
 /**
  * @typedef AppTokenResponse
  * @property {Tokens} [tokens]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the token
+ *   of the token.
  * @property {string} [application] - Alphanumeric ID allotted to the current
- *   application created within the current business account
- * @property {string} [created_at] - ISO 8601 timestamp of token creation
- * @property {string} [modified_at] - ISO 8601 timestamp of token updation
+ *   application created within the current business account.
+ * @property {string} [created_at] - ISO 8601 timestamp of token creation.
+ * @property {string} [modified_at] - ISO 8601 timestamp of token updation.
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
  */
 
@@ -137,7 +139,7 @@ const Joi = require("joi");
  * @typedef Firebase
  * @property {Credentials} [credentials]
  * @property {boolean} [enabled] - Shows whether Firebase integration is enabled
- *   or disabled for the sales channel
+ *   or disabled for the sales channel.
  */
 
 /**
@@ -150,7 +152,7 @@ const Joi = require("joi");
  *   Firebase. It is a unique numerical value which is created when you
  *   configure your project in the Google Developers Console/Google Cloud Console.
  * @property {string} [application_id] - Alphanumeric ID allotted to the current
- *   application created within the current business account
+ *   application created within the current business account.
  * @property {string} [api_key] - An API key is a unique string that's used to
  *   route requests to your Firebase project when interacting with Firebase.
  */
@@ -158,22 +160,22 @@ const Joi = require("joi");
 /**
  * @typedef Ios
  * @property {string} [application_id] - Alphanumeric ID allotted to a sales
- *   channel application created within a business account
- * @property {string} [api_key] - Firebase secret credential API key for IOS
+ *   channel application created within a business account.
+ * @property {string} [api_key] - Firebase secret credential API key for IOS.
  */
 
 /**
  * @typedef Android
  * @property {string} [application_id] - Alphanumeric ID allotted to a sales
- *   channel application created within a business account
- * @property {string} [api_key] - Firebase secret credential API key for Android
+ *   channel application created within a business account.
+ * @property {string} [api_key] - Firebase secret credential API key for Android.
  */
 
 /**
  * @typedef Moengage
  * @property {MoengageCredentials} [credentials]
- * @property {boolean} [enabled] - Shows whether MoEngage integation is enabled
- *   or disabled for the sales channel
+ * @property {boolean} [enabled] - Shows whether MoEngage integration is enabled
+ *   or disabled for the sales channel.
  */
 
 /**
@@ -187,7 +189,7 @@ const Joi = require("joi");
  * @typedef Segment
  * @property {SegmentCredentials} [credentials]
  * @property {boolean} [enabled] - Shows whether Segment integration is enabled
- *   or disabled for the sales channel
+ *   or disabled for the sales channel.
  */
 
 /**
@@ -201,35 +203,35 @@ const Joi = require("joi");
  * @typedef Gtm
  * @property {GtmCredentials} [credentials]
  * @property {boolean} [enabled] - Shows whether GTM integration is enabled or
- *   disabled for the sales channel
+ *   disabled for the sales channel.
  */
 
 /**
  * @typedef GtmCredentials
- * @property {string} [api_key] - Secret credential API key for GTM
+ * @property {string} [api_key] - Secret credential API key for GTM.
  */
 
 /**
  * @typedef Freshchat
  * @property {FreshchatCredentials} [credentials]
  * @property {boolean} [enabled] - Shows whether Freshchat integration is
- *   enabled or disabled for the sales channel
+ *   enabled or disabled for the sales channel.
  */
 
 /**
  * @typedef FreshchatCredentials
  * @property {string} [app_id] - The unique app_id of your Freshchat account for
- *   integrating Freshchat with your sales channel
+ *   integrating Freshchat with your sales channel.
  * @property {string} [app_key] - The unique app_key of your Freshchat account
- *   for integrating Freshchat with your sales channel
- * @property {string} [web_token] - Web token used for accessing the Freshchat APIs
+ *   for integrating Freshchat with your sales channel.
+ * @property {string} [web_token] - Web token used for accessing the Freshchat APIs.
  */
 
 /**
  * @typedef Safetynet
  * @property {SafetynetCredentials} [credentials]
  * @property {boolean} [enabled] - Shows whether Safetynet integration is
- *   enabled or disabled for the sales channel
+ *   enabled or disabled for the sales channel.
  */
 
 /**
@@ -267,14 +269,14 @@ const Joi = require("joi");
 
 /**
  * @typedef Credit
- * @property {boolean} [enabled] - Shows whether reward points should be credited
+ * @property {boolean} [enabled] - Shows whether reward points should be credited.
  */
 
 /**
  * @typedef Debit
- * @property {boolean} [enabled] - Shows whether reward points are available for debit
- * @property {boolean} [auto_apply] - Allow automatic debit of reward points
- * @property {string} [strategy_channel] - Strategy channel for debiting reward points
+ * @property {boolean} [enabled] - Shows whether reward points are available for debit.
+ * @property {boolean} [auto_apply] - Allow automatic debit of reward points.
+ * @property {string} [strategy_channel] - Strategy channel for debiting reward points.
  */
 
 /**
@@ -283,7 +285,7 @@ const Joi = require("joi");
  *   other products from same seller, other products in same category, other
  *   products in same price range, etc.
  * @property {boolean} [seller_selection] - Shows whether the customers can
- *   choose the seller on PDP
+ *   choose the seller on PDP.
  * @property {boolean} [update_product_meta] - Allow user to update product
  *   meta. Default value is true.
  * @property {boolean} [request_product] - Indicates whether customers can
@@ -292,7 +294,7 @@ const Joi = require("joi");
 
 /**
  * @typedef LaunchPage
- * @property {string} [page_type] - Type of the launch page
+ * @property {string} [page_type] - Type of the launch page.
  * @property {Object} [params] - Launch page params. It can be nullable.
  * @property {Object} [query] - Query related to launch page. It can be nullable.
  */
@@ -301,18 +303,18 @@ const Joi = require("joi");
  * @typedef LandingPageFeature
  * @property {LaunchPage} [launch_page]
  * @property {boolean} [continue_as_guest] - Shows whether a guest can checkout
- *   from cart without logging in
- * @property {string} [login_btn_text] - Shows the text displayed over the login button
+ *   from cart without logging in.
+ * @property {string} [login_btn_text] - Shows the text displayed over the login button.
  * @property {boolean} [show_domain_textbox] - Shows whether a textbox for
- *   entering domain is available
+ *   entering domain is available.
  * @property {boolean} [show_register_btn] - Shows whether register button is
- *   available in the login/landing page
+ *   available in the login/landing page.
  */
 
 /**
  * @typedef RegistrationPageFeature
  * @property {boolean} [ask_store_address] - Shows whether a form to collect the
- *   address of the store, should be displayed upon visiting the website
+ *   address of the store, should be displayed upon visiting the website.
  */
 
 /**
@@ -327,19 +329,19 @@ const Joi = require("joi");
  * @property {PcrFeature} [pcr]
  * @property {OrderFeature} [order]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for the sales channel features
- * @property {string} [app] - Application ID of the sales channel
+ *   for the sales channel features.
+ * @property {string} [app] - Application ID of the sales channel.
  * @property {string} [created_at] - ISO 8601 timestamp showing the date when
- *   the features were configured
+ *   the features were configured.
  * @property {string} [modified_at] - ISO 8601 timestamp of last known
- *   modifications to the sales channel feature configuration
- * @property {number} [__v] - Version key for tracking revisions. Default value is zero
+ *   modifications to the sales channel feature configuration.
+ * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
  */
 
 /**
  * @typedef HomePageFeature
  * @property {boolean} [order_processing] - Shows whether order processing is
- *   enabled or not enabled
+ *   enabled or not enabled.
  */
 
 /**
@@ -363,13 +365,13 @@ const Joi = require("joi");
 
 /**
  * @typedef CommunicationOptinDialogFeature
- * @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled
+ * @property {boolean} [visibility] - Shows whether WhatsApp communication is enabled.
  */
 
 /**
  * @typedef DeploymentStoreSelectionFeature
  * @property {boolean} [enabled] - Shows whether selection of store (for
- *   deploying the application) is permitted
+ *   deploying the application) is permitted.
  * @property {string} [type] - Permitted values are 'hard' and 'soft'. For hard
  *   type delivery, store selection is compulsory. For soft type, delivery store
  *   selection is optional.
@@ -386,16 +388,17 @@ const Joi = require("joi");
 
 /**
  * @typedef ListingPageFeature
- * @property {string} [sort_on]
+ * @property {string} [sort_on] - Determines the sorting criteria for product
+ *   listings on the page.
  */
 
 /**
  * @typedef CurrencyFeature
- * @property {string[]} [value] - 3-letter currency code
+ * @property {string[]} [value] - 3-letter currency code.
  * @property {string} [type] - If 'explicit', currency formatting shows currency
  *   code with price. For explicit or all currency selection.
  * @property {string} [default_currency] - 3-letter code of the default currency
- *   used in the application. Default vaule is 'INR'.
+ *   used in the application. Default value is 'INR'.
  */
 
 /**
@@ -405,24 +408,23 @@ const Joi = require("joi");
 
 /**
  * @typedef FeedbackFeature
- * @property {boolean} [enabled] - Shows whether customer feedback is enabled on
- *   PDP. Default value is false.
+ * @property {boolean} [enabled] - Whether customer feedback is enabled on PDP.
+ *   Default value is false.
  */
 
 /**
  * @typedef CompareProductsFeature
- * @property {boolean} [enabled] - Shows whether product comparison feature is
- *   enabled on PDP
+ * @property {boolean} [enabled] - Whether product comparison feature is enabled on PDP.
  */
 
 /**
  * @typedef CartFeature
- * @property {boolean} [gst_input] - Shows whether customer is allowed to enter
- *   GST on the cart page for claiming input credits
- * @property {boolean} [staff_selection] - Shows whether staff selection is
- *   enabled on cart page
- * @property {boolean} [placing_for_customer] - Shows whether the staff is
- *   placing order on behalf of customer. Default value is true.
+ * @property {boolean} [gst_input] - Whether customer is allowed to enter GST on
+ *   the cart page for claiming input credits.
+ * @property {boolean} [staff_selection] - Whether staff selection is enabled on
+ *   cart page.
+ * @property {boolean} [placing_for_customer] - Whether the staff is placing
+ *   order on behalf of customer. Default value is true.
  * @property {boolean} [google_map] - Allow adding of Google Maps. Default value is true.
  * @property {boolean} [revenue_engine_coupon] - Allow coupon apply and credits,
  *   together. Default value is false.
@@ -430,12 +432,12 @@ const Joi = require("joi");
 
 /**
  * @typedef QrFeature
- * @property {boolean} [application] - Shows whether sharing of mobile app via
- *   QR code is allowed. Default value is false.
- * @property {boolean} [products] - Shows whether sharing product via QR code is
+ * @property {boolean} [application] - Whether sharing of mobile app via QR code
+ *   is allowed. Default value is false.
+ * @property {boolean} [products] - Whether sharing product via QR code is
+ *   allowed. Default value is false.
+ * @property {boolean} [collections] - Whether sharing collection via QR code is
  *   allowed. Default value is false.
- * @property {boolean} [collections] - Shows whether sharing collection via QR
- *   code is allowed. Default value is false.
  */
 
 /**
@@ -457,21 +459,21 @@ const Joi = require("joi");
 /**
  * @typedef Currency
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the current sales channel supported currency
+ *   of the current sales channel supported currency.
  * @property {boolean} [is_active] - Shows currency is enabled or not in current
- *   sales channel
- * @property {string} [name] - Name of the currency, e.g Indian Rupee
+ *   sales channel.
+ * @property {string} [name] - Name of the currency, e.g Indian Rupee.
  * @property {string} [code] - 3-character currency code, e.g. INR, USD, EUR.
  * @property {string} [created_at] - ISO 8601 timestamp of sales channel support
- *   currency creation
+ *   currency creation.
  * @property {string} [modified_at] - ISO 8601 timestamp of sales channel
- *   support currency updation
+ *   support currency updation.
  * @property {number} [decimal_digits] - Acceptable decimal limits for a given
  *   currency, e.g. 1.05$ means upto 2 decimal digits can be accepted as a valid
  *   value of a currency.
- * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹
- * @property {string} [country_name]
- * @property {string} [country_code]
+ * @property {string} [symbol] - Unique symbol for identifying the currency, e.g. ₹.
+ * @property {string} [country_name] - Country name.
+ * @property {string} [country_code] - Country code.
  */
 
 /**
@@ -480,23 +482,23 @@ const Joi = require("joi");
  *   should propagate correctly.
  * @property {boolean} [is_primary] - 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} [is_shortlink] - Shortlink is present or not for the domain.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel domain
- * @property {string} [name]
+ *   of the sales channel domain.
+ * @property {string} [name] - Domain name.
  * @property {boolean} [is_predefined] - 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
+ *   enabled or not.
+ * @property {string} [basepath] - Base path for the current sales channel website.
  */
 
 /**
  * @typedef ApplicationCors
- * @property {string[]} [domains]
+ * @property {string[]} [domains] - List of domains added to the sales channel.
  */
 
 /**
@@ -506,7 +508,7 @@ const Joi = require("joi");
 
 /**
  * @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
@@ -516,13 +518,13 @@ const Joi = require("joi");
 
 /**
  * @typedef ApplicationMeta
- * @property {string} [name] - Indicates to name of application meta
- * @property {string} [value] - Value related to application meta name
+ * @property {string} [name] - Indicates to 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.
  */
 
 /**
@@ -533,108 +535,109 @@ const Joi = require("joi");
  * @property {string} [description] - It contains 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
+ *   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
+ *   of seconds until the key expires.
  * @property {boolean} [is_internal] - Indicates whether a sales channel is
- *   internal or not
- * @property {boolean} [is_active] - Indicates sales channel is active or not active
+ *   internal or not.
+ * @property {boolean} [is_active] - Indicates sales channel is active or not active.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the sales channel
- * @property {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] - Random generated fix length string for sales
  *   channel. It is required and auto-generated.
- * @property {ApplicationRedirections[]} [redirections]
- * @property {ApplicationMeta[]} [meta]
- * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation
- * @property {string} [modified_at] - ISO 8601 timestamp of sales channel updation
+ * @property {ApplicationRedirections[]} [redirections] - List of redirections
+ *   for the sales channel.
+ * @property {ApplicationMeta[]} [meta] - List of meta information for the sales channel.
+ * @property {string} [created_at] - ISO 8601 timestamp of sales channel creation.
+ * @property {string} [modified_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 application is live or in development mode.
  * @property {SecureUrl} [mobile_logo]
  * @property {Domain} [domain]
- * @property {string} [slug]
- * @property {string} [mode]
- * @property {string} [status]
- * @property {TokenSchema[]} [tokens]
+ * @property {string} [slug] - Slug identifier.
+ * @property {string} [mode] - Application mode.
+ * @property {string} [status] - Current status of the application.
+ * @property {TokenSchema[]} [tokens] - List of tokens associated with the sales channel.
  */
 
 /**
  * @typedef TokenSchema
- * @property {string} [token]
- * @property {Object} [created_by]
- * @property {string} [created_at] - ISO 8601 timestamp of when token created
+ * @property {string} [token] - Token string.
+ * @property {Object} [created_by] - User details.
+ * @property {string} [created_at] - ISO 8601 timestamp of when token created.
  */
 
 /**
  * @typedef NotFound
- * @property {string} [message] - Response message for not found
+ * @property {string} [message] - Response message for not found.
  */
 
 /**
  * @typedef InvalidPayloadRequest
- * @property {string} [message] - Error message when request body payload is improper
+ * @property {string} [message] - Error message when request body payload is improper.
  */
 
 /**
  * @typedef UnhandledError
- * @property {string} [message]
+ * @property {string} [message] - Error message for unhandled errors.
  */
 
 /**
  * @typedef SuccessMessageResponse
- * @property {string} [message] - Success message shown to the user (in a string format)
+ * @property {string} [message] - Success message shown to the user (in a string format).
  */
 
 /**
  * @typedef CompanyAboutAddress
- * @property {number} [pincode] - 6-digit PIN code of the city, e.g. 400001
- * @property {string} [address1] - Primary address line of the company
- * @property {string} [address2] - Secondary address line of the company
- * @property {string} [city] - City name, e.g. Mumbai
- * @property {string} [state] - State name, e.g. Maharashtra
- * @property {string} [country] - Country name, e.g. India
+ * @property {number} [pincode] - 6-digit PIN code of the city, e.g. 400001.
+ * @property {string} [address1] - Primary address line of the company.
+ * @property {string} [address2] - Secondary address line of the company.
+ * @property {string} [city] - City name, e.g. Mumbai.
+ * @property {string} [state] - State name, e.g. Maharashtra.
+ * @property {string} [country] - Country name, e.g. India.
  * @property {string} [address_type] - Indicates different office types like
  *   office, registered, and home.
  */
 
 /**
  * @typedef UserEmail
- * @property {boolean} [active] - Current email is active or not active
- * @property {boolean} [primary] - Indicates current email is primay email or
- *   not primary email of user
+ * @property {boolean} [active] - Current email is active or not active.
+ * @property {boolean} [primary] - Indicates current email id primary email or
+ *   not primary email of user.
  * @property {boolean} [verified] - Indicates current email is verified email or
- *   not verified email
- * @property {string} [email] - Email address of the user
+ *   not verified email.
+ * @property {string} [email] - Email address of the user.
  */
 
 /**
  * @typedef UserPhoneNumber
- * @property {boolean} [active] - Current phone number is active or not active
- * @property {boolean} [primary] - Indicates current phone number is primay or
- *   not primary of user
+ * @property {boolean} [active] - Current phone number is active or not active.
+ * @property {boolean} [primary] - Indicates current phone number is primary or
+ *   not for a user.
  * @property {boolean} [verified] - Indicates current phone number is verified
- *   or not verified
- * @property {number} [country_code] - Country code, e.g. +91
- * @property {string} [phone] - Phone number of the user
+ *   or not verified.
+ * @property {number} [country_code] - Country code, e.g. +91.
+ * @property {string} [phone] - Phone number of the user.
  */
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**
@@ -642,61 +645,64 @@ const Joi = require("joi");
  * @property {InformationAddress} [address]
  * @property {InformationSupport} [support]
  * @property {SocialLinks} [social_links]
- * @property {Links[]} [links]
+ * @property {Links[]} [links] - Array of additional relevant web links related
+ *   to the application.
  * @property {string} [copyright_text] - Copyright statement usually seen at the
- *   site's footer
+ *   site's footer.
  * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
- *   the application information
- * @property {BusinessHighlights[]} [business_highlights]
+ *   the application information.
+ * @property {BusinessHighlights[]} [business_highlights] - Array of notable
+ *   business highlights with icons and descriptions.
  * @property {string} [application] - Alphanumeric ID allotted to a sales
- *   channel application created within a business account
+ *   channel application created within a business account.
  * @property {string} [created_at] - ISO 8601 timestamp of creation of the
- *   application information
+ *   application information.
  * @property {string} [modified_at] - ISO 8601 timestamp of updation of the
- *   application information
+ *   application information.
  * @property {number} [__v] - Version key for tracking revisions. Default value is zero.
  */
 
 /**
  * @typedef InformationAddress
  * @property {InformationLoc} [loc]
- * @property {string[]} [address_line] - Contact address of the sales channel
- * @property {InformationPhone[]} [phone]
- * @property {string} [city] - Name of the city, e.g. Mumbai
- * @property {string} [country] - Name of the country, e.g. India
- * @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001
+ * @property {string[]} [address_line] - Contact address of the sales channel.
+ * @property {InformationPhone[]} [phone] - Phone numbers with country codes.
+ * @property {string} [city] - Name of the city, e.g. Mumbai.
+ * @property {string} [country] - Name of the country, e.g. India.
+ * @property {number} [pincode] - 6-digit PIN Code of the city, e.g. 400001.
  */
 
 /**
  * @typedef InformationPhone
- * @property {string} [code] - Country code for contact number, e.g. +91 (for India)
- * @property {string} [number] - 10-digit mobile number
+ * @property {string} [code] - Country code for contact number, e.g. +91 (for India).
+ * @property {string} [number] - 10-digit mobile number.
  */
 
 /**
  * @typedef InformationSupportPhone
- * @property {string} [code] - Country code for contact number, e.g. +91 (for India)
- * @property {string} [number] - 10-digit mobile number
- * @property {string} [key]
+ * @property {string} [code] - Country code for contact number, e.g. +91 (for India).
+ * @property {string} [number] - 10-digit mobile number.
+ * @property {string} [key] - Additional identifier or key for the contact number.
  */
 
 /**
  * @typedef InformationSupportEmail
  * @property {string} [value] - Value of email.
- * @property {string} [key]
+ * @property {string} [key] - Additional identifier or key for the email address.
  */
 
 /**
  * @typedef InformationLoc
- * @property {string} [type] - Country code for contact number, e.g. +91 (for India)
- * @property {number[]} [coordinates] - 10-digit mobile number
+ * @property {string} [type] - Country code for contact number, e.g. +91 (for India).
+ * @property {number[]} [coordinates] - 10-digit mobile number.
  */
 
 /**
  * @typedef InformationSupport
- * @property {InformationSupportPhone[]} [phone]
- * @property {InformationSupportEmail[]} [email]
- * @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM
+ * @property {InformationSupportPhone[]} [phone] - An array of phone contact
+ *   details, including country code and number.
+ * @property {InformationSupportEmail[]} [email] - An array of email contact details.
+ * @property {string} [timing] - Working hours of support team, e.g. 9 AM to 9 PM.
  */
 
 /**
@@ -714,81 +720,81 @@ const Joi = require("joi");
 
 /**
  * @typedef FacebookLink
- * @property {string} [title] - Name of the social media platform, e.g. Facebook
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Facebook page
+ * @property {string} [title] - Name of the social media platform, e.g. Facebook.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Facebook page.
  */
 
 /**
  * @typedef InstagramLink
- * @property {string} [title] - Name of the social media platform, e.g. Instagram
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Instagram page
+ * @property {string} [title] - Name of the social media platform, e.g. Instagram.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Instagram page.
  */
 
 /**
  * @typedef TwitterLink
- * @property {string} [title] - Name of the social media platform, e.g. Twitter
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Twitter account
+ * @property {string} [title] - Name of the social media platform, e.g. Twitter.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Twitter account.
  */
 
 /**
  * @typedef PinterestLink
- * @property {string} [title] - Name of the social media platform, e.g. Pinterest
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Pinterest page
+ * @property {string} [title] - Name of the social media platform, e.g. Pinterest.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Pinterest page.
  */
 
 /**
  * @typedef GooglePlusLink
- * @property {string} [title] - Name of the social media platform, e.g. Google+
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Google+ account
+ * @property {string} [title] - Name of the social media platform, e.g. Google+.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Google+ account.
  */
 
 /**
  * @typedef YoutubeLink
- * @property {string} [title] - Name of the social media platform, e.g. YouTube
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's YouTube channel
+ * @property {string} [title] - Name of the social media platform, e.g. YouTube.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's YouTube channel.
  */
 
 /**
  * @typedef LinkedInLink
- * @property {string} [title] - Name of the social media platform, e.g. LinkedIn
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's LinkedIn channel
+ * @property {string} [title] - Name of the social media platform, e.g. LinkedIn.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's LinkedIn channel.
  */
 
 /**
  * @typedef VimeoLink
- * @property {string} [title] - Name of the video hosting platform, e.g. Vimeo
- * @property {string} [icon] - Hosted URL of social icon image shown on the website
- * @property {string} [link] - Web URL of brand's Vimeo channel
+ * @property {string} [title] - Name of the video hosting platform, e.g. Vimeo.
+ * @property {string} [icon] - Hosted URL of social icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's Vimeo channel.
  */
 
 /**
  * @typedef BlogLink
- * @property {string} [title] - Name of the brand's blog page
- * @property {string} [icon] - Hosted URL of icon image shown on the website
- * @property {string} [link] - Web URL of brand's blog page
+ * @property {string} [title] - Name of the brand's blog page.
+ * @property {string} [icon] - Hosted URL of icon image shown on the website.
+ * @property {string} [link] - Web URL of brand's blog page.
  */
 
 /**
  * @typedef Links
- * @property {string} [title] - Name of the related page or link
- * @property {string} [link] - Web URL for redirecting to a related page
+ * @property {string} [title] - Name of the related page or link.
+ * @property {string} [link] - Web URL for redirecting to a related page.
  */
 
 /**
  * @typedef BusinessHighlights
  * @property {string} [_id] - Unique identifier (24-digit Mongo Object ID) of
- *   the related business
- * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery
+ *   the related business.
+ * @property {string} [title] - Title of the business highlight, e.g. Superfast Delivery.
  * @property {string} [icon] - Hosted URL of icon image representing the
- *   business highlight
- * @property {string} [sub_title] - Detailed information about the highlight
+ *   business highlight.
+ * @property {string} [sub_title] - Detailed information about the highlight.
  */
 
 /**
@@ -801,82 +807,87 @@ const Joi = require("joi");
  * @property {SecureUrl} [favicon]
  * @property {SecureUrl} [banner]
  * @property {Domain} [domain]
- * @property {Domain[]} [domains]
+ * @property {Domain[]} [domains] - List of domains associated with the sales channel.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   for the sales channel details
- * @property {string} [slug]
- * @property {number} [company_id]
+ *   for the sales channel details.
+ * @property {string} [slug] - URL-friendly version of the sales channel name.
+ * @property {number} [company_id] - Numeric ID allotted to the business account
+ *   where the sales channel is mapped.
  */
 
 /**
  * @typedef CurrenciesResponse
- * @property {Currency[]} [items]
+ * @property {Currency[]} [items] - A list of currency objects. Each object
+ *   represents a different currency.
  */
 
 /**
  * @typedef DefaultCurrency
  * @property {string} [ref] - The unique identifier (24-digit Mongo Object ID)
- *   of the default currency
+ *   of the default currency.
  * @property {string} [code] - 3-character code of the default currency, e.g.
- *   INR, EUR, USD
+ *   INR, EUR, USD.
  */
 
 /**
  * @typedef AppCurrencyResponse
  * @property {string} [application] - Alphanumeric ID allotted to an application
- *   (sales channel website) created within a business account
+ *   (sales channel website) created within a business account.
  * @property {DefaultCurrency} [default_currency]
- * @property {Currency[]} [supported_currency]
- * @property {string} [_id]
- * @property {string} [created_at]
- * @property {string} [modified_at]
+ * @property {Currency[]} [supported_currency] - A list of currencies supported
+ *   by the application.
+ * @property {string} [_id] - The unique identifier of the application.
+ * @property {string} [created_at] - ISO 8601 timestamp of when the application
+ *   was created.
+ * @property {string} [modified_at] - ISO 8601 timestamp of when the application
+ *   was last modified.
  */
 
 /**
  * @typedef StoreLatLong
- * @property {string} [type] - Coordinates type of the opted store
- * @property {number[]} [coordinates]
+ * @property {string} [type] - Coordinates type of the opted store.
+ * @property {number[]} [coordinates] - Latitude and Longitude coordinates of the store.
  */
 
 /**
  * @typedef OptedStoreAddress
- * @property {string} [state] - State of the opted store, e.g. Maharashtra
- * @property {string} [address1] - Address of the opted store
+ * @property {string} [state] - State of the opted store, e.g. Maharashtra.
+ * @property {string} [address1] - Address of the opted store.
  * @property {StoreLatLong} [lat_long]
- * @property {string} [address2] - Address of the opted store
- * @property {number} [pincode] - 6-digit PIN code of the opted store location
- * @property {string} [country] - Country of the opted store, e.g. India
- * @property {string} [city] - City of the opted store, e.g. Mumbai
+ * @property {string} [address2] - Address of the opted store.
+ * @property {number} [pincode] - 6-digit PIN code of the opted store location.
+ * @property {string} [country] - Country of the opted store, e.g. India.
+ * @property {string} [city] - City of the opted store, e.g. Mumbai.
  */
 
 /**
  * @typedef OrderingStore
  * @property {OptedStoreAddress} [address]
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the ordering store
- * @property {number} [uid] - Ordering store UID
- * @property {string} [name] - Store name of the ordering store
- * @property {string} [display_name] - Display name of the ordering store
+ *   of the ordering store.
+ * @property {number} [uid] - Ordering store UID.
+ * @property {string} [name] - Store name of the ordering store.
+ * @property {string} [display_name] - Display name of the ordering store.
  * @property {string} [store_type] - Store type of the ordering store, e.g.
- *   high_street, mall, warehouse
- * @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102
- * @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001
- * @property {string} [code] - Code of the ordering store (usually same as Store Code)
+ *   high_street, mall, warehouse.
+ * @property {string} [store_code] - Store code of the ordering store, e.g. MUM-102.
+ * @property {number} [pincode] - 6-digit PIN Code of the ordering store, e.g. 400001.
+ * @property {string} [code] - Code of the ordering store (usually same as Store Code).
  */
 
 /**
  * @typedef OrderingStores
  * @property {Page} [page]
- * @property {OrderingStore[]} [items]
- * @property {number[]} [deployed_stores]
- * @property {boolean} [all_stores] - Allow all stores of the ordering stores
- * @property {boolean} [enabled] - Allow ordering stores for current sales channel
+ * @property {OrderingStore[]} [items] - List of ordering stores.
+ * @property {number[]} [deployed_stores] - List of all deployed stores.
+ * @property {boolean} [all_stores] - Allow all stores of the ordering stores.
+ * @property {boolean} [enabled] - Allow ordering stores for current sales channel.
  * @property {string} [type] - For hard type delivery, store selection is
  *   compulsory. For soft type, delivery store selection is optional.
  * @property {string} [_id] - The unique identifier (24-digit Mongo Object ID)
- *   of the ordering store
+ *   of the ordering store.
  * @property {string} [app] - Alphanumeric ID allotted to an application (sales
- *   channel website) created within a business account
+ *   channel website) created within a business account.
  * @property {number} [__v] - Version key for tracking ordering stores. Default
  *   value is zero.
  */