@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts

@@ -25,21 +25,21 @@ declare class Configuration {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<AppCurrencyResponse>} - Success response
+     * @returns {Promise<AppCurrencyResponseSchema>} - Success response
      * @name getAppCurrencies
-     * @summary: Retrieves app-specific currencies.
+     * @summary: Get currency configuration
      * @description: Get currency configuration of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppCurrencies/).
      */
-    getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponse>;
+    getAppCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppCurrencyResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<AppStaffListResponse>} - Success response
+     * @returns {Promise<AppStaffListResponseSchema>} - Success response
      * @name getAppStaffList
-     * @summary: Lists app staff members.
+     * @summary: List staff members
      * @description: List all staff members of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffList/).
      */
-    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponse>;
+    getAppStaffList({ pageNo, pageSize, orderIncent, orderingStore, user, userName, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffListResponseSchema>;
     /**
      * @param {Object} arg - Arg object.
      * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
@@ -50,8 +50,8 @@ declare class Configuration {
      * @param {string} [arg.user] - ID of the staff. Helps in retrieving the
      *   details of a particular staff member.
      * @param {string} [arg.userName] - Username of the member.
-     * @returns {Paginator<AppStaffListResponse>}
-     * @summary: Lists app staff members.
+     * @returns {Paginator<AppStaffListResponseSchema>}
+     * @summary: List staff members
      * @description: List all staff members of the sales channel.
      */
     getAppStaffListPaginator({ pageSize, orderIncent, orderingStore, user, userName, }?: {
@@ -60,22 +60,22 @@ declare class Configuration {
         orderingStore?: number;
         user?: string;
         userName?: string;
-    }): Paginator<AppStaffListResponse>;
+    }): Paginator<AppStaffListResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<AppStaffResponse>} - Success response
+     * @returns {Promise<AppStaffResponseSchema>} - Success response
      * @name getAppStaffs
-     * @summary: Fetches detailed staff info.
+     * @summary: Get staff member
      * @description: Get a staff user including the names, employee code, incentive status, assigned ordering stores, and title of each staff added to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getAppStaffs/).
      */
-    getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponse>;
+    getAppStaffs({ orderIncent, orderingStore, user, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppStaffResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<Application>} - Success response
      * @name getApplication
-     * @summary: Fetches application details.
+     * @summary: Get sales channel
      * @description: Get details of the current sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getApplication/).
      */
     getApplication({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Application>;
@@ -84,7 +84,7 @@ declare class Configuration {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ApplicationDetail>} - Success response
      * @name getBasicDetails
-     * @summary: Retrieves basic app info.
+     * @summary: Get Sales channel
      * @description: Get basic details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getBasicDetails/).
      */
     getBasicDetails({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationDetail>;
@@ -93,112 +93,99 @@ declare class Configuration {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<ApplicationInformation>} - Success response
      * @name getContactInfo
-     * @summary: Retrieves contact details.
+     * @summary: Get sales channel contact
      * @description: Get contact details of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getContactInfo/).
      */
     getContactInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationInformation>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CurrenciesResponse>} - Success response
+     * @returns {Promise<CurrenciesResponseSchema>} - Success response
      * @name getCurrencies
-     * @summary: Lists supported currencies.
+     * @summary: List currencies
      * @description: List available currencies. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencies/).
      */
-    getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponse>;
+    getCurrencies({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CurrenciesResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<Currency>} - Success response
      * @name getCurrencyById
-     * @summary: Fetches currency by ID.
+     * @summary: Get a currency
      * @description: Get details of the currency. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getCurrencyById/).
      */
-    getCurrencyById({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Currency>;
+    getCurrencyById({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Currency>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<AppFeatureResponse>} - Success response
+     * @returns {Promise<AppFeatureResponseSchema>} - Success response
      * @name getFeatures
-     * @summary: Fetches app features.
+     * @summary: Get sales channel features
      * @description: Get configuration of the features of the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getFeatures/).
      */
-    getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponse>;
+    getFeatures({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppFeatureResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<AppTokenResponse>} - Success response
+     * @returns {Promise<AppTokenResponseSchema>} - Success response
      * @name getIntegrationTokens
-     * @summary: Fetches API tokens.
+     * @summary: Get API tokens
      * @description: Get tools integration token of the sales channel. For example, Firebase, MoEngage, Segment, GTM, Freshchat, Safetynet, Google Map, and Facebook. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getIntegrationTokens/).
      */
-    getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponse>;
+    getIntegrationTokens({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<AppTokenResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<LanguageResponse>} - Success response
+     * @returns {Promise<LanguageResponseSchema>} - Success response
      * @name getLanguages
-     * @summary: Lists available languages.
+     * @summary: List languages
      * @description: List available languages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getLanguages/).
      */
-    getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponse>;
+    getLanguages({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LanguageResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SuccessMessageResponse>} - Success response
+     * @returns {Promise<SuccessMessageResponseSchema>} - Success response
      * @name getOrderingStoreCookie
-     * @summary: Retrieves store selection cookie.
+     * @summary: Create cookies
      * @description: Reset cookie of ordering store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStoreCookie/).
      */
-    getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
+    getOrderingStoreCookie({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderingStores>} - Success response
      * @name getOrderingStores
-     * @summary: Get all deployment stores
+     * @summary: List order-enabled selling locations
      * @description: Get details of all the deployment store locations where the sales channel will be used for order placement. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOrderingStores/).
      */
     getOrderingStores({ pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderingStores>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each
-     *   page. Default value is 10.
-     * @param {string} [arg.q] - Store code or name of the ordering store.
-     * @returns {Paginator<OrderingStores>}
-     * @summary: Get all deployment stores
-     * @description: Get details of all the deployment store locations where the sales channel will be used for order placement.
-     */
-    getOrderingStoresPaginator({ pageSize, q }?: {
-        pageSize?: number;
-        q?: string;
-    }): Paginator<OrderingStores>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ApplicationAboutResponse>} - Success response
+     * @returns {Promise<ApplicationAboutResponseSchema>} - Success response
      * @name getOwnerInfo
-     * @summary: Get sales channel, owner and seller information
+     * @summary: Get sales channel owner
      * @description: Get details of the sales channel owner. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getOwnerInfo/).
      */
-    getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponse>;
+    getOwnerInfo({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationAboutResponseSchema>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<OrderingStore>} - Success response
      * @name getStoreDetailById
-     * @summary: Get ordering store details
+     * @summary: Get a selling location
      * @description: Get details of a selling location (store) by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/getStoreDetailById/).
      */
-    getStoreDetailById({ storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderingStore>;
+    getStoreDetailById({ storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderingStore>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SuccessMessageResponse>} - Success response
+     * @returns {Promise<SuccessMessageResponseSchema>} - Success response
      * @name removeOrderingStoreCookie
-     * @summary: Deletes store cookie.
+     * @summary: Delete store cookie
      * @description: Delete store cookie. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/configuration/removeOrderingStoreCookie/).
      */
-    removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponse>;
+    removeOrderingStoreCookie({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SuccessMessageResponseSchema>;
 }
 import Paginator = require("../../common/Paginator");