@gofynd/fdk-client-javascript 3.3.6 → 3.4.1

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

@@ -11,7 +11,14 @@ export = UserPlatformModel;
  * @property {string} [description] - The description of the attribute.
  * @property {string} [application_id] - The application ID.
  * @property {string} [type] - The attribute type.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
  * @property {boolean} [encrypted] - Whether the attribute is encrypted.
  * @property {boolean} [pinned] - Whether the attribute is pinned.
@@ -30,7 +37,14 @@ export = UserPlatformModel;
  * @property {string} [description] - The description of the attribute.
  * @property {string} [application_id] - The application ID.
  * @property {string} [type] - The attribute type.
- * @property {boolean} [multi_value] - Whether the attribute supports multiple values.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable] - Whether the attribute is customer-editable.
  * @property {boolean} [encrypted] - Whether the attribute is encrypted.
  * @property {boolean} [pinned] - Whether the attribute is pinned.
@@ -43,22 +57,60 @@ export = UserPlatformModel;
  * @property {string} [modified_at] - The last modification date of the
  *   attribute definition.
  */
+/**
+ * @typedef AttributeMaskingProperties
+ * @property {boolean} [enabled] - Indicates if PII masking is editable for this
+ *   attribute.
+ * @property {string} [type] - Indicates the PII masking options available
+ *   default or others
+ */
+/**
+ * @typedef AttributeRegistrationProperties
+ * @property {boolean} [enabled] - Indicates if an attribute is editable when
+ *   customer registers for a storefront.
+ * @property {string} [type] - Indicates if this attribute is mandatory or
+ *   optional when customer registers for a storefront.
+ */
 /**
  * @typedef UserAttributeDefinitionValidation
  * @property {string} [type] - The type of validation.
  * @property {Object} [value] - The validation value.
  */
+/**
+ * @typedef BulkUserAttribute
+ * @property {boolean} [success] - This describes the status of the API response
+ * @property {UserAttribute[]} [attributes]
+ */
 /**
  * @typedef UserAttribute
  * @property {string} [_id] - The unique identifier for the attribute definition.
  * @property {string} [name] - The name of user attribute definition.
  * @property {string} [user_id] - The unique identifier for the user.
  * @property {string} [application_id] - The application ID.
+ * @property {string} [user_attribute_definition_id] - The unique id of the
+ *   attribute definition.
+ * @property {string} [created_at] - The time when attribute value is created
+ *   for a user in ISO format.
+ * @property {string} [updated_at] - The time when attribute value is updated
+ *   for a user in ISO format.
  * @property {string} [type] - The attribute type.
  * @property {boolean} [customer_overridden] - Whether the attribute is customer-editable.
  * @property {Object} [attribute]
  * @property {string} [updated_by]
  */
+/**
+ * @typedef CreateBulkUserAttribute
+ * @property {BulkUserAttributeRequestBody[]} attributes - This is an array of
+ *   objects containing id of attribute definitions and the respective values to
+ *   created or updated
+ */
+/**
+ * @typedef BulkUserAttributeRequestBody
+ * @property {string} definition_id - Theis is an unique id of user attribute definition
+ * @property {Object} value - Attribute values to be create or updated. Can be a
+ *   single value or an array of values. Types supported: string, number, array
+ *   of string, or array of number.
+ */
 /**
  * @typedef CreateUserAttribute
  * @property {boolean} [customer_overridden]
@@ -69,8 +121,15 @@ export = UserPlatformModel;
  * @property {string} [name]
  * @property {string} [slug]
  * @property {string} [description]
- * @property {string} [type]
- * @property {boolean} [multi_value]
+ * @property {string} [type] - The attribute type.
+ * @property {string} [icon] - Optional icon representation for this attribute.
+ *   Defaults to an empty string.
+ * @property {string[]} [ordering_channels] - Ordering Channels where this
+ *   attribute should be visible.
+ * @property {AttributeMaskingProperties} [masking]
+ * @property {AttributeRegistrationProperties} [registration]
+ * @property {boolean} [is_multi_value] - Indicates if this attribute can accept
+ *   multiple values.
  * @property {boolean} [customer_editable]
  * @property {boolean} [encrypted]
  * @property {boolean} [pinned]
@@ -181,6 +240,7 @@ export = UserPlatformModel;
 /**
  * @typedef PaginationSchema
  * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - The total number of items across all pages.
  * @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).
@@ -259,6 +319,76 @@ export = UserPlatformModel;
  * @property {string} [type]
  * @property {string} [value]
  */
