@gofynd/fdk-client-javascript 3.3.6 → 3.4.0

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts

@@ -104,6 +104,8 @@ export = ServiceabilityPlatformValidator;
  *   certain capabilities.
  * @property {string[]} [schemeIds] - List of scheme ids which need to be
  *   returned in the response.
+ * @property {string} [q] - The search string to search in the list of courier
+ *   partners schemes by name.
  */
 /**
  * @typedef GetInstalledCourierPartnerExtensionsParam
@@ -147,6 +149,7 @@ export = ServiceabilityPlatformValidator;
  */
 /**
  * @typedef UpdateCompanyConfigurationParam
+ * @property {string} fulfillmentOptionSlug - Slug representing the fulfillment option.
  * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
  */
 /**
@@ -469,6 +472,11 @@ type GetCourierPartnerSchemesParam = {
      * returned in the response.
      */
     schemeIds?: string[];
+    /**
+     * - The search string to search in the list of courier
+     * partners schemes by name.
+     */
+    q?: string;
 };
 type GetInstalledCourierPartnerExtensionsParam = {
     /**
@@ -542,6 +550,10 @@ type SampleFileServiceabilityParam = {
     body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
 };
 type UpdateCompanyConfigurationParam = {
+    /**
+     * - Slug representing the fulfillment option.
+     */
+    fulfillmentOptionSlug: string;
     body: ServiceabilityPlatformModel.CompanyConfigurationSchema;
 };
 type UpdateCourierPartnerAccountParam = {

package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js

@@ -120,6 +120,8 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
  *   certain capabilities.
  * @property {string[]} [schemeIds] - List of scheme ids which need to be
  *   returned in the response.
+ * @property {string} [q] - The search string to search in the list of courier
+ *   partners schemes by name.
  */
 
 /**
@@ -172,6 +174,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
 
 /**
  * @typedef UpdateCompanyConfigurationParam
+ * @property {string} fulfillmentOptionSlug - Slug representing the fulfillment option.
  * @property {ServiceabilityPlatformModel.CompanyConfigurationSchema} body
  */
 
@@ -341,6 +344,7 @@ class ServiceabilityPlatformValidator {
       paymentMode: Joi.string().allow(""),
       capabilities: Joi.array().items(Joi.string().allow("")),
       schemeIds: Joi.array().items(Joi.string().allow("")),
+      q: Joi.string().allow(""),
     }).required();
   }
 
