@gofynd/fdk-client-javascript 1.4.2-beta.4 → 1.4.2-beta.6

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

@@ -8,8 +8,8 @@ declare class Configuration {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPlatformModel.CreateAppResponse>} - Success response
      * @name createApplication
-     * @summary: Create a new sales channel
-     * @description: Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
+     * @summary: Create application.
+     * @description: Generate and add a new application. Applications are sales channel websites which can be configured, personalized and customized. Use this API to create a new application in the current company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/createApplication/).
      */
     createApplication({ body, requestHeaders }?: ConfigurationPlatformValidator.CreateApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CreateAppResponse>;
     /**
@@ -19,22 +19,10 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.ApplicationsResponse>} -
      *   Success response
      * @name getApplications
-     * @summary: Get list of registered sales channels under company
-     * @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
+     * @summary: Get applications.
+     * @description: Retrieve a list of available applications. Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getApplications/).
      */
     getApplications({ pageNo, pageSize, q, requestHeaders }?: ConfigurationPlatformValidator.GetApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.ApplicationsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] -
-     * @param {string} [arg.q] - Search param by name or domain
-     * @returns {Paginator<ConfigurationPlatformModel.ApplicationsResponse>}
-     * @summary: Get list of registered sales channels under company
-     * @description: Applications are sales channel websites which can be configured, personalized and customised. Use this API to fetch a list of applications created within a company.
-     */
-    getApplicationsPaginator({ pageSize, q }?: {
-        pageSize?: number;
-        q?: string;
-    }): Paginator<ConfigurationPlatformModel.ApplicationsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetAvailableOptInsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -43,21 +31,10 @@ declare class Configuration {
      *   - Success response
      *
      * @name getAvailableOptIns
-     * @summary: Get all available integration opt-ins
-     * @description: Use this API to get a list of all available integrations in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
+     * @summary: Get available opt-ins.
+     * @description: Retrieve a list of available opt-ins.  Retrieve a list of all available integrations in a company.  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getAvailableOptIns/).
      */
     getAvailableOptIns({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetAvailableOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
-     * @summary: Get all available integration opt-ins
-     * @description: Use this API to get a list of all available integrations in a company
-     */
-    getAvailableOptInsPaginator({ pageSize }?: {
-        pageSize?: number;
-    }): Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetBrandsByCompanyParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -66,7 +43,7 @@ declare class Configuration {
      *   Success response
      * @name getBrandsByCompany
      * @summary: Get brands by company.
-     * @description: Use this API to get all the brands added in a company. Get all the brand names, along with URLs of their logo, banner, and portrait image. - 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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getBrandsByCompany/).
      */
     getBrandsByCompany({ q, requestHeaders }?: ConfigurationPlatformValidator.GetBrandsByCompanyParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.BrandsByCompanyResponse>;
     /**
@@ -76,23 +53,10 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>} -
      *   Success response
      * @name getCompanyByBrands
-     * @summary: Get company by brand uids
-     * @description: Use this API to get a list of companies by the brands they deal - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
+     * @summary: Get company by brands.
+     * @description: Retrieve companies associated with specific brands. Retrieve a list of companies by the brands they deal. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getCompanyByBrands/).
      */
     getCompanyByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetCompanyByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CompanyByBrandsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {ConfigurationPlatformModel.CompanyByBrandsRequest} arg.body
-     * @returns {Paginator<ConfigurationPlatformModel.CompanyByBrandsResponse>}
-     * @summary: Get company by brand uids
-     * @description: Use this API to get a list of companies by the brands they deal
-     */
-    getCompanyByBrandsPaginator({ pageSize, body }?: {
-        pageSize?: number;
-        body: ConfigurationPlatformModel.CompanyByBrandsRequest;
-    }): Paginator<ConfigurationPlatformModel.CompanyByBrandsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetCurrenciesParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -100,8 +64,8 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.CurrenciesResponse>} -
      *   Success response
      * @name getCurrencies
-     * @summary: Get all currencies
-     * @description: Use this API to get a list of currencies allowed in the company. 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/getCurrencies/).
+     * @summary: Get currencies.
+     * @description: Retrieve a list of available currencies. Use this API to get a list of currencies allowed in the company. 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/getCurrencies/).
      */
     getCurrencies({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.CurrenciesResponse>;
     /**
@@ -112,8 +76,8 @@ declare class Configuration {
      *   - Success response
      *
      * @name getDomainAvailibility
-     * @summary: Check domain availability before linking to application
-     * @description: Use this API to check the domain availability before linking it to application. 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/).
+     * @summary: Get domain availability.
+     * @description: Check the availability of a specific domain. Use this API to check the domain availability before linking it to application. 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/).
      */
     getDomainAvailibility({ body, requestHeaders }?: ConfigurationPlatformValidator.GetDomainAvailibilityParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.DomainSuggestionsResponse>;
     /**
@@ -122,8 +86,8 @@ declare class Configuration {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPlatformModel.Integration>} - Success response
      * @name getIntegrationById
-     * @summary: Get integration data by its ID
-     * @description: Use this API to fetch the details of an integration (such as Ginesys, SAP, etc.) using its ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
+     * @summary: Get integration by ID.
+     * @description: Retrieve detailed information about a specific integration. Retrieve the details of an integration (such as Ginesys, SAP, etc.) using its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationById/).
      */
     getIntegrationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.Integration>;
     /**
@@ -134,8 +98,8 @@ declare class Configuration {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
      * @name getIntegrationByLevelId
-     * @summary: Get integration config at a particular level (store/company)
-     * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
+     * @summary: Get integration by level ID.
+     * @description: Retrieve integration details for a specific level. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationByLevelId/).
      */
     getIntegrationByLevelId({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationByLevelIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
     /**
@@ -148,8 +112,8 @@ declare class Configuration {
      *   - Success response
      *
      * @name getIntegrationLevelConfig
-     * @summary: Get integration level config
-     * @description: Use this API to get the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
+     * @summary: Get integration level configuration.
+     * @description: Retrieve configuration settings for integration levels. Retrieve the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getIntegrationLevelConfig/).
      */
     getIntegrationLevelConfig({ id, level, opted, checkPermission, requestHeaders }?: ConfigurationPlatformValidator.GetIntegrationLevelConfigParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationConfigResponse>;
     /**
@@ -161,8 +125,8 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.OptedStoreIntegration>} -
      *   Success response
      * @name getLevelActiveIntegrations
-     * @summary: Check active integration at store
-     * @description: Use this API to check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
+     * @summary: Get active integrations for a level.
+     * @description: Check if a store is already opted-in for any integration - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getLevelActiveIntegrations/).
      */
     getLevelActiveIntegrations({ id, level, uid, requestHeaders }?: ConfigurationPlatformValidator.GetLevelActiveIntegrationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedStoreIntegration>;
     /**
@@ -175,8 +139,8 @@ declare class Configuration {
      *   - Success response
      *
      * @name getOtherSellerApplicationById
-     * @summary: Get other seller's sales channel by ID
-     * @description: Use application ID to fetch details of a seller application that was not created within the current company. but has opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
+     * @summary: Get other seller application by ID.
+     * @description: Retrieve details of a seller application that was not created within the current company. but has opted for the current company's inventory - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getOtherSellerApplicationById/).
      */
     getOtherSellerApplicationById({ id, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationByIdParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OptedApplicationResponse>;
     /**
@@ -188,21 +152,10 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.OtherSellerApplications>} -
      *   Success response
      * @name getOtherSellerApplications
-     * @summary: Get other seller sales channels
-     * @description: Use this API to fetch all other seller applications 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/).
+     * @summary: Get other seller applications.
+     * @description: Retrieve applications from other sellers. Retrieve all other seller applications 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/).
      */
     getOtherSellerApplications({ pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetOtherSellerApplicationsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.OtherSellerApplications>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @returns {Paginator<ConfigurationPlatformModel.OtherSellerApplications>}
-     * @summary: Get other seller sales channels
-     * @description: Use this API to fetch all other seller applications that were not created within the current company. but have opted for the current company's inventory
-     */
-    getOtherSellerApplicationsPaginator({ pageSize }?: {
-        pageSize?: number;
-    }): Paginator<ConfigurationPlatformModel.OtherSellerApplications>;
     /**
      * @param {ConfigurationPlatformValidator.GetSelectedOptInsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -211,25 +164,10 @@ declare class Configuration {
      *   - Success response
      *
      * @name getSelectedOptIns
-     * @summary: Get company/store level integration opt-ins
-     * @description: Use this API to get the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
+     * @summary: Get selected opt-ins.
+     * @description: Retrieve a list of selected opt-ins. Retrieve the store-level/company-level integrations configured in a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getSelectedOptIns/).
      */
     getSelectedOptIns({ level, uid, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetSelectedOptInsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.level - Store or company
-     * @param {number} arg.uid - Unique identifier of the selected integration level.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @returns {Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>}
-     * @summary: Get company/store level integration opt-ins
-     * @description: Use this API to get the store-level/company-level integrations configured in a company
-     */
-    getSelectedOptInsPaginator({ level, uid, pageSize }?: {
-        level: string;
-        uid: number;
-        pageSize?: number;
-    }): Paginator<ConfigurationPlatformModel.GetIntegrationsOptInsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.GetStoreByBrandsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -237,23 +175,10 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.StoreByBrandsResponse>} -
      *   Success response
      * @name getStoreByBrands
-     * @summary: Get stores by brand uids for the current company
-     * @description: Use this API to get 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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/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. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/getStoreByBrands/).
      */
     getStoreByBrands({ body, pageNo, pageSize, requestHeaders }?: ConfigurationPlatformValidator.GetStoreByBrandsParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.StoreByBrandsResponse>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {ConfigurationPlatformModel.StoreByBrandsRequest} arg.body
-     * @returns {Paginator<ConfigurationPlatformModel.StoreByBrandsResponse>}
-     * @summary: Get stores by brand uids for the current company
-     * @description: Use this API to get 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.
-     */
-    getStoreByBrandsPaginator({ pageSize, body }?: {
-        pageSize?: number;
-        body: ConfigurationPlatformModel.StoreByBrandsRequest;
-    }): Paginator<ConfigurationPlatformModel.StoreByBrandsResponse>;
     /**
      * @param {ConfigurationPlatformValidator.OptOutFromApplicationParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -261,8 +186,8 @@ declare class Configuration {
      * @returns {Promise<ConfigurationPlatformModel.SuccessMessageResponse>} -
      *   Success response
      * @name optOutFromApplication
-     * @summary: Opt-out company or store from other seller application
-     * @description: Use this API to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
+     * @summary: Opt out from an application.
+     * @description: Choose to opt-out your company or store from other seller application. The specific seller application will no longer fetch inventory from your company or store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/optOutFromApplication/).
      */
     optOutFromApplication({ id, body, requestHeaders }?: ConfigurationPlatformValidator.OptOutFromApplicationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.SuccessMessageResponse>;
     /**
@@ -273,8 +198,8 @@ declare class Configuration {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
      * @name updateLevelIntegration
-     * @summary: Update a store level integration you opted
-     * @description: Use this API to update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
+     * @summary: Update level integration.
+     * @description: Modify level integration. Update the configuration details of an integration such as token, permissions, level, opted value, uid, meta, location ID, etc. at a particular level (store/company). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelIntegration/).
      */
     updateLevelIntegration({ id, level, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
     /**
@@ -285,11 +210,10 @@ declare class Configuration {
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<ConfigurationPlatformModel.IntegrationLevel>} - Success response
      * @name updateLevelUidIntegration
-     * @summary: Update integration level by store UID
-     * @description: Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
+     * @summary: Update level UID integration.
+     * @description: Modify UID-based integration. Update the level of integration by store UID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/configuration/updateLevelUidIntegration/).
      */
     updateLevelUidIntegration({ id, level, uid, body, requestHeaders }?: ConfigurationPlatformValidator.UpdateLevelUidIntegrationParam, { responseHeaders }?: object): Promise<ConfigurationPlatformModel.IntegrationLevel>;
 }
 import ConfigurationPlatformValidator = require("./ConfigurationPlatformValidator");
 import ConfigurationPlatformModel = require("./ConfigurationPlatformModel");
-import Paginator = require("../../common/Paginator");