@gofynd/fdk-client-javascript 1.3.3 → 1.3.4-beta.1

package/README.md

@@ -214,7 +214,7 @@ console.log("Active Theme: ", response.information.name);
 The above code will log the curl command in the console
 
 ```bash
-curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.3' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
+curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.3.4-beta.1' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
 Active Theme: Emerge
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gofynd/fdk-client-javascript",
-  "version": "1.3.3",
+  "version": "1.3.4-beta.1",
   "description": "",
   "main": "index.js",
   "scripts": {

package/sdk/common/AxiosHelper.js

@@ -136,6 +136,11 @@ fdkAxios.interceptors.response.use(
         level: "ERROR",
         message: error.response.data || error.message,
         stack: error.response.data.stack || error.stack,
+        request: {
+          method: error.config.method,
+          url: error.config.url,
+          headers: error.config.headers,
+        },
       });
       throw new FDKServerResponseError(
         error.response.data.message || error.message,
@@ -150,6 +155,11 @@ fdkAxios.interceptors.response.use(
         level: "ERROR",
         message: error.data || error.message,
         stack: error.data.stack || error.stack,
+        request: {
+          method: error.config.method,
+          url: error.config.url,
+          headers: error.config.headers,
+        },
       });
       throw new FDKServerResponseError(
         error.message,

package/sdk/partner/PartnerConfig.js

@@ -29,11 +29,9 @@ class PartnerConfig {
     this.domain = config.domain || "https://api.fynd.com";
     this.apiKey = config.apiKey;
     this.apiSecret = config.apiSecret;
-    (this.scope = config.scope),
-      (this.useAutoRenewTimer =
-        config.useAutoRenewTimer !== undefined
-          ? config.useAutoRenewTimer
-          : true);
+    this.scope = config.scope;
+    this.useAutoRenewTimer =
+      config.useAutoRenewTimer !== undefined ? config.useAutoRenewTimer : true;
     this.oauthClient = new OauthClient(this);
     this.logLevel = config.logLevel || "ERROR";
     this.setLogLevel(this.logLevel);

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

@@ -181,6 +181,18 @@ declare class User {
      * @description: Use this API to update an existing user Group - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroup/).
      */
     updateUserGroup({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
+    /**
+     * @param {UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
+     * @name updateUserGroupPartially
+     * @summary: Add or Remove an user from particular user group and update user group details
+     * @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
+     */
+    updateUserGroupPartially({ groupId, body, requestHeaders }?: UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupResponseSchema>;
 }
 import UserPlatformApplicationValidator = require("./UserPlatformApplicationValidator");
 import UserPlatformModel = require("./UserPlatformModel");

package/sdk/platform/User/UserPlatformApplicationClient.js

@@ -1316,6 +1316,85 @@ class User {
 
     return response;
   }
+
+  /**
+   * @param {UserPlatformApplicationValidator.UpdateUserGroupPartiallyParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<UserPlatformModel.UserGroupResponseSchema>} - Success response
+   * @name updateUserGroupPartially
+   * @summary: Add or Remove an user from particular user group and update user group details
+   * @description: Use this API to update user group details and add or remove an user to the user group. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/updateUserGroupPartially/).
+   */
+  async updateUserGroupPartially(
+    { groupId, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = UserPlatformApplicationValidator.updateUserGroupPartially().validate(
+      {
+        groupId,
+        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.updateUserGroupPartially().validate(
+      {
+        groupId,
+        body,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > User > updateUserGroupPartially \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/platform/user/v1.0/company/${this.config.companyId}/application/${this.applicationId}/user_group/${groupId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const {
+      error: res_error,
+    } = UserPlatformModel.UserGroupResponseSchema().validate(responseData, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
+
+    if (res_error) {
+      Logger({
+        level: "WARN",
+        message: `Response Validation Warnnings for platform > User > updateUserGroupPartially \n ${res_error}`,
+      });
+    }
+
+    return response;
+  }
 }
 
 module.exports = User;

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

@@ -80,6 +80,11 @@ export = UserPlatformApplicationValidator;
  * @property {string} groupId - Numeric ID allotted to a User Group
  * @property {UserPlatformModel.UpdateUserGroupSchema} body
  */
+/**
+ * @typedef UpdateUserGroupPartiallyParam
+ * @property {string} groupId - Numeric ID allotted to a User Group
+ * @property {UserPlatformModel.PartialUserGroupUpdateSchema} body
+ */
 declare class UserPlatformApplicationValidator {
     /** @returns {ArchiveUserParam} */
     static archiveUser(): ArchiveUserParam;
@@ -115,9 +120,11 @@ declare class UserPlatformApplicationValidator {
     static updateUser(): UpdateUserParam;
     /** @returns {UpdateUserGroupParam} */
     static updateUserGroup(): UpdateUserGroupParam;
+    /** @returns {UpdateUserGroupPartiallyParam} */
+    static updateUserGroupPartially(): UpdateUserGroupPartiallyParam;
 }
 declare namespace UserPlatformApplicationValidator {
-    export { ArchiveUserParam, BlockOrUnblockUsersParam, CreateUserParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserGroupByIdParam, GetUserGroupsParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserGroupParam };
+    export { ArchiveUserParam, BlockOrUnblockUsersParam, CreateUserParam, CreateUserGroupParam, CreateUserSessionParam, DeleteActiveSessionsParam, DeleteSessionParam, GetActiveSessionsParam, GetCustomersParam, GetPlatformConfigParam, GetUserGroupByIdParam, GetUserGroupsParam, SearchUsersParam, UnDeleteUserParam, UpdatePlatformConfigParam, UpdateUserParam, UpdateUserGroupParam, UpdateUserGroupPartiallyParam };
 }
 type ArchiveUserParam = {
     body: UserPlatformModel.ArchiveUserRequestSchema;
@@ -240,5 +247,12 @@ type UpdateUserGroupParam = {
     groupId: string;
     body: UserPlatformModel.UpdateUserGroupSchema;
 };
+type UpdateUserGroupPartiallyParam = {
+    /**
+     * - Numeric ID allotted to a User Group
+     */
+    groupId: string;
+    body: UserPlatformModel.PartialUserGroupUpdateSchema;
+};
 type GetPlatformConfigParam = any;
 import UserPlatformModel = require("./UserPlatformModel");

package/sdk/platform/User/UserPlatformApplicationValidator.js

@@ -100,6 +100,12 @@ const UserPlatformModel = require("./UserPlatformModel");
  * @property {UserPlatformModel.UpdateUserGroupSchema} body
  */
 
+/**
+ * @typedef UpdateUserGroupPartiallyParam
+ * @property {string} groupId - Numeric ID allotted to a User Group
+ * @property {UserPlatformModel.PartialUserGroupUpdateSchema} body
+ */
+
 class UserPlatformApplicationValidator {
   /** @returns {ArchiveUserParam} */
   static archiveUser() {
@@ -229,6 +235,14 @@ class UserPlatformApplicationValidator {
       body: UserPlatformModel.UpdateUserGroupSchema().required(),
     }).required();
   }
+
+  /** @returns {UpdateUserGroupPartiallyParam} */
+  static updateUserGroupPartially() {
+    return Joi.object({
+      groupId: Joi.string().allow("").required(),
+      body: UserPlatformModel.PartialUserGroupUpdateSchema().required(),
+    }).required();
+  }
 }
 
 module.exports = UserPlatformApplicationValidator;

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

@@ -117,6 +117,20 @@ export = UserPlatformModel;
  * @property {number} [size]
  * @property {string} [type]
  */
+/**
+ * @typedef PartialUserGroupUpdateSchema
+ * @property {string} [description]
+ * @property {string} [file_url] - Required property when passed type file_url.
+ *   Internet reachable csv file url which will be used to fetch download data.
+ *   It must have one of columns from `phone_number``, `email`, `user_id` and
+ *   must have `action` column. `action` column can have `add` or `remove` value.
+ * @property {string} [name]
+ * @property {string} [type] - Source of update to be used to update individual
+ *   users. Default value is considered file_url if not passed.
+ * @property {UserGroupUpdateData[]} [user_data] - Required property when passed
+ *   type json. Array of user data. Must have `action` field and one of
+ *   `phone_number`, `email` or `user_id` field in object
+ */
 /**
  * @typedef PhoneNumber
  * @property {boolean} [active]
@@ -269,6 +283,13 @@ export = UserPlatformModel;
  * @property {string} [status]
  * @property {number} [uid]
  */
