@gofynd/fdk-client-javascript 1.6.3 → 2.0.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.
@@ -109,6 +137,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.
@@ -156,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} */
@@ -174,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} */
@@ -192,6 +237,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} */
@@ -210,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, 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;
@@ -218,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;
 };
@@ -277,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.
@@ -413,6 +528,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.

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.
@@ -132,6 +164,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.
@@ -197,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({
@@ -264,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({
@@ -347,6 +430,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({

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

@@ -78,6 +78,64 @@ export = UserPlatformModel;
  * @property {string} [default_value]
  * @property {Object[]} [validations]
  */
+/**
+ * @typedef CreateStoreFrontUsersPayload
+ * @property {string} absolute_url - A valid URL linking to the file containing
+ *   user data to be imported.
+ * @property {string} file_format - The format of the file containing the user's
+ *   data. Supported formats are CSV and XLSX.
+ * @property {string} relative_url - A valid relative path to the file within
+ *   the storage system. This path should not include the base URL or domain and
+ *   must conform to the storage structure
+ */
+/**
+ * @typedef BulkUserExportSchema
+ * @property {string} file_format - The format of the file in which you want to
+ *   export data. Supported formats are CSV and XLSX.
+ */
+/**
+ * @typedef BulkActionModel
+ * @property {string} _id - The Job ID associated with an Import or Export Job
+ * @property {string} file_name - The name of the file
+ * @property {string} file_format - The format of the uploaded file (e.g., CSV, XLSX).
+ * @property {string} action_type - The type of bulk action being performed
+ *   (e.g., import, export).
+ * @property {CreatedBySchema} created_by
+ * @property {BulkActionCountSchema} [count]
+ * @property {string} [status] - The current status of the bulk action.
+ * @property {BulkActionLinkSchema} [links]
+ * @property {string} application_id - The unique identifier of the associated
+ *   application.
+ * @property {string} company_id - The unique identifier of the company
+ *   associated with the bulk action.
+ * @property {string} [created_at] - The timestamp when the bulk action was created.
+ * @property {string} [updated_at] - The timestamp when the bulk action was last updated.
+ */
+/**
+ * @typedef CreatedBySchema
+ * @property {string} name - The name of the user who initiated the operation.
+ * @property {string} user_id - A unique identifier for the user who initiated
+ *   the operation.
+ */
+/**
+ * @typedef BulkActionLinkSchema
+ * @property {FileLinks} [file]
+ * @property {FileLinks} [error]
+ */
+/**
+ * @typedef FileLinks
+ * @property {string} [absolute_url] - The full URL of the file, including the
+ *   domain and protocol, allowing direct access to the file from any location.
+ * @property {string} [relative_url] - The relative path to the file within the
+ *   storage system, excluding the base URL or domain. This path is specific to
+ *   the storage structure.
+ */
+/**
+ * @typedef BulkActionCountSchema
+ * @property {number} [total] - The total number of items to be processed.
+ * @property {number} [success] - The number of successfully processed items.
+ * @property {number} [error] - The number of items that failed to process.
+ */
 /**
  * @typedef BlockUserRequestSchema
  * @property {boolean} [status]
@@ -115,13 +173,18 @@ export = UserPlatformModel;
  * @property {UserSearchSchema[]} [items]
  * @property {PaginationSchema} [page]
  */
+/**
+ * @typedef BulkActionPaginationSchema
+ * @property {BulkActionModel[]} [items] - Array of Bulk Action Documents
+ * @property {PaginationSchema} [page]
+ */
 /**
  * @typedef PaginationSchema
- * @property {number} [size]
- * @property {number} [item_total]
- * @property {boolean} [has_next]
- * @property {string} [type]
- * @property {number} [current]
+ * @property {number} [size] - The number of items per page.
+ * @property {number} [item_total] - The total number of items across all pages.
+ * @property {boolean} [has_next] - Indicates whether there are more pages to retrieve.
+ * @property {string} [type] - The type of pagination used (eg Number).
+ * @property {number} [current] - The current page number.
  */
 /**
  * @typedef SessionListResponseSchema
@@ -335,6 +398,19 @@ export = UserPlatformModel;
  * @typedef DeleteAccountConsent
  * @property {string} [consent_text]
  */
+/**
+ * @typedef GetUserTimeline
+ * @property {string} [delete_on] - Denotes the date on which the user will be deleted
+ * @property {UserTimeline[]} [timeline] - List of user timeline events
+ */
+/**
+ * @typedef UserTimeline
+ * @property {string} [date] - Denotes the date at which this event occured
+ * @property {string} [title] - Title of the timeline event
+ * @property {string} [type] - Type of the event, indicating its status
+ * @property {boolean} [visible] - Indicates whether the event should be shown on the UI
+ * @property {string} [sub_title] - Additional information about the event
+ */
 /**
  * @typedef Facebook
  * @property {string} [app_id]
@@ -454,6 +530,7 @@ export = UserPlatformModel;
  * @property {string} [rr_id]
  * @property {boolean} [archive]
  * @property {string} [status]
+ * @property {string} [deleted_on]
  */
 /**
  * @typedef PhoneNumber
@@ -473,7 +550,7 @@ export = UserPlatformModel;
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
+    export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, UserAttributeDefinitionValidation, UserAttribute, CreateUserAttribute, CreateUserAttributeDefinition, CreateStoreFrontUsersPayload, BulkUserExportSchema, BulkActionModel, CreatedBySchema, BulkActionLinkSchema, FileLinks, BulkActionCountSchema, BlockUserRequestSchema, ArchiveUserRequestSchema, UnDeleteUserRequestSchema, BlockUserSuccess, ArchiveUserSuccess, UnDeleteUserSuccess, UserSearchResponseSchema, CustomerListResponseSchema, BulkActionPaginationSchema, PaginationSchema, SessionListResponseSchema, SessionDeleteResponseSchema, SessionsDeleteResponseSchema, APIError, SessionListResponseInfo, Conditions, UserResponseErrorSchema, UserGroupResponseSchema, UserGroupListResponseSchema, ConditionsSchema, CreateUserGroup, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, PlatformSchema, LookAndFeel, Login, MetaSchema, Social, RequiredFields, PlatformEmail, PlatformMobile, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, FlashCard, SocialTokens, DeleteAccountReasons, DeleteAccountConsent, GetUserTimeline, UserTimeline, Facebook, Accountkit, Google, SessionExpiry, UpdateUserGroupSchema, PartialUserGroupUpdateSchema, UserGroupUpdateData, UpdateUserRequestSchema, UserEmails, UserPhoneNumbers, UserSchema, UserSearchSchema, PhoneNumber, Email };
 }
 /** @returns {SuccessMessage} */
 declare function SuccessMessage(): SuccessMessage;
@@ -678,6 +755,131 @@ type CreateUserAttributeDefinition = {
     default_value?: string;
     validations?: any[];
 };
+/** @returns {CreateStoreFrontUsersPayload} */
+declare function CreateStoreFrontUsersPayload(): CreateStoreFrontUsersPayload;
+type CreateStoreFrontUsersPayload = {
+    /**
+     * - A valid URL linking to the file containing
+     * user data to be imported.
+     */
+    absolute_url: string;
+    /**
+     * - The format of the file containing the user's
+     * data. Supported formats are CSV and XLSX.
+     */
+    file_format: string;
+    /**
+     * - A valid relative path to the file within
+     * the storage system. This path should not include the base URL or domain and
+     * must conform to the storage structure
+     */
+    relative_url: string;
+};
+/** @returns {BulkUserExportSchema} */
+declare function BulkUserExportSchema(): BulkUserExportSchema;
+type BulkUserExportSchema = {
+    /**
+     * - The format of the file in which you want to
+     * export data. Supported formats are CSV and XLSX.
+     */
+    file_format: string;
+};
+/** @returns {BulkActionModel} */
+declare function BulkActionModel(): BulkActionModel;
+type BulkActionModel = {
+    /**
+     * - The Job ID associated with an Import or Export Job
+     */
+    _id: string;
+    /**
+     * - The name of the file
+     */
+    file_name: string;
+    /**
+     * - The format of the uploaded file (e.g., CSV, XLSX).
+     */
+    file_format: string;
+    /**
+     * - The type of bulk action being performed
+     * (e.g., import, export).
+     */
+    action_type: string;
+    created_by: CreatedBySchema;
+    count?: BulkActionCountSchema;
+    /**
+     * - The current status of the bulk action.
+     */
+    status?: string;
+    links?: BulkActionLinkSchema;
+    /**
+     * - The unique identifier of the associated
+     * application.
+     */
+    application_id: string;
+    /**
+     * - The unique identifier of the company
+     * associated with the bulk action.
+     */
+    company_id: string;
+    /**
+     * - The timestamp when the bulk action was created.
+     */
+    created_at?: string;
+    /**
+     * - The timestamp when the bulk action was last updated.
+     */
+    updated_at?: string;
+};
+/** @returns {CreatedBySchema} */
+declare function CreatedBySchema(): CreatedBySchema;
+type CreatedBySchema = {
+    /**
+     * - The name of the user who initiated the operation.
+     */
+    name: string;
+    /**
+     * - A unique identifier for the user who initiated
+     * the operation.
+     */
+    user_id: string;
+};
+/** @returns {BulkActionLinkSchema} */
+declare function BulkActionLinkSchema(): BulkActionLinkSchema;
+type BulkActionLinkSchema = {
+    file?: FileLinks;
+    error?: FileLinks;
+};
+/** @returns {FileLinks} */
+declare function FileLinks(): FileLinks;
+type FileLinks = {
+    /**
+     * - The full URL of the file, including the
+     * domain and protocol, allowing direct access to the file from any location.
+     */
+    absolute_url?: string;
+    /**
+     * - The relative path to the file within the
+     * storage system, excluding the base URL or domain. This path is specific to
+     * the storage structure.
+     */
+    relative_url?: string;
+};
+/** @returns {BulkActionCountSchema} */
+declare function BulkActionCountSchema(): BulkActionCountSchema;
+type BulkActionCountSchema = {
+    /**
+     * - The total number of items to be processed.
+     */
+    total?: number;
+    /**
+     * - The number of successfully processed items.
+     */
+    success?: number;
+    /**
+     * - The number of items that failed to process.
+     */
+    error?: number;
+};
 /** @returns {BlockUserRequestSchema} */
 declare function BlockUserRequestSchema(): BlockUserRequestSchema;
 type BlockUserRequestSchema = {
@@ -723,13 +925,37 @@ type CustomerListResponseSchema = {
     items?: UserSearchSchema[];
     page?: PaginationSchema;
 };
+/** @returns {BulkActionPaginationSchema} */
+declare function BulkActionPaginationSchema(): BulkActionPaginationSchema;
+type BulkActionPaginationSchema = {
+    /**
+     * - Array of Bulk Action Documents
+     */
+    items?: BulkActionModel[];
+    page?: PaginationSchema;
+};
 /** @returns {PaginationSchema} */
 declare function PaginationSchema(): PaginationSchema;
 type PaginationSchema = {
+    /**
+     * - The number of items per page.
+     */
     size?: number;
+    /**
+     * - The total number of items across all pages.
+     */
     item_total?: number;
+    /**
+     * - Indicates whether there are more pages to retrieve.
+     */
     has_next?: boolean;
+    /**
+     * - The type of pagination used (eg Number).
+     */
     type?: string;
+    /**
+     * - The current page number.
+     */
     current?: number;
 };
 /** @returns {SessionListResponseSchema} */
@@ -977,6 +1203,42 @@ declare function DeleteAccountConsent(): DeleteAccountConsent;
 type DeleteAccountConsent = {
     consent_text?: string;
 };
+/** @returns {GetUserTimeline} */
+declare function GetUserTimeline(): GetUserTimeline;
+type GetUserTimeline = {
+    /**
+     * - Denotes the date on which the user will be deleted
+     */
+    delete_on?: string;
+    /**
+     * - List of user timeline events
+     */
+    timeline?: UserTimeline[];
+};
+/** @returns {UserTimeline} */
+declare function UserTimeline(): UserTimeline;
+type UserTimeline = {
+    /**
+     * - Denotes the date at which this event occured
+     */
+    date?: string;
+    /**
+     * - Title of the timeline event
+     */
+    title?: string;
+    /**
+     * - Type of the event, indicating its status
+     */
+    type?: string;
+    /**
+     * - Indicates whether the event should be shown on the UI
+     */
+    visible?: boolean;
+    /**
+     * - Additional information about the event
+     */
+    sub_title?: string;
+};
 /** @returns {Facebook} */
 declare function Facebook(): Facebook;
 type Facebook = {
@@ -1126,6 +1388,7 @@ type UserSearchSchema = {
     rr_id?: string;
     archive?: boolean;
     status?: string;
+    deleted_on?: string;
 };
 /** @returns {PhoneNumber} */
 declare function PhoneNumber(): PhoneNumber;