@gofynd/fdk-client-javascript 1.6.3 → 1.6.4

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -171,6 +171,168 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
+   * @name bulkImportStoreFrontUsers
+   * @summary: Bulk import storefront customers using CSV and XLSX files.
+   * @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/bulkImportStoreFrontUsers/).
+   */
+  async bulkImportStoreFrontUsers(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.bulkImportStoreFrontUsers().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.bulkImportStoreFrontUsers().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > bulkImportStoreFrontUsers \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}/users/jobs/import`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkActionModel().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 > bulkImportStoreFrontUsers \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {UserPlatformApplicationValidator.CreateBulkExportUsersParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
+   * @name createBulkExportUsers
+   * @summary: Bulk export storefront customers using CSV and XLSX files.
+   * @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createBulkExportUsers/).
+   */
+  async createBulkExportUsers(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.createBulkExportUsers().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.createBulkExportUsers().validate(
+      {
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > createBulkExportUsers \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}/users/jobs/export`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkActionModel().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 > createBulkExportUsers \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.CreateUserParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -892,6 +1054,228 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.GetBulkExportUsersListParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
+   * @name getBulkExportUsersList
+   * @summary: Get Bulk User's Export Lists for a specific Application.
+   * @description: This API allows fetching the list of bulk user exports for a specific application and company.
+   * It supports pagination and filtering based on various parameters.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkExportUsersList/).
+   */
+  async getBulkExportUsersList(
+    {
+      pageNo,
+      pageSize,
+      fileFormat,
+      search,
+      startDate,
+      endDate,
+      status,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.getBulkExportUsersList().validate(
+      {
+        pageNo,
+        pageSize,
+        fileFormat,
+        search,
+        startDate,
+        endDate,
+        status,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.getBulkExportUsersList().validate(
+      {
+        pageNo,
+        pageSize,
+        fileFormat,
+        search,
+        startDate,
+        endDate,
+        status,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > getBulkExportUsersList \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["file_format"] = fileFormat;
+    query_params["search"] = search;
+    query_params["start_date"] = startDate;
+    query_params["end_date"] = endDate;
+    query_params["status"] = status;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/jobs/export`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkActionPaginationSchema().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 > getBulkExportUsersList \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * @param {UserPlatformApplicationValidator.GetBulkImportUsersListParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
+   * @name getBulkImportUsersList
+   * @summary: Get Bulk User's Import Lists for a specific Application.
+   * @description: This API allows fetching the list of bulk user imports for a specific application and company.
+   * It supports pagination and filtering based on various parameters.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkImportUsersList/).
+   */
+  async getBulkImportUsersList(
+    {
+      pageNo,
+      pageSize,
+      search,
+      startDate,
+      endDate,
+      status,
+      fileFormat,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.getBulkImportUsersList().validate(
+      {
+        pageNo,
+        pageSize,
+        search,
+        startDate,
+        endDate,
+        status,
+        fileFormat,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.getBulkImportUsersList().validate(
+      {
+        pageNo,
+        pageSize,
+        search,
+        startDate,
+        endDate,
+        status,
+        fileFormat,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > getBulkImportUsersList \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["page_no"] = pageNo;
+    query_params["page_size"] = pageSize;
+    query_params["search"] = search;
+    query_params["start_date"] = startDate;
+    query_params["end_date"] = endDate;
+    query_params["status"] = status;
+    query_params["file_format"] = fileFormat;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/jobs/import`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkActionPaginationSchema().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 > getBulkImportUsersList \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.GetCustomersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1665,6 +2049,86 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
+   * @name getUsersJobByJobId
+   * @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
+   * @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
+   *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersJobByJobId/).
+   */
+  async getUsersJobByJobId(
+    { jobId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.getUsersJobByJobId().validate(
+      {
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.getUsersJobByJobId().validate(
+      {
+        jobId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > getUsersJobByJobId \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/users/jobs/${jobId}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.BulkActionModel().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 > getUsersJobByJobId \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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,11 @@ export = UserPlatformApplicationValidator;
  * @property {string} [status] - To get User Groups with given status
  * @property {number} [groupUid] - To get User Groups with given uid
  */
+/**
+ * @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 +189,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 +211,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 +233,8 @@ declare class UserPlatformApplicationValidator {
     static getUserGroupById(): GetUserGroupByIdParam;
     /** @returns {GetUserGroupsParam} */
     static getUserGroups(): GetUserGroupsParam;
+    /** @returns {GetUsersJobByJobIdParam} */
+    static getUsersJobByJobId(): GetUsersJobByJobIdParam;
     /** @returns {SearchUsersParam} */
     static searchUsers(): SearchUsersParam;
     /** @returns {UnDeleteUserParam} */
@@ -210,7 +253,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, GetUsersJobByJobIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -218,6 +261,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 +326,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 +522,13 @@ type GetUserGroupsParam = {
      */
     groupUid?: number;
 };
+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.