+/**
+ * @typedef UserGroupUpdateData
+ * @property {string} action
+ * @property {string} [email] - Email of registered user
+ * @property {string} [phone_number] - Phone number of registered user
+ * @property {string} [user_id] - Must be valid mongodb objectid of existing user
+ */
 /**
  * @typedef UserPhoneNumbers
  * @property {boolean} [active]
@@ -303,7 +324,7 @@ export = UserPlatformModel;
 declare class UserPlatformModel {
 }
 declare namespace UserPlatformModel {
-    export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, CreateUserGroupSchema, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, Social, SocialTokens, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserPhoneNumbers, UserSchema, UserSearchResponseSchema };
+    export { Accountkit, ArchiveUserRequestSchema, ArchiveUserSuccess, AuthenticationApiErrorSchema, BlockUserRequestSchema, BlockUserSuccess, CreateUserGroupSchema, CreateUserRequestSchema, CreateUserResponseSchema, CreateUserSessionRequestSchema, CreateUserSessionResponseSchema, CustomerListResponseSchema, DeleteAccountConsent, DeleteAccountReasons, Email, Facebook, FlashCard, Google, Login, LookAndFeel, MetaSchema, PaginationSchema, PartialUserGroupUpdateSchema, PhoneNumber, PlatformEmail, PlatformMobile, PlatformSchema, RegisterRequiredFields, RegisterRequiredFieldsEmail, RegisterRequiredFieldsMobile, RequiredFields, SessionDeleteResponseSchema, SessionExpiry, SessionListResponseInfo, SessionListResponseSchema, Social, SocialTokens, UnDeleteUserRequestSchema, UnDeleteUserSuccess, UpdateUserGroupSchema, UpdateUserRequestSchema, UserEmails, UserGroupListResponseSchema, UserGroupResponseSchema, UserGroupUpdateData, UserPhoneNumbers, UserSchema, UserSearchResponseSchema };
 }
 /** @returns {Accountkit} */
 declare function Accountkit(): Accountkit;
