@gofynd/fdk-client-javascript 3.3.6 → 3.4.0

package/sdk/platform/User/UserPlatformModel.js

@@ -13,7 +13,14 @@ const Joi = require("joi");
  * @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.
@@ -33,7 +40,14 @@ const Joi = require("joi");
  * @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.
@@ -47,24 +61,67 @@ const Joi = require("joi");
  *   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]
@@ -76,8 +133,15 @@ const Joi = require("joi");
  * @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]
@@ -205,6 +269,7 @@ const Joi = require("joi");
 /**
  * @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).
@@ -294,6 +359,82 @@ const Joi = require("joi");
  * @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]
@@ -648,7 +789,11 @@ class UserPlatformModel {
       description: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -670,7 +815,11 @@ class UserPlatformModel {
       description: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -686,6 +835,22 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {AttributeMaskingProperties} */
+  static AttributeMaskingProperties() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+      type: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AttributeRegistrationProperties} */
+  static AttributeRegistrationProperties() {
+    return Joi.object({
+      enabled: Joi.boolean(),
+      type: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserAttributeDefinitionValidation} */
   static UserAttributeDefinitionValidation() {
     return Joi.object({
@@ -694,6 +859,14 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {BulkUserAttribute} */
+  static BulkUserAttribute() {
+    return Joi.object({
+      success: Joi.boolean(),
+      attributes: Joi.array().items(UserPlatformModel.UserAttribute()),
+    });
+  }
+
   /** @returns {UserAttribute} */
   static UserAttribute() {
     return Joi.object({
@@ -701,6 +874,9 @@ class UserPlatformModel {
       name: Joi.string().allow(""),
       user_id: Joi.string().allow(""),
       application_id: Joi.string().allow(""),
+      user_attribute_definition_id: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
       type: Joi.string().allow(""),
       customer_overridden: Joi.boolean(),
       attribute: Joi.object().pattern(/\S/, Joi.any()),
@@ -708,6 +884,23 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {CreateBulkUserAttribute} */
+  static CreateBulkUserAttribute() {
+    return Joi.object({
+      attributes: Joi.array()
+        .items(UserPlatformModel.BulkUserAttributeRequestBody())
+        .required(),
+    });
+  }
+
+  /** @returns {BulkUserAttributeRequestBody} */
+  static BulkUserAttributeRequestBody() {
+    return Joi.object({
+      definition_id: Joi.string().allow("").required(),
+      value: Joi.any().required(),
+    });
+  }
+
   /** @returns {CreateUserAttribute} */
   static CreateUserAttribute() {
     return Joi.object({
@@ -723,7 +916,11 @@ class UserPlatformModel {
       slug: Joi.string().allow(""),
       description: Joi.string().allow(""),
       type: Joi.string().allow(""),
-      multi_value: Joi.boolean(),
+      icon: Joi.string().allow(""),
+      ordering_channels: Joi.array().items(Joi.string().allow("")),
+      masking: UserPlatformModel.AttributeMaskingProperties(),
+      registration: UserPlatformModel.AttributeRegistrationProperties(),
+      is_multi_value: Joi.boolean(),
       customer_editable: Joi.boolean(),
       encrypted: Joi.boolean(),
       pinned: Joi.boolean(),
@@ -873,6 +1070,7 @@ class UserPlatformModel {
   static PaginationSchema() {
     return Joi.object({
       size: Joi.number(),
+      total: Joi.number(),
       item_total: Joi.number(),
       has_next: Joi.boolean(),
       type: Joi.string().allow(""),
@@ -983,6 +1181,77 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {DeleteBulkUserAttribute} */
+  static DeleteBulkUserAttribute() {
+    return Joi.object({
+      definition_ids: Joi.array().items(Joi.string().allow("")),
+    });
+  }
+
+  /** @returns {UserAttributeFilter} */
+  static UserAttributeFilter() {
+    return Joi.object({
+      query: UserPlatformModel.UserAttributeFilterQuery(),
+    });
+  }
+
+  /** @returns {UserAttributeFilterQuery} */
+  static UserAttributeFilterQuery() {
+    return Joi.object({
+      type: Joi.string().allow("").required(),
+      limit: Joi.number().required(),
+      page: Joi.number().required(),
+      email: Joi.string().allow(""),
+      phone: Joi.string().allow(""),
+      definition_ids: Joi.array().items(Joi.string().allow("")),
+      conditions: Joi.array()
+        .items(UserPlatformModel.UserAttributeFilterRequestConditions())
+        .required(),
+    });
+  }
+
+  /** @returns {UserAttributeFilterRequestConditions} */
+  static UserAttributeFilterRequestConditions() {
+    return Joi.object({
+      definition_id: Joi.string().allow("").required(),
+      type: Joi.string().allow("").required(),
+      value: Joi.any().required(),
+    });
+  }
+
+  /** @returns {UserAttributeFiltered} */
+  static UserAttributeFiltered() {
+    return Joi.object({
+      items: Joi.array().items(UserPlatformModel.UserAttributeFilteredList()),
+      page: UserPlatformModel.PaginationSchema(),
+    });
+  }
+
+  /** @returns {UserAttributeFilteredList} */
+  static UserAttributeFilteredList() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      username: Joi.string().allow(""),
+      phone_numbers: Joi.array().items(UserPlatformModel.UserPhoneNumbers()),
+      emails: Joi.array().items(UserPlatformModel.UserEmails()),
+      gender: Joi.string().allow(""),
+      active: Joi.boolean(),
+      archive: Joi.boolean(),
+      status: Joi.string().allow(""),
+      attributes: Joi.array().items(UserPlatformModel.UserAttribute()),
+      first_name: Joi.string().allow(""),
+      last_name: Joi.string().allow(""),
+      account_type: Joi.string().allow(""),
+      profile_pic_url: Joi.string().allow(""),
+      has_old_password_hash: Joi.boolean(),
+      user_id: Joi.string().allow(""),
+      application_id: Joi.string().allow(""),
+      is_encrypted: Joi.boolean(),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {CreateUserGroup} */
   static CreateUserGroup() {
     return Joi.object({

package/sdk/platform/Webhook/WebhookPlatformModel.d.ts

@@ -109,6 +109,7 @@ export = WebhookPlatformModel;
  * @property {string} [name] - The name of the subscriber.
  * @property {string} [provider] - The provider of the subscriber.
  * @property {string} [webhook_url] - The URL for the subscriber's webhook.
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {AssociationResp} [association]
  * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
@@ -195,6 +196,7 @@ export = WebhookPlatformModel;
  * @property {AssociationResp} [association]
  * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {string} [email_id] - The email ID associated with the subscriber.
  * @property {string} [updated_on] - The date and time when the subscriber was
  *   last updated.
@@ -590,6 +592,10 @@ type SubscriberDetails = {
      * - The URL for the subscriber's webhook.
      */
     webhook_url?: string;
+    /**
+     * - Source that subscriber belongs to.
+     */
+    source?: string;
     association?: AssociationResp;
     /**
      * - Custom headers for the subscriber.
@@ -820,6 +826,10 @@ type SubscriberConfigResult = {
      */
     custom_headers?: any;
     status?: SubscriberStatus;
+    /**
+     * - Source that subscriber belongs to.
+     */
+    source?: string;
     /**
      * - The email ID associated with the subscriber.
      */

package/sdk/platform/Webhook/WebhookPlatformModel.js

@@ -119,6 +119,7 @@ const Joi = require("joi");
  * @property {string} [name] - The name of the subscriber.
  * @property {string} [provider] - The provider of the subscriber.
  * @property {string} [webhook_url] - The URL for the subscriber's webhook.
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {AssociationResp} [association]
  * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
@@ -211,6 +212,7 @@ const Joi = require("joi");
  * @property {AssociationResp} [association]
  * @property {Object} [custom_headers] - Custom headers for the subscriber.
  * @property {SubscriberStatus} [status]
+ * @property {string} [source] - Source that subscriber belongs to.
  * @property {string} [email_id] - The email ID associated with the subscriber.
  * @property {string} [updated_on] - The date and time when the subscriber was
  *   last updated.
@@ -458,6 +460,7 @@ class WebhookPlatformModel {
       name: Joi.string().allow(""),
       provider: Joi.string().allow(""),
       webhook_url: Joi.string().allow(""),
+      source: Joi.string().allow("").allow(null),
       association: WebhookPlatformModel.AssociationResp(),
       custom_headers: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
       status: WebhookPlatformModel.SubscriberStatus(),
@@ -557,6 +560,7 @@ class WebhookPlatformModel {
       association: WebhookPlatformModel.AssociationResp(),
       custom_headers: Joi.object().pattern(/\S/, Joi.any()),
       status: WebhookPlatformModel.SubscriberStatus(),
+      source: Joi.string().allow("").allow(null),
       email_id: Joi.string().allow(""),
       updated_on: Joi.string().allow(""),
       created_on: Joi.string().allow(""),