npm - @gofynd/fdk-client-javascript - Versions diffs - 3.3.3 → 3.3.6 - Mend

@gofynd/fdk-client-javascript 3.3.3 → 3.3.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (158) hide show

package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js CHANGED Viewed

@@ -22,7 +22,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.Domain>} - Success response
    * @name addDomain
    * @summary: Create domain
-   * @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/addDomain/).
+   * @description: Creates a domain for an sales channel. Note - Only 15 domains can be added to the sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/addDomain/).
    */
   async addDomain(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -104,7 +104,7 @@ class Configuration {
    *   Success response
    * @name changeDomainType
    * @summary: Update domain
-   * @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/changeDomainType/).
+   * @description: Modify the type of a specific domain. Primary domain is used as the URL of your website. Short link domain is comparatively smaller and used while generating short links. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/changeDomainType/).
    */
   async changeDomainType(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -186,7 +186,7 @@ class Configuration {
    *   Success response
    * @name getAppApiTokens
    * @summary: Get sales channel API tokens
-   * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppApiTokens/).
+   * @description: Retrieve the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google, and Facebook auth. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppApiTokens/).
    */
   async getAppApiTokens(
     { requestHeaders } = { requestHeaders: {} },
@@ -263,7 +263,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
    * @name getAppBasicDetails
    * @summary: Get sales channel
-   * @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppBasicDetails/).
+   * @description: Shows basic sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppBasicDetails/).
    */
   async getAppBasicDetails(
     { requestHeaders } = { requestHeaders: {} },
@@ -341,7 +341,7 @@ class Configuration {
    *   Success response
    * @name getAppCompanies
    * @summary: List sales channel companies
-   * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCompanies/).
+   * @description: Retrieve info of all the companies (e.g. name, uid, and company type) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppCompanies/).
    */
   async getAppCompanies(
     { uid, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -430,7 +430,7 @@ class Configuration {
    *   Success response
    * @name getAppContactInfo
    * @summary: Get sales channel contact
-   * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppContactInfo/).
+   * @description: Fetch data such as social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppContactInfo/).
    */
   async getAppContactInfo(
     { requestHeaders } = { requestHeaders: {} },
@@ -508,7 +508,7 @@ class Configuration {
    *   Success response
    * @name getAppCurrencyConfig
    * @summary: Get sales channel currency configuration
-   * @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppCurrencyConfig/).
+   * @description: Retrieve a list of currencies supported in the current sales channel. Moreover, get the cuurency that is set as the default one in the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppCurrencyConfig/).
    */
   async getAppCurrencyConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -587,7 +587,7 @@ class Configuration {
    *
    * @name getAppFeatures
    * @summary: Get sales channel
-   * @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppFeatures/).
+   * @description: Shows feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppFeatures/).
    */
   async getAppFeatures(
     { requestHeaders } = { requestHeaders: {} },
@@ -665,7 +665,7 @@ class Configuration {
    *   Success response
    * @name getAppStores
    * @summary: list sales channel stores
-   * @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppStores/).
+   * @description: Retrieve information of all the companies (e.g. uid, name, display name, store type, store code and company id) whose inventory is fetched into the current sales channel sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppStores/).
    */
   async getAppStores(
     { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -752,7 +752,7 @@ class Configuration {
    *
    * @name getAppSupportedCurrency
    * @summary: List supported currencies
-   * @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAppSupportedCurrency/).
+   * @description: Retrieve a list of supported currencies for the sales channel. A list of currencies allowed in the current sales channel. Moreover, get the name, code, symbol, and the decimal digits of the currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getAppSupportedCurrency/).
    */
   async getAppSupportedCurrency(
     { requestHeaders } = { requestHeaders: {} },
@@ -829,7 +829,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.ApplicationById>} - Success response
    * @name getApplicationById
    * @summary: Get sales channel by id
-   * @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplicationById/).
+   * @description: Retrieve detailed information about a specific sales channel. Use sales channel ID to get the current sales channel details which includes channel name, description, banner, logo, favicon, domain details, token, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getApplicationById/).
    */
   async getApplicationById(
     { requestHeaders } = { requestHeaders: {} },
@@ -907,7 +907,7 @@ class Configuration {
    *   Success response
    * @name getBuildConfig
    * @summary: Get Build Configuration
-   * @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBuildConfig/).
+   * @description: Retrieve latest build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getBuildConfig/).
    */
   async getBuildConfig(
     { platformType, requestHeaders } = { requestHeaders: {} },
@@ -990,7 +990,7 @@ class Configuration {
    *
    * @name getDomainStatus
    * @summary: Get domain status
-   * @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainStatus/).
+   * @description: Retrieve the status of a specific domain. Shows if the A records and TXT records of the domain correctly points to appropriate IP on Fynd Servers. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomainStatus/).
    */
   async getDomainStatus(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1070,7 +1070,7 @@ class Configuration {
    *   Success response
    * @name getDomains
    * @summary: List domains
-   * @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomains/).
+   * @description: Retrieve a list of existing domains by its sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomains/).
    */
   async getDomains(
     { requestHeaders } = { requestHeaders: {} },
@@ -1148,7 +1148,7 @@ class Configuration {
    *   Success response
    * @name getInventoryConfig
    * @summary: Get inventory configuration
-   * @description: Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getInventoryConfig/).
+   * @description: Retrieve configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getInventoryConfig/).
    */
   async getInventoryConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -1226,7 +1226,7 @@ class Configuration {
    *   Success response
    * @name getOrderingStoreConfig
    * @summary: Get ordering store configuration
-   * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreConfig/).
+   * @description: Retrieve configuration settings for ordering stores. Retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoreConfig/).
    */
   async getOrderingStoreConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -1305,7 +1305,7 @@ class Configuration {
    *
    * @name getOrderingStoreCookie
    * @summary: Get ordering store signed cookie
-   * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoreCookie/).
+   * @description: Use this API to get an Ordering Store signed cookie upon selecting an ordering store. This will be used by the cart service to verify a coupon against the selected ordering store in cart. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoreCookie/).
    */
   async getOrderingStoreCookie(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1386,7 +1386,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.OrderingStores>} - Success response
    * @name getOrderingStoresByFilter
    * @summary: List ordering stores
