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

package/sdk/application/Common/CommonApplicationClient.d.ts

@@ -13,17 +13,17 @@ declare class Common {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<Locations>} - Success response
      * @name getLocations
-     * @summary: Fetches available locations.
+     * @summary: Get a location
      * @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
      */
     getLocations({ locationType, id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Locations>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<ApplicationResponse>} - Success response
+     * @returns {Promise<ApplicationResponseSchema>} - Success response
      * @name searchApplication
-     * @summary: Searches through applications.
+     * @summary: Get sales channel
      * @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
      */
-    searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponse>;
+    searchApplication({ authorization, query, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ApplicationResponseSchema>;
 }

package/sdk/application/Common/CommonApplicationClient.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 Common {
   constructor(_conf) {
@@ -36,21 +37,13 @@ class Common {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<Locations>} - Success response
    * @name getLocations
-   * @summary: Fetches available locations.
+   * @summary: Get a location
    * @description: Get countries , state , cities data associated with the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/getLocations/).
    */
   async getLocations(
     { locationType, id, 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["location_type"] = locationType;
     query_params["id"] = id;
@@ -81,23 +74,15 @@ class Common {
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ApplicationResponse>} - Success response
+   * @returns {Promise<ApplicationResponseSchema>} - Success response
    * @name searchApplication
-   * @summary: Searches through applications.
+   * @summary: Get sales channel
    * @description: Get an active sales channel based on a provided query. The query can be a valid sales channel ID or a verified domain name. If the sales channel is found, a success response is returned. If not, a 404 error response is returned. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/common/searchApplication/).
    */
   async searchApplication(
     { authorization, query, 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["query"] = query;
 

package/sdk/application/Communication/CommunicationApplicationClient.d.ts

@@ -3,58 +3,27 @@ declare class Communication {
     constructor(_conf: any);
     _conf: any;
     _relativeUrls: {
-        createAppPushtoken: string;
         getCommunicationConsent: string;
-        getCurrentCommunicationConsent: string;
-        getOtpConfiguration: string;
         upsertAppPushtoken: string;
         upsertCommunicationConsent: string;
-        upsertCurrentCommunicationConsent: string;
     };
     _urls: {};
     updateUrls(urls: any): void;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<PushtokenRes>} - Success response
-     * @name createAppPushtoken
-     * @summary: Create app push token.
-     * @description: Create the push token of the user. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/createAppPushtoken/).
-     */
-    createAppPushtoken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PushtokenRes>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<CommunicationConsent>} - Success response
      * @name getCommunicationConsent
-     * @summary: Retrieves communication consent status.
+     * @summary: Retrieve consent status
      * @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
      */
     getCommunicationConsent({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsent>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CommunicationConsent>} - Success response
-     * @name getCurrentCommunicationConsent
-     * @summary: Retrieves communication consent status.
-     * @description: Retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCurrentCommunicationConsent/).
-     */
-    getCurrentCommunicationConsent({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsent>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<OtpConfiguration>} - Success response
-     * @name getOtpConfiguration
-     * @summary: Get otp-configuration, if not present in db then return default settings
-     * @description: Get otp-configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getOtpConfiguration/).
-     */
-    getOtpConfiguration({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OtpConfiguration>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<PushtokenRes>} - Success response
      * @name upsertAppPushtoken
-     * @summary: Updates or adds app push token.
+     * @summary: Update or adds app push token
      * @description: Update or inserts the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
      */
     upsertAppPushtoken({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PushtokenRes>;
@@ -63,17 +32,8 @@ declare class Communication {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<CommunicationConsentRes>} - Success response
      * @name upsertCommunicationConsent
-     * @summary: Updates or inserts consent settings.
+     * @summary: Update or adds consent settings
      * @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
      */
     upsertCommunicationConsent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsentRes>;
-    /**
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<CommunicationConsentRes>} - Success response
-     * @name upsertCurrentCommunicationConsent
-     * @summary: Updates or inserts consent settings.
-     * @description: Update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCurrentCommunicationConsent/).
-     */
-    upsertCurrentCommunicationConsent({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CommunicationConsentRes>;
 }

package/sdk/application/Communication/CommunicationApplicationClient.js

@@ -6,23 +6,17 @@ const {
 const ApplicationAPIClient = require("../ApplicationAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 class Communication {
   constructor(_conf) {
     this._conf = _conf;
     this._relativeUrls = {
-      createAppPushtoken: "/service/application/communication/v1.0/tokens",
       getCommunicationConsent:
         "/service/application/communication/v1.0/consent",
-      getCurrentCommunicationConsent:
-        "/service/application/communication/v1.0/current/communication/consent",
-      getOtpConfiguration:
-        "/service/application/communication/v1.0/otp/otp-configuration",
       upsertAppPushtoken: "/service/application/communication/v1.0/pn-token",
       upsertCommunicationConsent:
         "/service/application/communication/v1.0/consent",
-      upsertCurrentCommunicationConsent:
-        "/service/application/communication/v1.0/current/communication/consent",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -40,71 +34,18 @@ class Communication {
     };
   }
 
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PushtokenRes>} - Success response
-   * @name createAppPushtoken
-   * @summary: Create app push token.
-   * @description: Create the push token of the user. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/createAppPushtoken/).
-   */
-  async createAppPushtoken(
-    { 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 = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["createAppPushtoken"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<CommunicationConsent>} - Success response
    * @name getCommunicationConsent
-   * @summary: Retrieves communication consent status.
+   * @summary: Retrieve consent status
    * @description: Get the consent provided by the user for receiving communication. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCommunicationConsent/).
    */
   async getCommunicationConsent(
     { 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 = {};
@@ -130,116 +71,18 @@ class Communication {
     return response;
   }
 
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CommunicationConsent>} - Success response
-   * @name getCurrentCommunicationConsent
-   * @summary: Retrieves communication consent status.
-   * @description: Retrieve the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getCurrentCommunicationConsent/).
-   */
-  async getCurrentCommunicationConsent(
-    { 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 = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getCurrentCommunicationConsent"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<OtpConfiguration>} - Success response
-   * @name getOtpConfiguration
-   * @summary: Get otp-configuration, if not present in db then return default settings
-   * @description: Get otp-configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/getOtpConfiguration/).
-   */
-  async getOtpConfiguration(
-    { 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 = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getOtpConfiguration"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
   /**
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<PushtokenRes>} - Success response
    * @name upsertAppPushtoken
-   * @summary: Updates or adds app push token.
+   * @summary: Update or adds app push token
    * @description: Update or inserts the push token of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertAppPushtoken/).
    */
   async upsertAppPushtoken(
     { 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 = {};
@@ -270,21 +113,13 @@ class Communication {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<CommunicationConsentRes>} - Success response
    * @name upsertCommunicationConsent
-   * @summary: Updates or inserts consent settings.
+   * @summary: Update or adds consent settings
    * @description: Update or insert the consent provided by the user for receiving communication messages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCommunicationConsent/).
    */
   async upsertCommunicationConsent(
     { 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 = {};
@@ -309,51 +144,6 @@ class Communication {
 
     return response;
   }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CommunicationConsentRes>} - Success response
-   * @name upsertCurrentCommunicationConsent
-   * @summary: Updates or inserts consent settings.
-   * @description: Update and insert the consent provided by the user for receiving communication messages over Email/SMS/WhatsApp. . - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/communication/upsertCurrentCommunicationConsent/).
-   */
-  async upsertCurrentCommunicationConsent(
-    { 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 = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["upsertCurrentCommunicationConsent"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
 }
 
 module.exports = Communication;