@gofynd/fdk-client-javascript 1.3.3 → 1.3.4-beta.2

package/sdk/application/User/UserApplicationModel.js

@@ -5,6 +5,15 @@ const Joi = require("joi");
  * @property {string} [app_id]
  */
 
+/**
+ * @typedef APIError
+ * @property {string} [code]
+ * @property {string} [info] - Error code description link
+ * @property {string} [message]
+ * @property {Object} [meta]
+ * @property {string} [request_id]
+ */
+
 /**
  * @typedef AuthenticationApiErrorSchema
  * @property {string} [message]
@@ -344,11 +353,23 @@ const Joi = require("joi");
  * @property {PlatformMobile} [mobile]
  */
 
+/**
+ * @typedef ResetForgotPasswordSuccess
+ * @property {boolean} [success]
+ */
+
 /**
  * @typedef ResetPasswordSuccess
  * @property {string} [status]
  */
 
+/**
+ * @typedef SendEmailForgotOtpRequestSchema
+ * @property {string} [action]
+ * @property {string} [email]
+ * @property {string} [token]
+ */
+
 /**
  * @typedef SendEmailOtpRequestSchema
  * @property {string} [action]
@@ -363,6 +384,15 @@ const Joi = require("joi");
  * @property {boolean} [verify_email_link]
  */
 
+/**
+ * @typedef SendMobileForgotOtpRequestSchema
+ * @property {string} [action]
+ * @property {string} [android_hash]
+ * @property {string} [country_code]
+ * @property {string} [mobile]
+ * @property {string} [token]
+ */
+
 /**
  * @typedef SendMobileOtpRequestSchema
  * @property {string} [action]
@@ -489,6 +519,12 @@ const Joi = require("joi");
  * @property {string} [username]
  */
 
+/**
+ * @typedef VerifyEmailForgotOtpRequestSchema
+ * @property {string} [email]
+ * @property {string} [otp]
+ */
+
 /**
  * @typedef VerifyEmailOtpRequestSchema
  * @property {string} [action]
@@ -508,6 +544,18 @@ const Joi = require("joi");
  * @property {string} [message]
  */
 