-   * @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOrderingStoresByFilter/).
+   * @description: Retrieve ordering stores based on specified filters. Use filters and retrieve the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOrderingStoresByFilter/).
    */
   async getOrderingStoresByFilter(
     { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -1474,7 +1474,7 @@ class Configuration {
    *   Success response
    * @name getPreviousVersions
    * @summary: Get previous versions
-   * @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getPreviousVersions/).
+   * @description: Retrieve version details of the app, this includes the build status, build date, version name, latest version, and a lot more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getPreviousVersions/).
    */
   async getPreviousVersions(
     { platformType, requestHeaders } = { requestHeaders: {} },
@@ -1557,7 +1557,7 @@ class Configuration {
    *
    * @name getStaffOrderingStores
    * @summary: Get staff ordering stores
-   * @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStaffOrderingStores/).
+   * @description: Retrieve ordering stores accessible to staff members. Retrieve the details of all stores access given to the staff member (the selling locations where the sales channel will be utilized for placing orders). - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStaffOrderingStores/).
    */
   async getStaffOrderingStores(
     { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -1645,7 +1645,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
    * @name modifyAppFeatures
    * @summary: update sales channel features
-   * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/modifyAppFeatures/).
+   * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/modifyAppFeatures/).
    */
   async modifyAppFeatures(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1727,7 +1727,7 @@ class Configuration {
    *   Success response
    * @name partiallyUpdateInventoryConfig
    * @summary: Partially update inventory configuration
-   * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
+   * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/partiallyUpdateInventoryConfig/).
    */
   async partiallyUpdateInventoryConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -1810,7 +1810,7 @@ class Configuration {
    *
    * @name removeDomainById
    * @summary: Remove domain
-   * @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeDomainById/).
+   * @description: Delete a specific domain from the sales channel. Delete a domain (secondary or shortlink domain) added to a sales channel. It will disable user's access to website, shared links, and other features associated with this domain. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/removeDomainById/).
    */
   async removeDomainById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -1893,7 +1893,7 @@ class Configuration {
    *
    * @name removeOrderingStoreCookie
    * @summary: Delete Ordering Store signed cookie
-   * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/removeOrderingStoreCookie/).
+   * @description: Use this API to unset the Ordering Store cookie upon changing the sales channel, by its domain URL, in the Universal Fynd Store app. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/removeOrderingStoreCookie/).
    */
   async removeOrderingStoreCookie(
     { requestHeaders } = { requestHeaders: {} },
@@ -1971,7 +1971,7 @@ class Configuration {
    *   Success response
    * @name updateAppApiTokens
    * @summary: Update sales channel API tokens
-   * @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppApiTokens/).
+   * @description: Add and edit the tokens used for integrating Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, Google and Facebook auth. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppApiTokens/).
    */
   async updateAppApiTokens(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2052,7 +2052,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.ApplicationDetail>} - Success response
    * @name updateAppBasicDetails
    * @summary: Update sales channel basic details
-   * @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppBasicDetails/).
+   * @description: Modify sales channel details like name, description, logo, domain, company ID, and other related information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppBasicDetails/).
    */
   async updateAppBasicDetails(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2134,7 +2134,7 @@ class Configuration {
    *   Success response
    * @name updateAppContactInfo
    * @summary: Update sales channel contact
-   * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppContactInfo/).
+   * @description: Modify the social links, copyright text, business highlights, address and contact information of the company/seller/brand operating the sales channel. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppContactInfo/).
    */
   async updateAppContactInfo(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2216,7 +2216,7 @@ class Configuration {
    *   Success response
    * @name updateAppCurrencyConfig
    * @summary: Update sales channel currency configuration
-   * @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppCurrencyConfig/).
+   * @description: Modify currency configuration settings for the sales channel. Add and edit the currencies supported in the sales channel. Initially, INR will be enabled by default. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppCurrencyConfig/).
    */
   async updateAppCurrencyConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2297,7 +2297,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.AppFeature>} - Success response
    * @name updateAppFeatures
    * @summary: Update sales channel
