@gofynd/fdk-client-javascript 1.4.15-beta.14 → 1.4.15-beta.15

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

@@ -7,8 +7,19 @@ export = UserPlatformApplicationValidator;
  * @typedef BlockOrUnblockUsersParam
  * @property {UserPlatformModel.BlockUserRequestSchema} body
  */
+/**
+ * @typedef BulkImportStoreFrontUsersParam
+ * @property {UserPlatformModel.CreateStoreFrontUsersPayload} body
+ */
+/**
+ * @typedef CreateBulkExportUsersParam
+ * @property {UserPlatformModel.BulkUserExportSchema} body
+ */
 /**
  * @typedef CreateUserParam
+ * @property {boolean} [verified] - Controls whether newly created emails and
+ *   phone numbers are marked as verified. Pass verified=false to keep them
+ *   unverified. When omitted, they are auto-marked verified.
  * @property {UserPlatformModel.CreateUserRequestSchema} body
  */
 /**
@@ -44,10 +55,43 @@ export = UserPlatformApplicationValidator;
  * @property {string} attributeDefId - The unique identifier of the attribute
  *   definition to delete.
  */
+/**
+ * @typedef DeleteUserAttributesInBulkParam
+ * @property {string} userId - The unique identifier of the user to update.
+ * @property {UserPlatformModel.DeleteBulkUserAttribute} body
+ */
+/**
+ * @typedef DeleteUserGroupParam
+ * @property {string} groupId - Unique ID allotted to a User Group
+ */
+/**
+ * @typedef FilterUsersByAttributesParam
+ * @property {UserPlatformModel.UserAttributeFilter} body
+ */
 /**
  * @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.
@@ -109,6 +153,15 @@ export = UserPlatformApplicationValidator;
  * @property {string} [status] - To get User Groups with given status
  * @property {number} [groupUid] - To get User Groups with given uid
  */
+/**
+ * @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
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -133,7 +186,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
@@ -141,6 +194,11 @@ export = UserPlatformApplicationValidator;
  *   definition to update.
  * @property {UserPlatformModel.CreateUserAttributeDefinition} body
  */