+/**
+ * @typedef VerifyForgotOtpSuccess
+ * @property {string} [forgot_token]
+ * @property {boolean} [success]
+ */
+
+/**
+ * @typedef VerifyMobileForgotOtpRequestSchema
+ * @property {string} [otp]
+ * @property {string} [request_id]
+ */
+
 /**
  * @typedef VerifyMobileOTPSuccess
  * @property {UserSchema} [user]
@@ -536,6 +584,17 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {APIError} */
+  static APIError() {
+    return Joi.object({
+      code: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      message: Joi.string().allow(""),
+      meta: Joi.any(),
+      request_id: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {AuthenticationApiErrorSchema} */
   static AuthenticationApiErrorSchema() {
     return Joi.object({
@@ -965,6 +1024,13 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {ResetForgotPasswordSuccess} */
+  static ResetForgotPasswordSuccess() {
+    return Joi.object({
+      success: Joi.boolean(),
+    });
+  }
+
   /** @returns {ResetPasswordSuccess} */
   static ResetPasswordSuccess() {
     return Joi.object({
@@ -972,6 +1038,15 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {SendEmailForgotOtpRequestSchema} */
+  static SendEmailForgotOtpRequestSchema() {
+    return Joi.object({
+      action: Joi.string().allow(""),
+      email: Joi.string().allow(""),
+      token: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SendEmailOtpRequestSchema} */
   static SendEmailOtpRequestSchema() {
     return Joi.object({
@@ -990,6 +1065,17 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {SendMobileForgotOtpRequestSchema} */
+  static SendMobileForgotOtpRequestSchema() {
+    return Joi.object({
+      action: Joi.string().allow(""),
+      android_hash: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
+      mobile: Joi.string().allow(""),
+      token: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {SendMobileOtpRequestSchema} */
   static SendMobileOtpRequestSchema() {
     return Joi.object({
@@ -1146,6 +1232,14 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {VerifyEmailForgotOtpRequestSchema} */
+  static VerifyEmailForgotOtpRequestSchema() {
+    return Joi.object({
+      email: Joi.string().allow(""),
+      otp: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {VerifyEmailOtpRequestSchema} */
   static VerifyEmailOtpRequestSchema() {
     return Joi.object({
@@ -1171,6 +1265,22 @@ class UserApplicationModel {
     });
   }
 
+  /** @returns {VerifyForgotOtpSuccess} */
+  static VerifyForgotOtpSuccess() {
+    return Joi.object({
+      forgot_token: Joi.string().allow(""),
+      success: Joi.boolean(),
+    });
+  }
+
+  /** @returns {VerifyMobileForgotOtpRequestSchema} */
+  static VerifyMobileForgotOtpRequestSchema() {
+    return Joi.object({
+      otp: Joi.string().allow(""),
+      request_id: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {VerifyMobileOTPSuccess} */
   static VerifyMobileOTPSuccess() {
     return Joi.object({

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

@@ -93,6 +93,20 @@ export = UserApplicationValidator;
  * @property {string} [platform] - ID of the application
  * @property {UserApplicationModel.FormRegisterRequestSchema} body
  */
+/**
+ * @typedef ResetForgotPasswordParam
+ * @property {UserApplicationModel.ForgotPasswordRequestSchema} body
+ */
+/**
+ * @typedef SendForgotOTPOnEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendEmailForgotOtpRequestSchema} body
+ */
+/**
+ * @typedef SendForgotOTPOnMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendMobileForgotOtpRequestSchema} body
+ */
 /**
  * @typedef SendOTPOnEmailParam
  * @property {string} [platform] - ID of the application
@@ -148,6 +162,11 @@ export = UserApplicationValidator;
  * @typedef VerifyEmailParam
  * @property {UserApplicationModel.CodeRequestBodySchema} body
  */
+/**
+ * @typedef VerifyEmailForgotOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyEmailForgotOtpRequestSchema} body
+ */
 /**
  * @typedef VerifyEmailOTPParam
  * @property {string} [platform] - ID of the application
@@ -157,6 +176,11 @@ export = UserApplicationValidator;
  * @typedef VerifyMobileParam
  * @property {UserApplicationModel.CodeRequestBodySchema} body
  */
+/**
+ * @typedef VerifyMobileForgotOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyMobileForgotOtpRequestSchema} body
+ */
 /**
  * @typedef VerifyMobileOTPParam
  * @property {string} [platform] - ID of the application
@@ -203,6 +227,12 @@ declare class UserApplicationValidator {
     static logout(): any;
     /** @returns {RegisterWithFormParam} */
     static registerWithForm(): RegisterWithFormParam;
+    /** @returns {ResetForgotPasswordParam} */
+    static resetForgotPassword(): ResetForgotPasswordParam;
+    /** @returns {SendForgotOTPOnEmailParam} */
+    static sendForgotOTPOnEmail(): SendForgotOTPOnEmailParam;
+    /** @returns {SendForgotOTPOnMobileParam} */
+    static sendForgotOTPOnMobile(): SendForgotOTPOnMobileParam;
     /** @returns {SendOTPOnEmailParam} */
     static sendOTPOnEmail(): SendOTPOnEmailParam;
     /** @returns {SendOTPOnMobileParam} */
@@ -227,15 +257,19 @@ declare class UserApplicationValidator {
     static updateProfile(): UpdateProfileParam;
     /** @returns {VerifyEmailParam} */
     static verifyEmail(): VerifyEmailParam;
+    /** @returns {VerifyEmailForgotOTPParam} */
+    static verifyEmailForgotOTP(): VerifyEmailForgotOTPParam;
     /** @returns {VerifyEmailOTPParam} */
     static verifyEmailOTP(): VerifyEmailOTPParam;
     /** @returns {VerifyMobileParam} */
     static verifyMobile(): VerifyMobileParam;
+    /** @returns {VerifyMobileForgotOTPParam} */
+    static verifyMobileForgotOTP(): VerifyMobileForgotOTPParam;
     /** @returns {VerifyMobileOTPParam} */
     static verifyMobileOTP(): VerifyMobileOTPParam;
 }
 declare namespace UserApplicationValidator {
-    export { AddEmailParam, AddMobileNumberParam, DeleteEmailParam, DeleteMobileNumberParam, DeleteUserParam, ForgotPasswordParam, GetListOfActiveSessionsParam, GetLoggedInUserParam, GetPlatformConfigParam, HasPasswordParam, LoginWithAppleIOSParam, LoginWithEmailAndPasswordParam, LoginWithFacebookParam, LoginWithGoogleParam, LoginWithGoogleAndroidParam, LoginWithGoogleIOSParam, LoginWithOTPParam, LoginWithTokenParam, LogoutParam, RegisterWithFormParam, SendOTPOnEmailParam, SendOTPOnMobileParam, SendResetPasswordEmailParam, SendResetPasswordMobileParam, SendResetTokenParam, SendVerificationLinkToEmailParam, SendVerificationLinkToMobileParam, SetEmailAsPrimaryParam, SetMobileNumberAsPrimaryParam, UpdatePasswordParam, UpdateProfileParam, VerifyEmailParam, VerifyEmailOTPParam, VerifyMobileParam, VerifyMobileOTPParam };
+    export { AddEmailParam, AddMobileNumberParam, DeleteEmailParam, DeleteMobileNumberParam, DeleteUserParam, ForgotPasswordParam, GetListOfActiveSessionsParam, GetLoggedInUserParam, GetPlatformConfigParam, HasPasswordParam, LoginWithAppleIOSParam, LoginWithEmailAndPasswordParam, LoginWithFacebookParam, LoginWithGoogleParam, LoginWithGoogleAndroidParam, LoginWithGoogleIOSParam, LoginWithOTPParam, LoginWithTokenParam, LogoutParam, RegisterWithFormParam, ResetForgotPasswordParam, SendForgotOTPOnEmailParam, SendForgotOTPOnMobileParam, SendOTPOnEmailParam, SendOTPOnMobileParam, SendResetPasswordEmailParam, SendResetPasswordMobileParam, SendResetTokenParam, SendVerificationLinkToEmailParam, SendVerificationLinkToMobileParam, SetEmailAsPrimaryParam, SetMobileNumberAsPrimaryParam, UpdatePasswordParam, UpdateProfileParam, VerifyEmailParam, VerifyEmailForgotOTPParam, VerifyEmailOTPParam, VerifyMobileParam, VerifyMobileForgotOTPParam, VerifyMobileOTPParam };
 }
 type AddEmailParam = {
     /**
@@ -374,6 +408,23 @@ type RegisterWithFormParam = {
     platform?: string;
     body: UserApplicationModel.FormRegisterRequestSchema;
 };
+type ResetForgotPasswordParam = {
+    body: UserApplicationModel.ForgotPasswordRequestSchema;
+};
+type SendForgotOTPOnEmailParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendEmailForgotOtpRequestSchema;
+};
+type SendForgotOTPOnMobileParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.SendMobileForgotOtpRequestSchema;
+};
 type SendOTPOnEmailParam = {
     /**
      * - ID of the application
@@ -438,6 +489,13 @@ type UpdateProfileParam = {
 type VerifyEmailParam = {
     body: UserApplicationModel.CodeRequestBodySchema;
 };
+type VerifyEmailForgotOTPParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.VerifyEmailForgotOtpRequestSchema;
+};
 type VerifyEmailOTPParam = {
     /**
      * - ID of the application
@@ -448,6 +506,13 @@ type VerifyEmailOTPParam = {
 type VerifyMobileParam = {
     body: UserApplicationModel.CodeRequestBodySchema;
 };
+type VerifyMobileForgotOTPParam = {
+    /**
+     * - ID of the application
+     */
+    platform?: string;
+    body: UserApplicationModel.VerifyMobileForgotOtpRequestSchema;
+};
 type VerifyMobileOTPParam = {
     /**
      * - ID of the application

package/sdk/application/User/UserApplicationValidator.js

@@ -116,6 +116,23 @@ const UserApplicationModel = require("./UserApplicationModel");
  * @property {UserApplicationModel.FormRegisterRequestSchema} body
  */
 
+/**
+ * @typedef ResetForgotPasswordParam
+ * @property {UserApplicationModel.ForgotPasswordRequestSchema} body
+ */
+
+/**
+ * @typedef SendForgotOTPOnEmailParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendEmailForgotOtpRequestSchema} body
+ */
+
+/**
+ * @typedef SendForgotOTPOnMobileParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.SendMobileForgotOtpRequestSchema} body
+ */
+
 /**
  * @typedef SendOTPOnEmailParam
  * @property {string} [platform] - ID of the application
@@ -183,6 +200,12 @@ const UserApplicationModel = require("./UserApplicationModel");
  * @property {UserApplicationModel.CodeRequestBodySchema} body
  */
 
+/**
+ * @typedef VerifyEmailForgotOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyEmailForgotOtpRequestSchema} body
+ */
+
 /**
  * @typedef VerifyEmailOTPParam
  * @property {string} [platform] - ID of the application
@@ -194,6 +217,12 @@ const UserApplicationModel = require("./UserApplicationModel");
  * @property {UserApplicationModel.CodeRequestBodySchema} body
  */
 
+/**
+ * @typedef VerifyMobileForgotOTPParam
+ * @property {string} [platform] - ID of the application
+ * @property {UserApplicationModel.VerifyMobileForgotOtpRequestSchema} body
+ */
+
 /**
  * @typedef VerifyMobileOTPParam
  * @property {string} [platform] - ID of the application
@@ -351,6 +380,29 @@ class UserApplicationValidator {
     }).required();
   }
 
+  /** @returns {ResetForgotPasswordParam} */
+  static resetForgotPassword() {
+    return Joi.object({
+      body: UserApplicationModel.ForgotPasswordRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {SendForgotOTPOnEmailParam} */
+  static sendForgotOTPOnEmail() {
+    return Joi.object({
+      platform: Joi.string().allow(""),
+      body: UserApplicationModel.SendEmailForgotOtpRequestSchema().required(),
+    }).required();
+  }
+
+  /** @returns {SendForgotOTPOnMobileParam} */
+  static sendForgotOTPOnMobile() {
+    return Joi.object({
+      platform: Joi.string().allow(""),
+      body: UserApplicationModel.SendMobileForgotOtpRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {SendOTPOnEmailParam} */
   static sendOTPOnEmail() {
     return Joi.object({
@@ -442,6 +494,14 @@ class UserApplicationValidator {
     }).required();
   }
 
+  /** @returns {VerifyEmailForgotOTPParam} */
+  static verifyEmailForgotOTP() {
+    return Joi.object({
+      platform: Joi.string().allow(""),
+      body: UserApplicationModel.VerifyEmailForgotOtpRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {VerifyEmailOTPParam} */
   static verifyEmailOTP() {
     return Joi.object({
@@ -457,6 +517,14 @@ class UserApplicationValidator {
     }).required();
   }
 
+  /** @returns {VerifyMobileForgotOTPParam} */
+  static verifyMobileForgotOTP() {
+    return Joi.object({
+      platform: Joi.string().allow(""),
+      body: UserApplicationModel.VerifyMobileForgotOtpRequestSchema().required(),
+    }).required();
+  }
+
   /** @returns {VerifyMobileOTPParam} */
   static verifyMobileOTP() {
     return Joi.object({

package/sdk/common/AxiosHelper.js

@@ -136,6 +136,11 @@ fdkAxios.interceptors.response.use(
         level: "ERROR",
         message: error.response.data || error.message,
         stack: error.response.data.stack || error.stack,
+        request: {
+          method: error.config.method,
+          url: error.config.url,
+          headers: error.config.headers,
+        },
       });
       throw new FDKServerResponseError(
         error.response.data.message || error.message,
@@ -150,6 +155,11 @@ fdkAxios.interceptors.response.use(
         level: "ERROR",
         message: error.data || error.message,
         stack: error.data.stack || error.stack,
+        request: {
+          method: error.config.method,
+          url: error.config.url,
+          headers: error.config.headers,
+        },
       });
       throw new FDKServerResponseError(
         error.message,

package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts

@@ -0,0 +1,96 @@
+export = FileStorage;
+declare class FileStorage {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
+     * @param {StartRequest} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+     * @description: Uploads an arbitrarily sized buffer or blob.
+     *
+     * It has three Major Steps:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `startUpload`.
+     * It returns the storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+     *
+     * ### Complete
+     * After successfully upload, call `completeUpload` api to complete the upload process.
+     * This operation will return the url for the uploaded file.
+     */
+    startUpload({ namespace, body, requestHeaders }?: {
+        namespace: string;
+        body: StartRequest;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
+     * @param {StartResponse} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
+     * @description: Uploads an arbitrarily sized buffer or blob.
+     *
+     * It has three Major Steps:
+     * Start
+     * Upload
+     * Complete
+     *
+     * ### Start
+     * Initiates the assets upload using `startUpload`.
+     * It returns the storage link in response.
+     *
+     * ### Upload
+     * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+     * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+     *
+     * ### Complete
+     * After successfully upload, call `completeUpload` api to complete the upload process.
+     * This operation will return the url for the uploaded file.
+     */
+    completeUpload({ namespace, body, requestHeaders }?: {
+        namespace: string;
+        body: StartResponse;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.namespace - Segregation of different types of
+     *   files(products, orders, logistics etc), Required for validating the
+     *   data of the file being uploaded, decides where exactly the file will be
+     *   stored inside the storage bucket.
+     * @param {string} arg.applicationId -
+     * @param {number} arg.companyId -
+     * @param {number} [arg.page] - Page no
+     * @param {number} [arg.limit] - Limit
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Browse Files
+     * @description: Browse Files
+     */
+    browse({ namespace, applicationId, companyId, page, limit, requestHeaders }?: {
+        namespace: string;
+        applicationId: string;
+        companyId: number;
+        page?: number;
+        limit?: number;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+}