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

package/sdk/platform/User/UserPlatformApplicationValidator.d.ts

@@ -7,6 +7,14 @@ export = UserPlatformApplicationValidator;
  * @typedef BlockOrUnblockUsersParam
  * @property {UserPlatformModel.BlockUserRequestSchema} body
  */
+/**
+ * @typedef BulkImportStoreFrontUsersParam
+ * @property {UserPlatformModel.CreateStoreFrontUsersPayload} body
+ */
+/**
+ * @typedef CreateBulkExportUsersParam
+ * @property {UserPlatformModel.BulkUserExportSchema} body
+ */
 /**
  * @typedef CreateUserParam
  * @property {UserPlatformModel.CreateUserRequestSchema} body
@@ -48,6 +56,26 @@ export = UserPlatformApplicationValidator;
  * @typedef GetActiveSessionsParam
  * @property {string} id - ID of a customer.
  */
+/**
+ * @typedef GetBulkExportUsersListParam
+ * @property {string} [pageNo] - Page number for pagination result
+ * @property {string} [pageSize] - Page size for pagination result
+ * @property {string} [fileFormat] - Filter data based on file format eg csv or xlsx
+ * @property {string} [search] - The search queries based on job name.
+ * @property {string} [startDate] - Start date
+ * @property {string} [endDate] - End date
+ * @property {string} [status] - Status of the Import Documents
+ */
+/**
+ * @typedef GetBulkImportUsersListParam
+ * @property {string} [pageNo] - Page number for pagination result
+ * @property {string} [pageSize] - Page size for pagination result
+ * @property {string} [search] - The search queries based on job name.
+ * @property {string} [startDate] - Start date
+ * @property {string} [endDate] - End date
+ * @property {string} [status] - Status of the Import Documents
+ * @property {string} [fileFormat] - Filter data based on file format eg csv or xlsx
+ */
 /**
  * @typedef GetCustomersParam
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -110,8 +138,13 @@ export = UserPlatformApplicationValidator;
  * @property {number} [groupUid] - To get User Groups with given uid
  */
 /**
- * @typedef GetUsersByByGroupIdParam
- * @property {string} groupId - Numeric ID allotted to a User Group
+ * @typedef GetUserTimelineParam
+ * @property {string} userId - User ID
+ */
+/**
+ * @typedef GetUsersJobByJobIdParam
+ * @property {string} jobId - The unique identifier of the job. This is used to
+ *   fetch the details of the specific job.
  */
 /**
  * @typedef SearchUsersParam
@@ -137,7 +170,7 @@ export = UserPlatformApplicationValidator;
  * @property {string} attributeDefId - The unique identifier of the attribute
  *   definition to update.
  * @property {string} userId - The unique identifier of the user to update.
- * @property {UserPlatformModel.CreateUserAttributeRequest} body
+ * @property {UserPlatformModel.CreateUserAttribute} body
  */
 /**
  * @typedef UpdateUserAttributeDefinitionParam
@@ -160,6 +193,10 @@ declare class UserPlatformApplicationValidator {
     static archiveUser(): ArchiveUserParam;
     /** @returns {BlockOrUnblockUsersParam} */
     static blockOrUnblockUsers(): BlockOrUnblockUsersParam;
+    /** @returns {BulkImportStoreFrontUsersParam} */
+    static bulkImportStoreFrontUsers(): BulkImportStoreFrontUsersParam;
+    /** @returns {CreateBulkExportUsersParam} */
+    static createBulkExportUsers(): CreateBulkExportUsersParam;
     /** @returns {CreateUserParam} */
     static createUser(): CreateUserParam;
     /** @returns {CreateUserAttributeDefinitionParam} */