-   * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateAppFeatures/).
+   * @description: Modify the feature configuration of sales channel websites, such as product detail, landing page, options in the login/registration screen, home page, listing page, reward points, communication opt-in, cart options and many more. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateAppFeatures/).
    */
   async updateAppFeatures(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2379,7 +2379,7 @@ class Configuration {
    *   Success response
    * @name updateBuildConfig
    * @summary: Update build configuration
-   * @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateBuildConfig/).
+   * @description: Modify the existing build configuration, such as app name, landing page image, splash image used in a mobile build. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateBuildConfig/).
    */
   async updateBuildConfig(
     { platformType, body, requestHeaders } = { requestHeaders: {} },
@@ -2463,7 +2463,7 @@ class Configuration {
    *   Success response
    * @name updateInventoryConfig
    * @summary: Update inventory configuration
-   * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateInventoryConfig/).
+   * @description: Modify the configuration details of authentication, inventory, article assignment rules, reward points, cart, payment, order, logistics, etc. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateInventoryConfig/).
    */
   async updateInventoryConfig(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -2544,7 +2544,7 @@ class Configuration {
    * @returns {Promise<ConfigurationPlatformModel.DeploymentMeta>} - Success response
    * @name updateOrderingStoreConfig
    * @summary: Update ordering store configuration
-   * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateOrderingStoreConfig/).
+   * @description: Modify configuration settings for ordering stores. Edit the details of the deployment stores (the selling locations where the sales channel will be utilised for placing orders) - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/updateOrderingStoreConfig/).
    */
   async updateOrderingStoreConfig(
     { body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts CHANGED Viewed

@@ -10,7 +10,7 @@ declare class Configuration {
      *   Success response
      * @name createApplication
      * @summary: Create sales channel
-     * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
+     * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/createApplication/).
      */
     createApplication({ body, requestHeaders }?: ConfigurationPlatformValidator.CreateApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CreateAppResponseSchema>;
     /**
@@ -22,7 +22,7 @@ declare class Configuration {
      *
      * @name getApplications
      * @summary: List sales channel stores
-     * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
+     * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getApplications/).
      */
     getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponseSchema>;
     /**
@@ -46,7 +46,7 @@ declare class Configuration {
      *
      * @name getBrandsByCompany
      * @summary: List brands by company
-     * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
+     * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getBrandsByCompany/).
      */
     getBrandsByCompany({ q, requestHeaders }?: ConfigurationPlatformValidator.GetBrandsByCompanyParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BrandsByCompanyResponseSchema>;
     /**
@@ -58,7 +58,7 @@ declare class Configuration {
      *
      * @name getCompanyByBrands
      * @summary: List companies by brand
-     * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
+     * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCompanyByBrands/).
      */
     getCompanyByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetCompanyByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompanyByBrandsResponseSchema>;
     /**
@@ -70,7 +70,7 @@ declare class Configuration {
      *
      * @name getCurrencies
      * @summary: List currencies
-     * @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
+     * @description: Retrieve a list of available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencies/).
      */
     getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CurrenciesResponseSchema>;
     /**
@@ -84,7 +84,7 @@ declare class Configuration {
      *
      * @name getCurrencyExchangeRates
      * @summary: Get currency exchange rates
-     * @description: Retrieve a list of currency exchange rates, relative to a provided currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencyExchangeRates/).
+     * @description: Retrieve a list of currency exchange rates, relative to a provided currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencyExchangeRates/).
      */
     getCurrencyExchangeRates({ currencyCode, exchangeCurrencyCode, exchangeCountryCode, requestHeaders, }?: ConfigurationPlatformValidator.GetCurrencyExchangeRatesParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CurrencyExchangeResponseV2>;
     /**
@@ -96,7 +96,7 @@ declare class Configuration {
      *
      * @name getDomainAvailibility
      * @summary: List suggestion domain
-     * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
+     * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomainAvailibility/).
      */
     getDomainAvailibility({ body, requestHeaders }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainSuggestionsResponseSchema>;
     /**
@@ -110,7 +110,7 @@ declare class Configuration {
      *
      * @name getOtherSellerApplicationById
      * @summary: Get others sales. channel
-     * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
+     * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplicationById/).
      */
     getOtherSellerApplicationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedApplicationResponseSchema>;
     /**
@@ -123,7 +123,7 @@ declare class Configuration {
      *   Success response
      * @name getOtherSellerApplications
      * @summary: Get other sales channel
-     * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
+     * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplications/).
      */
     getOtherSellerApplications({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
     /**
@@ -135,7 +135,7 @@ declare class Configuration {
      *
      * @name getStoreByBrands
      * @summary: Get store by brands
-     * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
+     * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStoreByBrands/).
      */
     getStoreByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetStoreByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoreByBrandsResponseSchema>;
     /**
@@ -147,7 +147,7 @@ declare class Configuration {
      *
      * @name optOutFromApplication
      * @summary: opt out of marketplaces
-     * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
+     * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/optOutFromApplication/).
      */
     optOutFromApplication({ id, body, requestHeaders }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponseSchema>;
 }

package/sdk/platform/Configuration/ConfigurationPlatformClient.js CHANGED Viewed

@@ -22,7 +22,7 @@ class Configuration {
    *   Success response
    * @name createApplication
    * @summary: Create sales channel
-   * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
+   * @description: Generate and add a new sales channel. sales channels are sales channel websites which can be configured, personalized and customized. Use this API to create a new sales channel in the current company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/createApplication/).
    */
   async createApplication(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -105,7 +105,7 @@ class Configuration {
    *
    * @name getApplications
    * @summary: List sales channel stores
-   * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
+   * @description: Retrieve a list of available sales channels. sales channels are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of sales channels created within a company. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getApplications/).
    */
   async getApplications(
     { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
@@ -222,7 +222,7 @@ class Configuration {
    *
    * @name getBrandsByCompany
    * @summary: List brands by company
-   * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
+   * @description: Retrieve all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. can be searched on brand_name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getBrandsByCompany/).
    */
   async getBrandsByCompany(
     { q, requestHeaders } = { requestHeaders: {} },
@@ -306,7 +306,7 @@ class Configuration {
    *
    * @name getCompanyByBrands
    * @summary: List companies by brand
-   * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
+   * @description: Retrieve a paginated list of companies associated with specific brands. Can be searched using the brand ID and company name - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCompanyByBrands/).
    */
   async getCompanyByBrands(
     { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -395,7 +395,7 @@ class Configuration {
    *
    * @name getCurrencies
    * @summary: List currencies
-   * @description: Retrieve a list of available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencies/).
+   * @description: Retrieve a list of available currencies. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencies/).
    */
   async getCurrencies(
     { requestHeaders } = { requestHeaders: {} },
@@ -474,7 +474,7 @@ class Configuration {
    *
    * @name getCurrencyExchangeRates
    * @summary: Get currency exchange rates
-   * @description: Retrieve a list of currency exchange rates, relative to a provided currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCurrencyExchangeRates/).
+   * @description: Retrieve a list of currency exchange rates, relative to a provided currency. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getCurrencyExchangeRates/).
    */
   async getCurrencyExchangeRates(
     {
@@ -569,7 +569,7 @@ class Configuration {
    *
    * @name getDomainAvailibility
    * @summary: List suggestion domain
-   * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getDomainAvailibility/).
+   * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to sales channel. Also sends domain suggestions that are similar to the queried domain. Note - Custom domain search is currently powered by GoDaddy provider. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getDomainAvailibility/).
    */
   async getDomainAvailibility(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -654,7 +654,7 @@ class Configuration {
    *
    * @name getOtherSellerApplicationById
    * @summary: Get others sales. channel
-   * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
+   * @description: Retrieve details of a seller sales channel that was not created within the current company but has opted for the current company's inventory and searched via the sales channel ID of another sales channel - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplicationById/).
    */
   async getOtherSellerApplicationById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -738,7 +738,7 @@ class Configuration {
    *   Success response
    * @name getOtherSellerApplications
    * @summary: Get other sales channel
-   * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplications/).
+   * @description: Retrieve sales channels of  other sellers. Retrieve all other seller sales channels that were not created within the current company. but have opted for the current company's inventory. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getOtherSellerApplications/).
    */
   async getOtherSellerApplications(
     { pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -825,7 +825,7 @@ class Configuration {
    *
    * @name getStoreByBrands
    * @summary: Get store by brands
-   * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
+   * @description: Retrieve stores associated with specific brands. Retrieve a list of selling locations (stores) by the brands they deal. Store has information about store name, store type, store code, store address, and company detail. filtering can be done on brand id and brand names - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/getStoreByBrands/).
    */
   async getStoreByBrands(
     { body, pageNo, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -914,7 +914,7 @@ class Configuration {
    *
    * @name optOutFromApplication
    * @summary: opt out of marketplaces
-   * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
+   * @description: This API allows businesses to opt out of sharing their inventory with external seller sales channels. By using this API, companies or stores can prevent specific seller sales channels from fetching their inventory data. This feature is useful for businesses that want to control who  can access their product listings and other inventory information. It helps maintain privacy and control over data distribution, ensuring that sensitive information is only shared with authorized partners. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/configuration/optOutFromApplication/).
    */
   async optOutFromApplication(
     { id, body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts CHANGED Viewed

@@ -1166,7 +1166,7 @@ export = ConfigurationPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.
@@ -3743,7 +3743,7 @@ type InvalidPayloadRequestSchema = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**

package/sdk/platform/Configuration/ConfigurationPlatformModel.js CHANGED Viewed

@@ -1316,7 +1316,7 @@ const Joi = require("joi");
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @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.