@@ -409,6 +413,7 @@ class ServiceabilityPlatformValidator {
   /** @returns {UpdateCompanyConfigurationParam} */
   static updateCompanyConfiguration() {
     return Joi.object({
+      fulfillmentOptionSlug: Joi.string().allow("").required(),
       body: ServiceabilityPlatformModel.CompanyConfigurationSchema().required(),
     }).required();
   }

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

@@ -137,6 +137,30 @@ declare class User {
      * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributeDefinitionById/).
      */
     deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
+    /**
+     * @param {UserPlatformApplicationValidator.DeleteUserAttributesInBulkParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+     * @name deleteUserAttributesInBulk
+     * @summary: Delete User Attribute Values in Bulk
+     * @description: This request deletes attribute values for a single user based on the provided user attribute definition. Each user attribute definition represents a distinct attribute, and for each definition, a user can have one corresponding value. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributesInBulk/).
+     */
+    deleteUserAttributesInBulk({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributesInBulkParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
+    /**
+     * @param {UserPlatformApplicationValidator.FilterUsersByAttributesParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.UserAttributeFiltered>} - Success response
+     * @name filterUsersByAttributes
+     * @summary: Filter Users by Attribute Conditions
+     * @description: Returns a filtered list of users based on user attribute conditions and along with details of definition Ids. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/filterUsersByAttributes/).
+     */
+    filterUsersByAttributes({ body, requestHeaders }?: UserPlatformApplicationValidator.FilterUsersByAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeFiltered>;
     /**
      * @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -359,6 +383,18 @@ declare class User {
      * @description: Update an existing user attribute definition. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributeDefinition/).
      */
     updateUserAttributeDefinition({ attributeDefId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinition>;
+    /**
+     * @param {UserPlatformApplicationValidator.UpdateUserAttributesParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.BulkUserAttribute>} - Success response
+     * @name updateUserAttributes
+     * @summary: Create Or Update User Attribute
+     * @description: This API is used to create or update multiple user attribute values for the specified user ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributes/).
+     */
+    updateUserAttributes({ userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributesParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkUserAttribute>;
     /**
      * @param {UserPlatformApplicationValidator.UpdateUserGroupParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -974,6 +974,172 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.DeleteUserAttributesInBulkParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+   * @name deleteUserAttributesInBulk
+   * @summary: Delete User Attribute Values in Bulk
+   * @description: This request deletes attribute values for a single user based on the provided user attribute definition. Each user attribute definition represents a distinct attribute, and for each definition, a user can have one corresponding value. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/deleteUserAttributesInBulk/).
+   */
+  async deleteUserAttributesInBulk(
+    { userId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.deleteUserAttributesInBulk().validate(
+      {
+        userId,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.deleteUserAttributesInBulk().validate(
+      {
+        userId,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > deleteUserAttributesInBulk \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user_attribute/user/${userId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.SuccessMessage().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > User > deleteUserAttributesInBulk \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {UserPlatformApplicationValidator.FilterUsersByAttributesParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.UserAttributeFiltered>} - Success response
+   * @name filterUsersByAttributes
+   * @summary: Filter Users by Attribute Conditions
+   * @description: Returns a filtered list of users based on user attribute conditions and along with details of definition Ids. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/filterUsersByAttributes/).
+   */
+  async filterUsersByAttributes(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.filterUsersByAttributes().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.filterUsersByAttributes().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > filterUsersByAttributes \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user_attribute/users`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.UserAttributeFiltered().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > User > filterUsersByAttributes \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2696,6 +2862,91 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.UpdateUserAttributesParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkUserAttribute>} - Success response
+   * @name updateUserAttributes
+   * @summary: Create Or Update User Attribute
+   * @description: This API is used to create or update multiple user attribute values for the specified user ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/user/updateUserAttributes/).
+   */
+  async updateUserAttributes(
+    { userId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.updateUserAttributes().validate(
+      {
+        userId,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.updateUserAttributes().validate(
+      {
+        userId,
+
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > updateUserAttributes \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "post",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user_attribute/user/${userId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkUserAttribute().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: true,
+    });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > User > updateUserAttributes \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.UpdateUserGroupParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -52,6 +52,15 @@ 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 FilterUsersByAttributesParam
+ * @property {UserPlatformModel.UserAttributeFilter} body
+ */
 /**
  * @typedef GetActiveSessionsParam
  * @property {string} id - ID of a customer.
@@ -178,6 +187,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
@@ -213,6 +227,10 @@ declare class UserPlatformApplicationValidator {
     static deleteUserAttribute(): DeleteUserAttributeParam;
     /** @returns {DeleteUserAttributeDefinitionByIdParam} */
     static deleteUserAttributeDefinitionById(): DeleteUserAttributeDefinitionByIdParam;
+    /** @returns {DeleteUserAttributesInBulkParam} */
+    static deleteUserAttributesInBulk(): DeleteUserAttributesInBulkParam;
+    /** @returns {FilterUsersByAttributesParam} */
+    static filterUsersByAttributes(): FilterUsersByAttributesParam;
     /** @returns {GetActiveSessionsParam} */
     static getActiveSessions(): GetActiveSessionsParam;
     /** @returns {GetBulkExportUsersListParam} */
@@ -253,13 +271,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, 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 };
+    export { ArchiveUserParam, BlockOrUnblockUsersParam, BulkImportStoreFrontUsersParam, CreateBulkExportUsersParam, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, DeleteUserAttributesInBulkParam, 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;
@@ -326,6 +346,16 @@ type DeleteUserAttributeDefinitionByIdParam = {
      */
     attributeDefId: string;
 };
+type DeleteUserAttributesInBulkParam = {
+    /**
+     * - The unique identifier of the user to update.
+     */
+    userId: string;
+    body: UserPlatformModel.DeleteBulkUserAttribute;
+};
+type FilterUsersByAttributesParam = {
+    body: UserPlatformModel.UserAttributeFilter;
+};
 type GetActiveSessionsParam = {
     /**
      * - ID of a customer.
@@ -585,6 +615,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

@@ -67,6 +67,17 @@ 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 FilterUsersByAttributesParam
+ * @property {UserPlatformModel.UserAttributeFilter} body
+ */
+
 /**
  * @typedef GetActiveSessionsParam
  * @property {string} id - ID of a customer.
@@ -213,6 +224,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
@@ -314,6 +331,22 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {DeleteUserAttributesInBulkParam} */
+  static deleteUserAttributesInBulk() {
+    return Joi.object({
+      userId: Joi.string().allow("").required(),
+
+      body: UserPlatformModel.DeleteBulkUserAttribute().required(),
+    }).required();
+  }
+
+  /** @returns {FilterUsersByAttributesParam} */
+  static filterUsersByAttributes() {
+    return Joi.object({
+      body: UserPlatformModel.UserAttributeFilter().required(),
+    }).required();
+  }
+
   /** @returns {GetActiveSessionsParam} */
   static getActiveSessions() {
     return Joi.object({
@@ -493,6 +526,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({