+/**
+ * @typedef DeleteBulkUserAttribute
+ * @property {string[]} [definition_ids] - List of user attribute definition IDs
+ *   for which the corresponding values should be deleted.
+ */
+/**
+ * @typedef UserAttributeFilter
+ * @property {UserAttributeFilterQuery} [query]
+ */
+/**
+ * @typedef UserAttributeFilterQuery
+ * @property {string} type - Logical condition type to apply between multiple
+ *   attribute filters.
+ * @property {number} limit - Number of results to return per page.
+ * @property {number} page - Page number to fetch.
+ * @property {string} [email] - Filter users by their exact email address.
+ * @property {string} [phone] - Filter users by their exact phone number.
+ * @property {string[]} [definition_ids] - List of user attribute definition IDs
+ *   to fetch attributes values available for each user.
+ * @property {UserAttributeFilterRequestConditions[]} conditions - List of
+ *   filtering conditions to apply on user attributes.
+ */
+/**
+ * @typedef UserAttributeFilterRequestConditions
+ * @property {string} definition_id - ID of the user attribute definition to filter on.
+ * @property {string} type - Filter operation to apply on the attribute value.
+ *   Supported operations include:
+ *
+ *   - `eq`: Equal to - `ne`: Not equal to - `gt`: Greater than (or is after for
+ *       dates) - `lt`: Less than (or is before for dates) - `gte`: Greater than
+ *       or equal to - `lte`: Less than or equal to - `cnt`: Contains (for
+ *       strings) - `nct`: Does not contain (for strings) - `is`: Matches
+ *       exactly (for strings) - `nis`: Does not match exactly (for strings) -
+ *       `sw`: Starts with (for strings) - `ew`: Ends with (for strings) -
+ *       `btw`: Between two values (for date and datetime types) - `in`: Value
+ *       exists in given list - `nin`: Value does not exist in given list
+ *
+ * @property {Object} value - Values to be used in filtering the attribute. Can
+ *   be a single value or an array of values. Types supported: string, number,
+ *   array of string, or array of number.
+ */
+/**
+ * @typedef UserAttributeFiltered
+ * @property {UserAttributeFilteredList[]} [items] - List of user objects that
+ *   match the filter criteria.
+ * @property {PaginationSchema} [page]
+ */
+/**
+ * @typedef UserAttributeFilteredList
+ * @property {string} [_id] - Unique ID of the user.
+ * @property {string} [username] - Generated username for the user.
+ * @property {UserPhoneNumbers[]} [phone_numbers] - List of phone numbers
+ *   associated with the user.
+ * @property {UserEmails[]} [emails] - List of emails associated with the user.
+ * @property {string} [gender] - Gender of the user.
+ * @property {boolean} [active] - Whether the user account is active.
+ * @property {boolean} [archive] - Whether the user account is archived.
+ * @property {string} [status] - Status of the user account.
+ * @property {UserAttribute[]} [attributes]
+ * @property {string} [first_name] - First name of the user.
+ * @property {string} [last_name] - Last name of the user.
+ * @property {string} [account_type] - Type of user account.
+ * @property {string} [profile_pic_url] - URL to user's profile picture.
+ * @property {boolean} [has_old_password_hash] - Whether user has legacy password format.
+ * @property {string} [user_id] - Unique user ID.
+ * @property {string} [application_id] - Application ID associated with the user.
+ * @property {boolean} [is_encrypted] - Whether the user data is encrypted.
+ * @property {string} [created_at] - Timestamp of user creation.
+ * @property {string} [updated_at] - Timestamp of last update.
+ */
 /**
  * @typedef CreateUserGroup
  * @property {ConditionsSchema[]} [conditions]
@@ -561,7 +691,7 @@ export = UserPlatformModel;
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    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, UserConsent, PrivacyPolicyConsentSchema };
+    export { SuccessMessage, UserAttributeDefinition, UserAttributeDefinitionDetails, AttributeMaskingProperties, AttributeRegistrationProperties, UserAttributeDefinitionValidation, BulkUserAttribute, UserAttribute, CreateBulkUserAttribute, BulkUserAttributeRequestBody, 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, DeleteBulkUserAttribute, UserAttributeFilter, UserAttributeFilterQuery, UserAttributeFilterRequestConditions, UserAttributeFiltered, UserAttributeFilteredList, 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, UserConsent, PrivacyPolicyConsentSchema };
 }
 /** @returns {SuccessMessage} */
 declare function SuccessMessage(): SuccessMessage;
