@gofynd/fdk-client-javascript 1.6.3 → 3.0.0-beta.1

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

@@ -39,13 +39,13 @@ declare class User {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.UserAttributeDefinitionDetails>} -
+     * @returns {Promise<UserPlatformModel.UserAttributeDefinitionResponse>} -
      *   Success response
      * @name createUserAttributeDefinition
      * @summary: Create a User Attribute Definition
      * @description: Create a new User Attribute Definition - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createUserAttributeDefinition/).
      */
-    createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionDetails>;
+    createUserAttributeDefinition({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateUserAttributeDefinitionParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeDefinitionResponse>;
     /**
      * @param {UserPlatformApplicationValidator.CreateUserGroupParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -95,24 +95,24 @@ declare class User {
      * @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+     * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
      * @name deleteUserAttribute
      * @summary: Delete User Attribute
      * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
      */
-    deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
+    deleteUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessageResponse>;
     /**
      * @param {UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+     * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
      * @name deleteUserAttributeDefinitionById
      * @summary: Delete User Attribute Definition
      * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
      */
-    deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessage>;
+    deleteUserAttributeDefinitionById({ attributeDefId, requestHeaders }?: UserPlatformApplicationValidator.DeleteUserAttributeDefinitionByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.SuccessMessageResponse>;
     /**
      * @param {UserPlatformApplicationValidator.GetActiveSessionsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -147,24 +147,24 @@ declare class User {
      * @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+     * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
      * @name getUserAttribute
      * @summary: Get User Attribute
      * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
      */
-    getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
+    getUserAttribute({ attributeDefId, userId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
     /**
      * @param {UserPlatformApplicationValidator.GetUserAttributeByIdParam} arg
      *   - Arg object
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+     * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
      * @name getUserAttributeById
      * @summary: Get User Attribute
      * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
      */
-    getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
+    getUserAttributeById({ attributeId, requestHeaders }?: UserPlatformApplicationValidator.GetUserAttributeByIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
     /**
      * @param {UserPlatformApplicationValidator.GetUserAttributeDefinitionByIdParam} arg
      *   - Arg object
@@ -222,6 +222,16 @@ declare class User {
      * @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
      */
     getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.GetUsersByByGroupIdParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
+     * @name getUsersByByGroupId
+     * @summary: Get users belonging to user group by Id
+     * @description: Use this API to users belonging to user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersByByGroupId/).
+     */
+    getUsersByByGroupId({ groupId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersByByGroupIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.CustomerListResponseSchema>;
     /**
      * @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -268,12 +278,12 @@ declare class User {
      * @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+     * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
      * @name updateUserAttribute
      * @summary: Update Or Create User Attribute
      * @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
      */
-    updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttribute>;
+    updateUserAttribute({ attributeDefId, userId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserAttributeParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserAttributeResponse>;
     /**
      * @param {UserPlatformApplicationValidator.UpdateUserAttributeDefinitionParam} arg
      *   - Arg object

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -254,7 +254,7 @@ class User {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.UserAttributeDefinitionDetails>} -
+   * @returns {Promise<UserPlatformModel.UserAttributeDefinitionResponse>} -
    *   Success response
    * @name createUserAttributeDefinition
    * @summary: Create a User Attribute Definition
@@ -311,7 +311,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.UserAttributeDefinitionDetails().validate(
+    } = UserPlatformModel.UserAttributeDefinitionResponse().validate(
       responseData,
       { abortEarly: false, allowUnknown: true }
     );
@@ -664,7 +664,7 @@ class User {
    * @param {UserPlatformApplicationValidator.DeleteUserAttributeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+   * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
    * @name deleteUserAttribute
    * @summary: Delete User Attribute
    * @description: Delete User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttribute/).
@@ -716,7 +716,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.SuccessMessage().validate(responseData, {
+    } = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -741,7 +741,7 @@ class User {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.SuccessMessage>} - Success response
+   * @returns {Promise<UserPlatformModel.SuccessMessageResponse>} - Success response
    * @name deleteUserAttributeDefinitionById
    * @summary: Delete User Attribute Definition
    * @description: Delete a user attribute definition by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/deleteUserAttributeDefinitionById/).
@@ -793,7 +793,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.SuccessMessage().validate(responseData, {
+    } = UserPlatformModel.SuccessMessageResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1055,7 +1055,7 @@ class User {
    * @param {UserPlatformApplicationValidator.GetUserAttributeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+   * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
    * @name getUserAttribute
    * @summary: Get User Attribute
    * @description: Get User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttribute/).
@@ -1107,7 +1107,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.UserAttribute().validate(responseData, {
+    } = UserPlatformModel.UserAttributeResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1132,7 +1132,7 @@ class User {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+   * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
    * @name getUserAttributeById
    * @summary: Get User Attribute
    * @description: Retrieve User Attribute details by ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserAttributeById/).
@@ -1184,7 +1184,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.UserAttribute().validate(responseData, {
+    } = UserPlatformModel.UserAttributeResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -1665,6 +1665,85 @@ class User {
     return response;
   }
 
+  /**
+   * @param {UserPlatformApplicationValidator.GetUsersByByGroupIdParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.CustomerListResponseSchema>} - Success response
+   * @name getUsersByByGroupId
+   * @summary: Get users belonging to user group by Id
+   * @description: Use this API to users belonging to user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersByByGroupId/).
+   */
+  async getUsersByByGroupId(
+    { groupId, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.getUsersByByGroupId().validate(
+      {
+        groupId,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = UserPlatformApplicationValidator.getUsersByByGroupId().validate(
+      {
+        groupId,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > getUsersByByGroupId \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}/user_group/${groupId}/users`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.CustomerListResponseSchema().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 > getUsersByByGroupId \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -1987,7 +2066,7 @@ class User {
    * @param {UserPlatformApplicationValidator.UpdateUserAttributeParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<UserPlatformModel.UserAttribute>} - Success response
+   * @returns {Promise<UserPlatformModel.UserAttributeResponse>} - Success response
    * @name updateUserAttribute
    * @summary: Update Or Create User Attribute
    * @description: Update Or Create User Attribute - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserAttribute/).
@@ -2049,7 +2128,7 @@ class User {
 
     const {
       error: res_error,
-    } = UserPlatformModel.UserAttribute().validate(responseData, {
+    } = UserPlatformModel.UserAttributeResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -109,6 +109,10 @@ export = UserPlatformApplicationValidator;
  * @property {string} [status] - To get User Groups with given status
  * @property {number} [groupUid] - To get User Groups with given uid
  */
+/**
+ * @typedef GetUsersByByGroupIdParam
+ * @property {string} groupId - Numeric ID allotted to a User Group
+ */
 /**
  * @typedef SearchUsersParam
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -133,7 +137,7 @@ export = UserPlatformApplicationValidator;
  * @property {string} attributeDefId - The unique identifier of the attribute
  *   definition to update.
  * @property {string} userId - The unique identifier of the user to update.
- * @property {UserPlatformModel.CreateUserAttribute} body
+ * @property {UserPlatformModel.CreateUserAttributeRequest} body
  */
 /**
  * @typedef UpdateUserAttributeDefinitionParam
@@ -192,6 +196,8 @@ declare class UserPlatformApplicationValidator {
     static getUserGroupById(): GetUserGroupByIdParam;
     /** @returns {GetUserGroupsParam} */
     static getUserGroups(): GetUserGroupsParam;
+    /** @returns {GetUsersByByGroupIdParam} */
+    static getUsersByByGroupId(): GetUsersByByGroupIdParam;
     /** @returns {SearchUsersParam} */
     static searchUsers(): SearchUsersParam;
     /** @returns {UnDeleteUserParam} */
@@ -210,7 +216,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, CreateUserParam, CreateUserAttributeDefinitionParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, DeleteUserAttributeParam, DeleteUserAttributeDefinitionByIdParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserAttributeParam, GetUserAttributeByIdParam, GetUserAttributeDefinitionByIdParam, GetUserAttributeDefinitionsParam, GetUserAttributesForUserParam, GetUserGroupByIdParam, GetUserGroupsParam, GetUsersByByGroupIdParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserAttributeParam, UpdateUserAttributeDefinitionParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -413,6 +419,12 @@ type GetUserGroupsParam = {
      */
     groupUid?: number;
 };
+type GetUsersByByGroupIdParam = {
+    /**
+     * - Numeric ID allotted to a User Group
+     */
+    groupId: string;
+};
 type SearchUsersParam = {
     /**
      * - The search query. Mobile number or email ID of a customer.
@@ -447,7 +459,7 @@ type UpdateUserAttributeParam = {
      * - The unique identifier of the user to update.
      */
     userId: string;
-    body: UserPlatformModel.CreateUserAttribute;
+    body: UserPlatformModel.CreateUserAttributeRequest;
 };
 type UpdateUserAttributeDefinitionParam = {
     /**

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -132,6 +132,11 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {number} [groupUid] - To get User Groups with given uid
  */
 
+/**
+ * @typedef GetUsersByByGroupIdParam
+ * @property {string} groupId - Numeric ID allotted to a User Group
+ */
+
 /**
  * @typedef SearchUsersParam
  * @property {string} [q] - The search query. Mobile number or email ID of a customer.
@@ -160,7 +165,7 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {string} attributeDefId - The unique identifier of the attribute
  *   definition to update.
  * @property {string} userId - The unique identifier of the user to update.
- * @property {UserPlatformModel.CreateUserAttribute} body
+ * @property {UserPlatformModel.CreateUserAttributeRequest} body
  */
 
 /**
@@ -347,6 +352,13 @@ class UserPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {GetUsersByByGroupIdParam} */
+  static getUsersByByGroupId() {
+    return Joi.object({
+      groupId: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {SearchUsersParam} */
   static searchUsers() {
     return Joi.object({
@@ -383,7 +395,7 @@ class UserPlatformApplicationValidator {
       attributeDefId: Joi.string().allow("").required(),
       userId: Joi.string().allow("").required(),
 
-      body: UserPlatformModel.CreateUserAttribute().required(),
+      body: UserPlatformModel.CreateUserAttributeRequest().required(),
     }).required();
   }