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

package/sdk/application/Configuration/ConfigurationApplicationClient.js

@@ -6,6 +6,7 @@ const {
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 class Configuration {
   constructor(_conf) {
@@ -51,23 +52,15 @@ 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/).
    */
   async getAppCurrencies(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -96,9 +89,9 @@ class Configuration {
   /**
    * @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/).
    */
   async getAppStaffList(
@@ -113,14 +106,6 @@ class Configuration {
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -162,8 +147,8 @@ 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({
@@ -199,9 +184,9 @@ class Configuration {
   /**
    * @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/).
    */
   async getAppStaffs(
@@ -210,14 +195,6 @@ class Configuration {
     },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
     query_params["order_incent"] = orderIncent;
     query_params["ordering_store"] = orderingStore;
@@ -251,21 +228,13 @@ class Configuration {
    * @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/).
    */
   async getApplication(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -296,21 +265,13 @@ 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/).
    */
   async getBasicDetails(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -341,21 +302,13 @@ 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/).
    */
   async getContactInfo(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -384,23 +337,15 @@ class Configuration {
   /**
    * @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/).
    */
   async getCurrencies(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -431,25 +376,19 @@ class Configuration {
    * @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/).
    */
   async getCurrencyById(
     { id, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!id) {
-      invalidInput.push({
-        message: `The 'id' field is required.`,
-        path: ["id"],
+    const errors = validateRequiredParams(arguments[0], ["id"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -481,23 +420,15 @@ class Configuration {
   /**
    * @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/).
    */
   async getFeatures(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -526,23 +457,15 @@ class Configuration {
   /**
    * @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/).
    */
   async getIntegrationTokens(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -571,23 +494,15 @@ class Configuration {
   /**
    * @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/).
    */
   async getLanguages(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -616,23 +531,15 @@ class Configuration {
   /**
    * @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/).
    */
   async getOrderingStoreCookie(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -663,21 +570,13 @@ class Configuration {
    * @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/).
    */
   async getOrderingStores(
     { pageNo, pageSize, q, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
     query_params["page_no"] = pageNo;
     query_params["page_size"] = pageSize;
@@ -706,56 +605,18 @@ class Configuration {
     return response;
   }
 
-  /**
-   * @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 } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.getOrderingStores({
-        pageNo: pageNo,
-        pageSize: pageSize,
-        q: q,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
-  }
-
   /**
    * @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/).
    */
   async getOwnerInfo(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};
@@ -786,25 +647,19 @@ class Configuration {
    * @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/).
    */
   async getStoreDetailById(
     { storeId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!storeId) {
-      invalidInput.push({
-        message: `The 'storeId' field is required.`,
-        path: ["storeId"],
+    const errors = validateRequiredParams(arguments[0], ["storeId"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }
 
@@ -836,23 +691,15 @@ class Configuration {
   /**
    * @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/).
    */
   async removeOrderingStoreCookie(
     { requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
     const query_params = {};
 
     const xHeaders = {};