@@ -445,6 +466,30 @@ type PaginationSchema = {
     size?: number;
     type?: string;
 };
+/** @returns {PartialUserGroupUpdateSchema} */
+declare function PartialUserGroupUpdateSchema(): PartialUserGroupUpdateSchema;
+type PartialUserGroupUpdateSchema = {
+    description?: string;
+    /**
+     * - Required property when passed type file_url.
+     * Internet reachable csv file url which will be used to fetch download data.
+     * It must have one of columns from `phone_number``, `email`, `user_id` and
+     * must have `action` column. `action` column can have `add` or `remove` value.
+     */
+    file_url?: string;
+    name?: string;
+    /**
+     * - Source of update to be used to update individual
+     * users. Default value is considered file_url if not passed.
+     */
+    type?: string;
+    /**
+     * - Required property when passed
+     * type json. Array of user data. Must have `action` field and one of
+     * `phone_number`, `email` or `user_id` field in object
+     */
+    user_data?: UserGroupUpdateData[];
+};
 /** @returns {PhoneNumber} */
 declare function PhoneNumber(): PhoneNumber;
 type PhoneNumber = {
@@ -618,6 +663,23 @@ type UserGroupResponseSchema = {
     status?: string;
     uid?: number;
 };
+/** @returns {UserGroupUpdateData} */
+declare function UserGroupUpdateData(): UserGroupUpdateData;
+type UserGroupUpdateData = {
+    action: string;
+    /**
+     * - Email of registered user
+     */
+    email?: string;
+    /**
+     * - Phone number of registered user
+     */
+    phone_number?: string;
+    /**
+     * - Must be valid mongodb objectid of existing user
+     */
+    user_id?: string;
+};
 /** @returns {UserPhoneNumbers} */
 declare function UserPhoneNumbers(): UserPhoneNumbers;
 type UserPhoneNumbers = {

package/sdk/platform/User/UserPlatformModel.js

@@ -140,6 +140,21 @@ const Joi = require("joi");
  * @property {string} [type]
  */
 
+/**
+ * @typedef PartialUserGroupUpdateSchema
+ * @property {string} [description]
+ * @property {string} [file_url] - Required property when passed type file_url.
+ *   Internet reachable csv file url which will be used to fetch download data.
+ *   It must have one of columns from `phone_number``, `email`, `user_id` and
+ *   must have `action` column. `action` column can have `add` or `remove` value.
+ * @property {string} [name]
+ * @property {string} [type] - Source of update to be used to update individual
+ *   users. Default value is considered file_url if not passed.
+ * @property {UserGroupUpdateData[]} [user_data] - Required property when passed
+ *   type json. Array of user data. Must have `action` field and one of
+ *   `phone_number`, `email` or `user_id` field in object
+ */
+
 /**
  * @typedef PhoneNumber
  * @property {boolean} [active]
@@ -313,6 +328,14 @@ const Joi = require("joi");
  * @property {number} [uid]
  */
 
+/**
+ * @typedef UserGroupUpdateData
+ * @property {string} action
+ * @property {string} [email] - Email of registered user
+ * @property {string} [phone_number] - Phone number of registered user
+ * @property {string} [user_id] - Must be valid mongodb objectid of existing user
+ */
+
 /**
  * @typedef UserPhoneNumbers
  * @property {boolean} [active]
@@ -532,6 +555,17 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {PartialUserGroupUpdateSchema} */
+  static PartialUserGroupUpdateSchema() {
+    return Joi.object({
+      description: Joi.string().allow(""),
+      file_url: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      user_data: Joi.array().items(UserPlatformModel.UserGroupUpdateData()),
+    });
+  }
+
   /** @returns {PhoneNumber} */
   static PhoneNumber() {
     return Joi.object({
@@ -749,6 +783,16 @@ class UserPlatformModel {
     });
   }
 
+  /** @returns {UserGroupUpdateData} */
+  static UserGroupUpdateData() {
+    return Joi.object({
+      action: Joi.string().allow("").required(),
+      email: Joi.string().allow(""),
+      phone_number: Joi.string().allow(""),
+      user_id: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {UserPhoneNumbers} */
   static UserPhoneNumbers() {
     return Joi.object({