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

package/sdk/application/Theme/ThemeApplicationClient.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 Theme {
   constructor(_conf) {
@@ -13,11 +14,8 @@ class Theme {
     this._relativeUrls = {
       getAllPages: "/service/application/theme/v1.0/{theme_id}/page",
       getAppliedTheme: "/service/application/theme/v2.0/applied-theme",
-      getAppliedThemeV1: "/service/application/theme/v1.0/applied-theme",
       getPage: "/service/application/theme/v1.0/{theme_id}/{page_value}",
       getThemeForPreview: "/service/application/theme/v2.0/{theme_id}/preview",
-      getThemeForPreviewV1:
-        "/service/application/theme/v1.0/{theme_id}/preview",
     };
     this._urls = Object.entries(this._relativeUrls).reduce(
       (urls, [method, relativeUrl]) => {
@@ -40,25 +38,19 @@ class Theme {
    * @param {import("../ApplicationAPIClient").Options} - Options
    * @returns {Promise<AllAvailablePageSchema>} - Success response
    * @name getAllPages
-   * @summary: Fetch all pages.
+   * @summary: List pages
    * @description: Get all page level configs, sections and seo data of a theme. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAllPages/).
    */
   async getAllPages(
     { themeId, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!themeId) {
-      invalidInput.push({
-        message: `The 'themeId' field is required.`,
-        path: ["themeId"],
+    const errors = validateRequiredParams(arguments[0], ["themeId"]);
+    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));
     }
 
@@ -96,18 +88,11 @@ class Theme {
    * @description: Gets the theme configuration and template details of a theme applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedTheme/).
    */
   async getAppliedTheme(
-    { requestHeaders } = { requestHeaders: {} },
+    { filters, 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["filters"] = filters;
 
     const xHeaders = {};
 
@@ -132,51 +117,6 @@ class Theme {
     return response;
   }
 
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ThemesSchema>} - Success response
-   * @name getAppliedThemeV1
-   * @summary: Current theme.
-   * @description: Gets the theme currently applied to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getAppliedThemeV1/).
-   */
-  async getAppliedThemeV1(
-    { 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["getAppliedThemeV1"],
-        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
@@ -196,24 +136,15 @@ class Theme {
     } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!themeId) {
-      invalidInput.push({
-        message: `The 'themeId' field is required.`,
-        path: ["themeId"],
-      });
-    }
-    if (!pageValue) {
-      invalidInput.push({
-        message: `The 'pageValue' field is required.`,
-        path: ["pageValue"],
+    const errors = validateRequiredParams(arguments[0], [
+      "themeId",
+      "pageValue",
+    ]);
+    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));
     }
 
@@ -254,25 +185,20 @@ class Theme {
    * @description: Gets the theme configuration and template details of a theme by theme id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreview/).
    */
   async getThemeForPreview(
-    { themeId, requestHeaders } = { requestHeaders: {} },
+    { themeId, filters, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!themeId) {
-      invalidInput.push({
-        message: `The 'themeId' field is required.`,
-        path: ["themeId"],
+    const errors = validateRequiredParams(arguments[0], ["themeId"]);
+    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));
     }
 
     const query_params = {};
+    query_params["filters"] = filters;
 
     const xHeaders = {};
 
@@ -296,58 +222,6 @@ class Theme {
 
     return response;
   }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ThemesSchema>} - Success response
-   * @name getThemeForPreviewV1
-   * @summary: Preview theme.
-   * @description: Retrieves a theme for previewing before applying it to the application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/theme/getThemeForPreviewV1/).
-   */
-  async getThemeForPreviewV1(
-    { themeId, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    let invalidInput = [];
-
-    if (!themeId) {
-      invalidInput.push({
-        message: `The 'themeId' field is required.`,
-        path: ["themeId"],
-      });
-    }
-    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["getThemeForPreviewV1"],
-        params: { themeId },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
 }
 
 module.exports = Theme;

package/sdk/application/User/UserApplicationClient.d.ts

@@ -30,6 +30,7 @@ declare class User {
         sendOTPOnEmail: string;
         sendOTPOnMobile: string;
         sendResetPasswordEmail: string;
+        sendResetPasswordMobile: string;
         sendResetToken: string;
         sendVerificationLinkToEmail: string;
         sendVerificationLinkToMobile: string;
@@ -134,7 +135,7 @@ declare class User {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<UserAttributes>} - Success response
      * @name getUserAttributes
-     * @summary: Get user attributes
+     * @summary: Get User Attributes
      * @description: Get the list of user attributes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/getUserAttributes/).
      */
     getUserAttributes({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserAttributes>;
@@ -204,12 +205,12 @@ declare class User {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<SendOtpResponse>} - Success response
+     * @returns {Promise<SendOtp>} - Success response
      * @name loginWithOTP
      * @summary: Login with Mobile OTP
      * @description: Allow users to log in using a one-time password sent to their mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/loginWithOTP/).
      */
-    loginWithOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpResponse>;
+    loginWithOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtp>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -258,12 +259,12 @@ declare class User {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<OtpSuccess>} - Success response
+     * @returns {Promise<SendOtpSuccess>} - Success response
      * @name sendForgotOTPOnMobile
      * @summary: Send mobile OTP for forgot-password
      * @description: Send a one-time password to the user's mobile for verification when resetting a forgotten password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendForgotOTPOnMobile/).
      */
-    sendForgotOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OtpSuccess>;
+    sendForgotOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -276,12 +277,12 @@ declare class User {
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<OtpSuccess>} - Success response
+     * @returns {Promise<SendOtpSuccess>} - Success response
      * @name sendOTPOnMobile
      * @summary: Send OTP on Mobile
      * @description: Send a one-time password to the user's mobile for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendOTPOnMobile/).
      */
-    sendOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OtpSuccess>;
+    sendOTPOnMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SendOtpSuccess>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -291,6 +292,15 @@ declare class User {
      * @description: Send a password reset link to the user's email. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordEmail/).
      */
     sendResetPasswordEmail({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ResetPasswordSuccess>;
+    /**
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<any>} - Success response
+     * @name sendResetPasswordMobile
+     * @summary: Reset Password via Mobile
+     * @description: Send a password reset link to the user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/sendResetPasswordMobile/).
+     */
+    sendResetPasswordMobile({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<any>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -341,7 +351,7 @@ declare class User {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<VerifyEmailSuccess>} - Success response
      * @name updatePassword
-     * @summary: Update Password
+     * @summary: Update password
      * @description: Allow user to change their password. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updatePassword/).
      */
     updatePassword({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyEmailSuccess>;
@@ -359,19 +369,19 @@ declare class User {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<UserAttributes>} - Success response
      * @name updateUserAttributes
-     * @summary: Update user attributes
+     * @summary: Update User Attributes
      * @description: Update user attributes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/updateUserAttributes/).
      */
     updateUserAttributes({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserAttributes>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<UserExistsResponse>} - Success response
+     * @returns {Promise<UserExistsDetails>} - Success response
      * @name userExists
-     * @summary: Check User Existence
+     * @summary: Chcek User Existence
      * @description: Check whether user is already registered or not to the sales channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/userExists/).
      */
-    userExists({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserExistsResponse>;
+    userExists({ q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<UserExistsDetails>;
     /**
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
@@ -422,7 +432,7 @@ declare class User {
      * @param {import("../ApplicationAPIClient").Options} - Options
      * @returns {Promise<VerifyOtpSuccess>} - Success response
      * @name verifyMobileOTP
-     * @summary: Verify Mobile OTP
+     * @summary: Verify mobile OTP
      * @description: Verify one-time password sent to user's mobile. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/user/verifyMobileOTP/).
      */
     verifyMobileOTP({ body, platform, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<VerifyOtpSuccess>;