@@ -596,9 +726,22 @@ type UserAttributeDefinition = {
      */
     type?: string;
     /**
-     * - Whether the attribute supports multiple values.
+     * - Optional icon representation for this attribute.
+     * Defaults to an empty string.
+     */
+    icon?: string;
+    /**
+     * - Ordering Channels where this
+     * attribute should be visible.
      */
-    multi_value?: boolean;
+    ordering_channels?: string[];
+    masking?: AttributeMaskingProperties;
+    registration?: AttributeRegistrationProperties;
+    /**
+     * - Indicates if this attribute can accept
+     * multiple values.
+     */
+    is_multi_value?: boolean;
     /**
      * - Whether the attribute is customer-editable.
      */
@@ -661,9 +804,22 @@ type UserAttributeDefinitionDetails = {
      */
     type?: string;
     /**
-     * - Whether the attribute supports multiple values.
+     * - Optional icon representation for this attribute.
+     * Defaults to an empty string.
+     */
+    icon?: string;
+    /**
+     * - Ordering Channels where this
+     * attribute should be visible.
+     */
+    ordering_channels?: string[];
+    masking?: AttributeMaskingProperties;
+    registration?: AttributeRegistrationProperties;
+    /**
+     * - Indicates if this attribute can accept
+     * multiple values.
      */
-    multi_value?: boolean;
+    is_multi_value?: boolean;
     /**
      * - Whether the attribute is customer-editable.
      */
@@ -703,6 +859,34 @@ type UserAttributeDefinitionDetails = {
      */
     modified_at?: string;
 };
+/** @returns {AttributeMaskingProperties} */
+declare function AttributeMaskingProperties(): AttributeMaskingProperties;
+type AttributeMaskingProperties = {
+    /**
+     * - Indicates if PII masking is editable for this
+     * attribute.
+     */
+    enabled?: boolean;
+    /**
+     * - Indicates the PII masking options available
+     * default or others
+     */
+    type?: string;
+};
+/** @returns {AttributeRegistrationProperties} */
+declare function AttributeRegistrationProperties(): AttributeRegistrationProperties;
+type AttributeRegistrationProperties = {
+    /**
+     * - Indicates if an attribute is editable when
+     * customer registers for a storefront.
+     */
+    enabled?: boolean;
+    /**
+     * - Indicates if this attribute is mandatory or
+     * optional when customer registers for a storefront.
+     */
+    type?: string;
+};
 /** @returns {UserAttributeDefinitionValidation} */
 declare function UserAttributeDefinitionValidation(): UserAttributeDefinitionValidation;
 type UserAttributeDefinitionValidation = {
@@ -715,6 +899,15 @@ type UserAttributeDefinitionValidation = {
      */
     value?: any;
 };
+/** @returns {BulkUserAttribute} */
+declare function BulkUserAttribute(): BulkUserAttribute;
+type BulkUserAttribute = {
+    /**
+     * - This describes the status of the API response
+     */
+    success?: boolean;
+    attributes?: UserAttribute[];
+};
 /** @returns {UserAttribute} */
 declare function UserAttribute(): UserAttribute;
 type UserAttribute = {
@@ -734,6 +927,21 @@ type UserAttribute = {
      * - The application ID.
      */
     application_id?: string;
+    /**
+     * - The unique id of the
+     * attribute definition.
+     */
+    user_attribute_definition_id?: string;
+    /**
+     * - The time when attribute value is created
+     * for a user in ISO format.
+     */
+    created_at?: string;
+    /**
+     * - The time when attribute value is updated
+     * for a user in ISO format.
+     */
+    updated_at?: string;
     /**
      * - The attribute type.
      */
@@ -745,6 +953,30 @@ type UserAttribute = {
     attribute?: any;
     updated_by?: string;
 };
+/** @returns {CreateBulkUserAttribute} */
+declare function CreateBulkUserAttribute(): CreateBulkUserAttribute;
+type CreateBulkUserAttribute = {
+    /**
+     * - This is an array of
+     * objects containing id of attribute definitions and the respective values to
+     * created or updated
+     */
+    attributes: BulkUserAttributeRequestBody[];
+};
+/** @returns {BulkUserAttributeRequestBody} */
+declare function BulkUserAttributeRequestBody(): BulkUserAttributeRequestBody;
+type BulkUserAttributeRequestBody = {
+    /**
+     * - Theis is an unique id of user attribute definition
+     */
+    definition_id: string;
+    /**
+     * - Attribute values to be create or updated. Can be a
+     * single value or an array of values. Types supported: string, number, array
+     * of string, or array of number.
+     */
+    value: any;
+};
 /** @returns {CreateUserAttribute} */
 declare function CreateUserAttribute(): CreateUserAttribute;
 type CreateUserAttribute = {
@@ -757,8 +989,27 @@ type CreateUserAttributeDefinition = {
     name?: string;
     slug?: string;
     description?: string;
+    /**
+     * - The attribute type.
+     */
     type?: string;
-    multi_value?: boolean;
+    /**
+     * - Optional icon representation for this attribute.
+     * Defaults to an empty string.
+     */
+    icon?: string;
+    /**
+     * - Ordering Channels where this
+     * attribute should be visible.
+     */
+    ordering_channels?: string[];
+    masking?: AttributeMaskingProperties;
+    registration?: AttributeRegistrationProperties;
+    /**
+     * - Indicates if this attribute can accept
+     * multiple values.
+     */
+    is_multi_value?: boolean;
     customer_editable?: boolean;
     encrypted?: boolean;
     pinned?: boolean;
@@ -952,6 +1203,10 @@ type PaginationSchema = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - The total number of items across all pages.
+     */
+    total?: number;
     /**
      * - The total number of items across all pages.
      */
@@ -1055,6 +1310,171 @@ type ConditionsSchema = {
     type?: string;
     value?: string;
 };
+/** @returns {DeleteBulkUserAttribute} */
+declare function DeleteBulkUserAttribute(): DeleteBulkUserAttribute;
+type DeleteBulkUserAttribute = {
+    /**
+     * - List of user attribute definition IDs
+     * for which the corresponding values should be deleted.
+     */
+    definition_ids?: string[];
+};
+/** @returns {UserAttributeFilter} */
+declare function UserAttributeFilter(): UserAttributeFilter;
+type UserAttributeFilter = {
+    query?: UserAttributeFilterQuery;
+};
+/** @returns {UserAttributeFilterQuery} */
+declare function UserAttributeFilterQuery(): UserAttributeFilterQuery;
+type UserAttributeFilterQuery = {
+    /**
+     * - Logical condition type to apply between multiple
+     * attribute filters.
+     */
+    type: string;
+    /**
+     * - Number of results to return per page.
+     */
+    limit: number;
+    /**
+     * - Page number to fetch.
+     */
+    page: number;
+    /**
+     * - Filter users by their exact email address.
+     */
+    email?: string;
+    /**
+     * - Filter users by their exact phone number.
+     */
+    phone?: string;
+    /**
+     * - List of user attribute definition IDs
+     * to fetch attributes values available for each user.
+     */
+    definition_ids?: string[];
+    /**
+     * - List of
+     * filtering conditions to apply on user attributes.
+     */
+    conditions: UserAttributeFilterRequestConditions[];
+};
+/** @returns {UserAttributeFilterRequestConditions} */
+declare function UserAttributeFilterRequestConditions(): UserAttributeFilterRequestConditions;
+type UserAttributeFilterRequestConditions = {
+    /**
+     * - ID of the user attribute definition to filter on.
+     */
+    definition_id: string;
+    /**
+     * - Filter operation to apply on the attribute value.
+     * Supported operations include:
+     *
+     * - `eq`: Equal to - `ne`: Not equal to - `gt`: Greater than (or is after for
+     * dates) - `lt`: Less than (or is before for dates) - `gte`: Greater than
+     * or equal to - `lte`: Less than or equal to - `cnt`: Contains (for
+     * strings) - `nct`: Does not contain (for strings) - `is`: Matches
+     * exactly (for strings) - `nis`: Does not match exactly (for strings) -
+     * `sw`: Starts with (for strings) - `ew`: Ends with (for strings) -
+     * `btw`: Between two values (for date and datetime types) - `in`: Value
+     * exists in given list - `nin`: Value does not exist in given list
+     */
+    type: string;
+    /**
+     * - Values to be used in filtering the attribute. Can
+     * be a single value or an array of values. Types supported: string, number,
+     * array of string, or array of number.
+     */
+    value: any;
+};
+/** @returns {UserAttributeFiltered} */
+declare function UserAttributeFiltered(): UserAttributeFiltered;
+type UserAttributeFiltered = {
+    /**
+     * - List of user objects that
+     * match the filter criteria.
+     */
+    items?: UserAttributeFilteredList[];
+    page?: PaginationSchema;
+};
+/** @returns {UserAttributeFilteredList} */
+declare function UserAttributeFilteredList(): UserAttributeFilteredList;
+type UserAttributeFilteredList = {
+    /**
+     * - Unique ID of the user.
+     */
+    _id?: string;
+    /**
+     * - Generated username for the user.
+     */
+    username?: string;
+    /**
+     * - List of phone numbers
+     * associated with the user.
+     */
+    phone_numbers?: UserPhoneNumbers[];
+    /**
+     * - List of emails associated with the user.
+     */
+    emails?: UserEmails[];
+    /**
+     * - Gender of the user.
+     */
+    gender?: string;
+    /**
+     * - Whether the user account is active.
+     */
+    active?: boolean;
+    /**
+     * - Whether the user account is archived.
+     */
+    archive?: boolean;
+    /**
+     * - Status of the user account.
+     */
+    status?: string;
+    attributes?: UserAttribute[];
+    /**
+     * - First name of the user.
+     */
+    first_name?: string;
+    /**
+     * - Last name of the user.
+     */
+    last_name?: string;
+    /**
+     * - Type of user account.
+     */
+    account_type?: string;
+    /**
+     * - URL to user's profile picture.
+     */
+    profile_pic_url?: string;
+    /**
+     * - Whether user has legacy password format.
+     */
+    has_old_password_hash?: boolean;
+    /**
+     * - Unique user ID.
+     */
+    user_id?: string;
+    /**
+     * - Application ID associated with the user.
+     */
+    application_id?: string;
+    /**
+     * - Whether the user data is encrypted.
+     */
+    is_encrypted?: boolean;
+    /**
+     * - Timestamp of user creation.
+     */
+    created_at?: string;
+    /**
+     * - Timestamp of last update.
+     */
+    updated_at?: string;
+};
 /** @returns {CreateUserGroup} */
 declare function CreateUserGroup(): CreateUserGroup;
 type CreateUserGroup = {