+/**
+ * @typedef UpdateUserAttributesParam
+ * @property {string} userId - The unique identifier of the user.
+ * @property {UserPlatformModel.CreateBulkUserAttribute} body
+ */
 /**
  * @typedef UpdateUserGroupParam
  * @property {string} groupId - Numeric ID allotted to a User Group
@@ -156,6 +214,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} */
@@ -172,8 +234,18 @@ declare class UserPlatformApplicationValidator {
     static deleteUserAttribute(): DeleteUserAttributeParam;
     /** @returns {DeleteUserAttributeDefinitionByIdParam} */
     static deleteUserAttributeDefinitionById(): DeleteUserAttributeDefinitionByIdParam;
+    /** @returns {DeleteUserAttributesInBulkParam} */
+    static deleteUserAttributesInBulk(): DeleteUserAttributesInBulkParam;
+    /** @returns {DeleteUserGroupParam} */
+    static deleteUserGroup(): DeleteUserGroupParam;
+    /** @returns {FilterUsersByAttributesParam} */
+    static filterUsersByAttributes(): FilterUsersByAttributesParam;
     /** @returns {GetActiveSessionsParam} */
     static getActiveSessions(): GetActiveSessionsParam;
+    /** @returns {GetBulkExportUsersListParam} */
+    static getBulkExportUsersList(): GetBulkExportUsersListParam;
+    /** @returns {GetBulkImportUsersListParam} */
+    static getBulkImportUsersList(): GetBulkImportUsersListParam;
     /** @returns {GetCustomersParam} */
     static getCustomers(): GetCustomersParam;
     /** @returns {GetPlatformConfigParam} */
@@ -192,6 +264,10 @@ declare class UserPlatformApplicationValidator {
     static getUserGroupById(): GetUserGroupByIdParam;
     /** @returns {GetUserGroupsParam} */
     static getUserGroups(): GetUserGroupsParam;
+    /** @returns {GetUserTimelineParam} */
+    static getUserTimeline(): GetUserTimelineParam;
+    /** @returns {GetUsersJobByJobIdParam} */
+    static getUsersJobByJobId(): GetUsersJobByJobIdParam;
     /** @returns {SearchUsersParam} */
     static searchUsers(): SearchUsersParam;
     /** @returns {UnDeleteUserParam} */
@@ -204,13 +280,15 @@ declare class UserPlatformApplicationValidator {
     static updateUserAttribute(): UpdateUserAttributeParam;
     /** @returns {UpdateUserAttributeDefinitionParam} */
     static updateUserAttributeDefinition(): UpdateUserAttributeDefinitionParam;
+    /** @returns {UpdateUserAttributesParam} */
+    static updateUserAttributes(): UpdateUserAttributesParam;
     /** @returns {UpdateUserGroupParam} */
     static updateUserGroup(): UpdateUserGroupParam;
     /** @returns {UpdateUserGroupPartiallyParam} */
     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, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
+    export { ArchiveUserParam, BlockOrUnblockUsersParam, BulkImportStoreFrontUsersParam, CreateBulkExportUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, DeleteUserAttributesInBulkParam, DeleteUserGroupParam, FilterUsersByAttributesParam, GetActiveSessionsParam, GetBulkExportUsersListParam, GetBulkImportUsersListParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUserTimelineParam, GetUsersJobByJobIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserAttributesParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -218,7 +296,19 @@ type ArchiveUserParam = {
 type BlockOrUnblockUsersParam = {
     body: UserPlatformModel.BlockUserRequestSchema;
 };
+type BulkImportStoreFrontUsersParam = {
+    body: UserPlatformModel.CreateStoreFrontUsersPayload;
+};
+type CreateBulkExportUsersParam = {
+    body: UserPlatformModel.BulkUserExportSchema;
+};
 type CreateUserParam = {
+    /**
+     * - Controls whether newly created emails and
+     * phone numbers are marked as verified. Pass verified=false to keep them
+     * unverified. When omitted, they are auto-marked verified.
+     */
+    verified?: boolean;
     body: UserPlatformModel.CreateUserRequestSchema;
 };
 type CreateUserAttributeDefinitionParam = {
@@ -271,12 +361,88 @@ type DeleteUserAttributeDefinitionByIdParam = {
      */
     attributeDefId: string;
 };
+type DeleteUserAttributesInBulkParam = {
+    /**
+     * - The unique identifier of the user to update.
+     */
+    userId: string;
+    body: UserPlatformModel.DeleteBulkUserAttribute;
+};
+type DeleteUserGroupParam = {
+    /**
+     * - Unique ID allotted to a User Group
+     */
+    groupId: string;
+};
+type FilterUsersByAttributesParam = {
+    body: UserPlatformModel.UserAttributeFilter;
+};
 type GetActiveSessionsParam = {
     /**
      * - ID of a customer.
      */
     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.
@@ -413,6 +579,19 @@ type GetUserGroupsParam = {
      */
     groupUid?: number;
 };
+type GetUserTimelineParam = {
+    /**
+     * - User ID
+     */
+    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 = {
     /**
      * - The search query. Mobile number or email ID of a customer.
@@ -447,7 +626,7 @@ type UpdateUserAttributeParam = {
      * - The unique identifier of the user to update.
      */
     userId: string;
-    body: UserPlatformModel.CreateUserAttributeRequest;
+    body: UserPlatformModel.CreateUserAttribute;
 };
 type UpdateUserAttributeDefinitionParam = {
     /**
@@ -457,6 +636,13 @@ type UpdateUserAttributeDefinitionParam = {
     attributeDefId: string;
     body: UserPlatformModel.CreateUserAttributeDefinition;
 };
+type UpdateUserAttributesParam = {
+    /**
+     * - The unique identifier of the user.
+     */
+    userId: string;
+    body: UserPlatformModel.CreateBulkUserAttribute;
+};
 type UpdateUserGroupParam = {
     /**
      * - Numeric ID allotted to a User Group

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -12,8 +12,21 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {UserPlatformModel.BlockUserRequestSchema} body
  */
 
+/**
+ * @typedef BulkImportStoreFrontUsersParam
+ * @property {UserPlatformModel.CreateStoreFrontUsersPayload} body
+ */
+
+/**
+ * @typedef CreateBulkExportUsersParam
+ * @property {UserPlatformModel.BulkUserExportSchema} body
+ */
+
 /**
  * @typedef CreateUserParam
+ * @property {boolean} [verified] - Controls whether newly created emails and
+ *   phone numbers are marked as verified. Pass verified=false to keep them
+ *   unverified. When omitted, they are auto-marked verified.
  * @property {UserPlatformModel.CreateUserRequestSchema} body
  */
 
@@ -57,11 +70,49 @@ const UserPlatformModel = require("./UserPlatformModel");
  *   definition to delete.
  */
 
+/**
+ * @typedef DeleteUserAttributesInBulkParam
+ * @property {string} userId - The unique identifier of the user to update.
+ * @property {UserPlatformModel.DeleteBulkUserAttribute} body
+ */
+
+/**
+ * @typedef DeleteUserGroupParam
+ * @property {string} groupId - Unique ID allotted to a User Group
+ */
+
+/**
+ * @typedef FilterUsersByAttributesParam
+ * @property {UserPlatformModel.UserAttributeFilter} body
+ */
+
 /**
  * @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.
@@ -132,6 +183,17 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {number} [groupUid] - To get User Groups with given uid
  */
 
+/**
+ * @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
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -160,7 +222,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
  */
 
 /**
@@ -170,6 +232,12 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {UserPlatformModel.CreateUserAttributeDefinition} body
  */
 
+/**
+ * @typedef UpdateUserAttributesParam
+ * @property {string} userId - The unique identifier of the user.
+ * @property {UserPlatformModel.CreateBulkUserAttribute} body
+ */
+
 /**
  * @typedef UpdateUserGroupParam
  * @property {string} groupId - Numeric ID allotted to a User Group
@@ -197,9 +265,24 @@ 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({
+      verified: Joi.boolean(),
       body: UserPlatformModel.CreateUserRequestSchema().required(),
     }).required();
   }
@@ -257,6 +340,29 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteUserAttributesInBulkParam} */
+  static deleteUserAttributesInBulk() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+
+      body: UserPlatformModel.DeleteBulkUserAttribute().required(),
+    }).required();
+  }
+
+  /** @returns {DeleteUserGroupParam} */
+  static deleteUserGroup() {
+    return Joi.object({
+      groupId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {FilterUsersByAttributesParam} */
+  static filterUsersByAttributes() {
+    return Joi.object({
+      body: UserPlatformModel.UserAttributeFilter().required(),
+    }).required();
+  }
+
   /** @returns {GetActiveSessionsParam} */
   static getActiveSessions() {
     return Joi.object({
@@ -264,6 +370,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({
@@ -312,7 +444,6 @@ class UserPlatformApplicationValidator {
       pinOrder: Joi.number(),
       isLocked: Joi.boolean(),
       name: Joi.string().allow(""),
-
       pageSize: Joi.number(),
       pageNo: Joi.number(),
     }).required();
@@ -347,6 +478,20 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetUserTimelineParam} */
+  static getUserTimeline() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+    }).required();
+  }
+
+  /** @returns {GetUsersJobByJobIdParam} */
+  static getUsersJobByJobId() {
+    return Joi.object({
+      jobId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {SearchUsersParam} */
   static searchUsers() {
     return Joi.object({
@@ -383,7 +528,7 @@ class UserPlatformApplicationValidator {
       attributeDefId: Joi.string().allow("").required(),
       userId: Joi.string().allow("").required(),
 
-      body: UserPlatformModel.CreateUserAttributeRequest().required(),
+      body: UserPlatformModel.CreateUserAttribute().required(),
     }).required();
   }
 
@@ -396,6 +541,15 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateUserAttributesParam} */
+  static updateUserAttributes() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+
+      body: UserPlatformModel.CreateBulkUserAttribute().required(),
+    }).required();
+  }
+
   /** @returns {UpdateUserGroupParam} */
   static updateUserGroup() {
     return Joi.object({