@@ -178,6 +215,10 @@ declare class UserPlatformApplicationValidator {
     static deleteUserAttributeDefinitionById(): DeleteUserAttributeDefinitionByIdParam;
     /** @returns {GetActiveSessionsParam} */
     static getActiveSessions(): GetActiveSessionsParam;
+    /** @returns {GetBulkExportUsersListParam} */
+    static getBulkExportUsersList(): GetBulkExportUsersListParam;
+    /** @returns {GetBulkImportUsersListParam} */
+    static getBulkImportUsersList(): GetBulkImportUsersListParam;
     /** @returns {GetCustomersParam} */
     static getCustomers(): GetCustomersParam;
     /** @returns {GetPlatformConfigParam} */
@@ -196,8 +237,10 @@ declare class UserPlatformApplicationValidator {
     static getUserGroupById(): GetUserGroupByIdParam;
     /** @returns {GetUserGroupsParam} */
     static getUserGroups(): GetUserGroupsParam;
-    /** @returns {GetUsersByByGroupIdParam} */
-    static getUsersByByGroupId(): GetUsersByByGroupIdParam;
+    /** @returns {GetUserTimelineParam} */
+    static getUserTimeline(): GetUserTimelineParam;
+    /** @returns {GetUsersJobByJobIdParam} */
+    static getUsersJobByJobId(): GetUsersJobByJobIdParam;
     /** @returns {SearchUsersParam} */
     static searchUsers(): SearchUsersParam;
     /** @returns {UnDeleteUserParam} */
@@ -216,7 +259,7 @@ declare class UserPlatformApplicationValidator {
     static updateUserGroupPartially(): UpdateUserGroupPartiallyParam;
 }
 declare namespace UserPlatformApplicationValidator {
-    export { ArchiveUserParam, BlockOrUnblockUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUsersByByGroupIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
+    export { ArchiveUserParam, BlockOrUnblockUsersParam, BulkImportStoreFrontUsersParam, CreateBulkExportUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, GetActiveSessionsParam, GetBulkExportUsersListParam, GetBulkImportUsersListParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUserTimelineParam, GetUsersJobByJobIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -224,6 +267,12 @@ type ArchiveUserParam = {
 type BlockOrUnblockUsersParam = {
     body: UserPlatformModel.BlockUserRequestSchema;
 };
+type BulkImportStoreFrontUsersParam = {
+    body: UserPlatformModel.CreateStoreFrontUsersPayload;
+};
+type CreateBulkExportUsersParam = {
+    body: UserPlatformModel.BulkUserExportSchema;
+};
 type CreateUserParam = {
     body: UserPlatformModel.CreateUserRequestSchema;
 };
@@ -283,6 +332,66 @@ type GetActiveSessionsParam = {
      */
     id: string;
 };
+type GetBulkExportUsersListParam = {
+    /**
+     * - Page number for pagination result
+     */
+    pageNo?: string;
+    /**
+     * - Page size for pagination result
+     */
+    pageSize?: string;
+    /**
+     * - Filter data based on file format eg csv or xlsx
+     */
+    fileFormat?: string;
+    /**
+     * - The search queries based on job name.
+     */
+    search?: string;
+    /**
+     * - Start date
+     */
+    startDate?: string;
+    /**
+     * - End date
+     */
+    endDate?: string;
+    /**
+     * - Status of the Import Documents
+     */
+    status?: string;
+};
+type GetBulkImportUsersListParam = {
+    /**
+     * - Page number for pagination result
+     */
+    pageNo?: string;
+    /**
+     * - Page size for pagination result
+     */
+    pageSize?: string;
+    /**
+     * - The search queries based on job name.
+     */
+    search?: string;
+    /**
+     * - Start date
+     */
+    startDate?: string;
+    /**
+     * - End date
+     */
+    endDate?: string;
+    /**
+     * - Status of the Import Documents
+     */
+    status?: string;
+    /**
+     * - Filter data based on file format eg csv or xlsx
+     */
+    fileFormat?: string;
+};
 type GetCustomersParam = {
     /**
      * - The search query. Mobile number or email ID of a customer.
@@ -419,11 +528,18 @@ type GetUserGroupsParam = {
      */
     groupUid?: number;
 };
-type GetUsersByByGroupIdParam = {
+type GetUserTimelineParam = {
     /**
-     * - Numeric ID allotted to a User Group
+     * - User ID
      */
-    groupId: string;
+    userId: string;
+};
+type GetUsersJobByJobIdParam = {
+    /**
+     * - The unique identifier of the job. This is used to
+     * fetch the details of the specific job.
+     */
+    jobId: string;
 };
 type SearchUsersParam = {
     /**
@@ -459,7 +575,7 @@ type UpdateUserAttributeParam = {
      * - The unique identifier of the user to update.
      */
     userId: string;
-    body: UserPlatformModel.CreateUserAttributeRequest;
+    body: UserPlatformModel.CreateUserAttribute;
 };
 type UpdateUserAttributeDefinitionParam = {
     /**

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -12,6 +12,16 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {UserPlatformModel.BlockUserRequestSchema} body
  */
 
+/**
+ * @typedef BulkImportStoreFrontUsersParam
+ * @property {UserPlatformModel.CreateStoreFrontUsersPayload} body
+ */
+
+/**
+ * @typedef CreateBulkExportUsersParam
+ * @property {UserPlatformModel.BulkUserExportSchema} body
+ */
+
 /**
  * @typedef CreateUserParam
  * @property {UserPlatformModel.CreateUserRequestSchema} body
@@ -62,6 +72,28 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {string} id - ID of a customer.
  */
 
+/**
+ * @typedef GetBulkExportUsersListParam
+ * @property {string} [pageNo] - Page number for pagination result
+ * @property {string} [pageSize] - Page size for pagination result
+ * @property {string} [fileFormat] - Filter data based on file format eg csv or xlsx
+ * @property {string} [search] - The search queries based on job name.
+ * @property {string} [startDate] - Start date
+ * @property {string} [endDate] - End date
+ * @property {string} [status] - Status of the Import Documents
+ */
+
+/**
+ * @typedef GetBulkImportUsersListParam
+ * @property {string} [pageNo] - Page number for pagination result
+ * @property {string} [pageSize] - Page size for pagination result
+ * @property {string} [search] - The search queries based on job name.
+ * @property {string} [startDate] - Start date
+ * @property {string} [endDate] - End date
+ * @property {string} [status] - Status of the Import Documents
+ * @property {string} [fileFormat] - Filter data based on file format eg csv or xlsx
+ */
+
 /**
  * @typedef GetCustomersParam
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -133,8 +165,14 @@ const UserPlatformModel = require("./UserPlatformModel");
  */
 
 /**
- * @typedef GetUsersByByGroupIdParam
- * @property {string} groupId - Numeric ID allotted to a User Group
+ * @typedef GetUserTimelineParam
+ * @property {string} userId - User ID
+ */
+
+/**
+ * @typedef GetUsersJobByJobIdParam
+ * @property {string} jobId - The unique identifier of the job. This is used to
+ *   fetch the details of the specific job.
  */
 
 /**
@@ -165,7 +203,7 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {string} attributeDefId - The unique identifier of the attribute
  *   definition to update.
  * @property {string} userId - The unique identifier of the user to update.
- * @property {UserPlatformModel.CreateUserAttributeRequest} body
+ * @property {UserPlatformModel.CreateUserAttribute} body
  */
 
 /**
@@ -202,6 +240,20 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {BulkImportStoreFrontUsersParam} */
+  static bulkImportStoreFrontUsers() {
+    return Joi.object({
+      body: UserPlatformModel.CreateStoreFrontUsersPayload().required(),
+    }).required();
+  }
+
+  /** @returns {CreateBulkExportUsersParam} */
+  static createBulkExportUsers() {
+    return Joi.object({
+      body: UserPlatformModel.BulkUserExportSchema().required(),
+    }).required();
+  }
+
   /** @returns {CreateUserParam} */
   static createUser() {
     return Joi.object({
@@ -269,6 +321,32 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetBulkExportUsersListParam} */
+  static getBulkExportUsersList() {
+    return Joi.object({
+      pageNo: Joi.string().allow(""),
+      pageSize: Joi.string().allow(""),
+      fileFormat: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+    }).required();
+  }
+
+  /** @returns {GetBulkImportUsersListParam} */
+  static getBulkImportUsersList() {
+    return Joi.object({
+      pageNo: Joi.string().allow(""),
+      pageSize: Joi.string().allow(""),
+      search: Joi.string().allow(""),
+      startDate: Joi.string().allow(""),
+      endDate: Joi.string().allow(""),
+      status: Joi.string().allow(""),
+      fileFormat: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetCustomersParam} */
   static getCustomers() {
     return Joi.object({
@@ -352,10 +430,17 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
-  /** @returns {GetUsersByByGroupIdParam} */
-  static getUsersByByGroupId() {
+  /** @returns {GetUserTimelineParam} */
+  static getUserTimeline() {
     return Joi.object({
-      groupId: Joi.string().allow("").required(),
+      userId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetUsersJobByJobIdParam} */
+  static getUsersJobByJobId() {
+    return Joi.object({
+      jobId: Joi.string().allow("").required(),
     }).required();
   }
 
@@ -395,7 +480,7 @@ class UserPlatformApplicationValidator {
       attributeDefId: Joi.string().allow("").required(),
       userId: Joi.string().allow("").required(),
 
-      body: UserPlatformModel.CreateUserAttributeRequest().required(),
+      body: UserPlatformModel.CreateUserAttribute().required(),
     }).required();
   }