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

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts

@@ -20,6 +20,11 @@ export = PaymentPlatformApplicationValidator;
  * @typedef ConfirmPaymentParam
  * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
  */
+/**
+ * @typedef CreateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
 /**
  * @typedef CreatePaymentLinkParam
  * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
@@ -55,6 +60,10 @@ export = PaymentPlatformApplicationValidator;
  * @property {string} device
  */
 /** @typedef GetMerchantPaymentOptionParam */
+/**
+ * @typedef GetMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ */
 /** @typedef GetPGConfigAggregatorsParam */
 /** @typedef GetPaymentCodeOptionParam */
 /**
@@ -153,6 +162,11 @@ export = PaymentPlatformApplicationValidator;
  * @typedef UpdateEdcDeviceParam
  * @property {PaymentPlatformModel.EdcAddRequest} body
  */
+/**
+ * @typedef UpdateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
 /**
  * @typedef UpdatePaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -184,6 +198,8 @@ declare class PaymentPlatformApplicationValidator {
     static checkAndUpdatePaymentStatus(): CheckAndUpdatePaymentStatusParam;
     /** @returns {ConfirmPaymentParam} */
     static confirmPayment(): ConfirmPaymentParam;
+    /** @returns {CreateMerchantRefundPriorityParam} */
+    static createMerchantRefundPriority(): CreateMerchantRefundPriorityParam;
     /** @returns {CreatePaymentLinkParam} */
     static createPaymentLink(): CreatePaymentLinkParam;
     /** @returns {EdcAggregatorsAndModelListParam} */
@@ -202,6 +218,8 @@ declare class PaymentPlatformApplicationValidator {
     static getMerchantAggregatorPaymentModeDetails(): GetMerchantAggregatorPaymentModeDetailsParam;
     /** @returns {GetMerchantPaymentOptionParam} */
     static getMerchantPaymentOption(): any;
+    /** @returns {GetMerchantRefundPriorityParam} */
+    static getMerchantRefundPriority(): GetMerchantRefundPriorityParam;
     /** @returns {GetPGConfigAggregatorsParam} */
     static getPGConfigAggregators(): any;
     /** @returns {GetPaymentCodeOptionParam} */
@@ -246,6 +264,8 @@ declare class PaymentPlatformApplicationValidator {
     static setUserCODlimitRoutes(): SetUserCODlimitRoutesParam;
     /** @returns {UpdateEdcDeviceParam} */
     static updateEdcDevice(): UpdateEdcDeviceParam;
+    /** @returns {UpdateMerchantRefundPriorityParam} */
+    static updateMerchantRefundPriority(): UpdateMerchantRefundPriorityParam;
     /** @returns {UpdatePaymentSessionParam} */
     static updatePaymentSession(): UpdatePaymentSessionParam;
     /** @returns {UpdateRefundSessionParam} */
@@ -254,7 +274,7 @@ declare class PaymentPlatformApplicationValidator {
     static verifyCustomerForPayment(): VerifyCustomerForPaymentParam;
 }
 declare namespace PaymentPlatformApplicationValidator {
-    export { AddEdcDeviceParam, AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreatePaymentLinkParam, EdcAggregatorsAndModelListParam, EdcDeviceListParam, EdcDeviceStatsParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetEdcDeviceParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, MerchantOnBoardingParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, RepaymentDetailsParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetUserCODlimitRoutesParam, UpdateEdcDeviceParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, VerifyCustomerForPaymentParam };
+    export { AddEdcDeviceParam, AddRefundBankAccountUsingOTPParam, CancelPaymentLinkParam, CheckAndUpdatePaymentStatusParam, ConfirmPaymentParam, CreateMerchantRefundPriorityParam, CreatePaymentLinkParam, EdcAggregatorsAndModelListParam, EdcDeviceListParam, EdcDeviceStatsParam, GetBankAccountDetailsOpenAPIParam, GetBrandPaymentGatewayConfigParam, GetEdcDeviceParam, GetMerchantAggregatorPaymentModeDetailsParam, GetMerchantPaymentOptionParam, GetMerchantRefundPriorityParam, GetPGConfigAggregatorsParam, GetPaymentCodeOptionParam, GetPaymentLinkParam, GetPaymentModeRoutesParam, GetPosPaymentModeRoutesParam, GetUserBeneficiariesParam, GetUserCODlimitRoutesParam, GetUserOrderBeneficiariesParam, InitialisePaymentParam, MerchantOnBoardingParam, OauthGetUrlParam, PatchMerchantAggregatorPaymentModeDetailsParam, PatchMerchantPaymentOptionParam, PaymentStatusBulkParam, PollingPaymentLinkParam, RepaymentDetailsParam, ResendOrCancelPaymentParam, ResendPaymentLinkParam, RevokeOauthTokenParam, SaveBrandPaymentGatewayConfigParam, SetUserCODlimitRoutesParam, UpdateEdcDeviceParam, UpdateMerchantRefundPriorityParam, UpdatePaymentSessionParam, UpdateRefundSessionParam, VerifyCustomerForPaymentParam };
 }
 type AddEdcDeviceParam = {
     /**
@@ -275,6 +295,13 @@ type CheckAndUpdatePaymentStatusParam = {
 type ConfirmPaymentParam = {
     body: PaymentPlatformModel.PaymentConfirmationRequest;
 };
+type CreateMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
+};
 type CreatePaymentLinkParam = {
     body: PaymentPlatformModel.CreatePaymentLinkRequest;
 };
@@ -310,6 +337,12 @@ type GetMerchantAggregatorPaymentModeDetailsParam = {
     businessUnit: string;
     device: string;
 };
+type GetMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+};
 type GetPaymentLinkParam = {
     paymentLinkId?: string;
 };
@@ -419,6 +452,13 @@ type SetUserCODlimitRoutesParam = {
 type UpdateEdcDeviceParam = {
     body: PaymentPlatformModel.EdcAddRequest;
 };
+type UpdateMerchantRefundPriorityParam = {
+    /**
+     * - Configuration for merchant or customer
+     */
+    configType: string;
+    body: PaymentPlatformModel.RefundPriorityRequestSerializer;
+};
 type UpdatePaymentSessionParam = {
     /**
      * - Global identifier of the entity (e.g. order, cart

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -28,6 +28,12 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {PaymentPlatformModel.PaymentConfirmationRequest} body
  */
 
+/**
+ * @typedef CreateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
+
 /**
  * @typedef CreatePaymentLinkParam
  * @property {PaymentPlatformModel.CreatePaymentLinkRequest} body
@@ -72,6 +78,11 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
 
 /** @typedef GetMerchantPaymentOptionParam */
 
+/**
+ * @typedef GetMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ */
+
 /** @typedef GetPGConfigAggregatorsParam */
 
 /** @typedef GetPaymentCodeOptionParam */
@@ -192,6 +203,12 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {PaymentPlatformModel.EdcAddRequest} body
  */
 
+/**
+ * @typedef UpdateMerchantRefundPriorityParam
+ * @property {string} configType - Configuration for merchant or customer
+ * @property {PaymentPlatformModel.RefundPriorityRequestSerializer} body
+ */
+
 /**
  * @typedef UpdatePaymentSessionParam
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -252,6 +269,14 @@ class PaymentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {CreateMerchantRefundPriorityParam} */
+  static createMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+      body: PaymentPlatformModel.RefundPriorityRequestSerializer().required(),
+    }).required();
+  }
+
   /** @returns {CreatePaymentLinkParam} */
   static createPaymentLink() {
     return Joi.object({
@@ -317,6 +342,13 @@ class PaymentPlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetMerchantRefundPriorityParam} */
+  static getMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetPGConfigAggregatorsParam} */
   static getPGConfigAggregators() {
     return Joi.object({}).required();
@@ -479,6 +511,14 @@ class PaymentPlatformApplicationValidator {
     }).required();
   }
 
+  /** @returns {UpdateMerchantRefundPriorityParam} */
+  static updateMerchantRefundPriority() {
+    return Joi.object({
+      configType: Joi.string().allow("").required(),
+      body: PaymentPlatformModel.RefundPriorityRequestSerializer().required(),
+    }).required();
+  }
+
   /** @returns {UpdatePaymentSessionParam} */
   static updatePaymentSession() {
     return Joi.object({

package/sdk/platform/Payment/PaymentPlatformModel.d.ts

@@ -710,6 +710,19 @@ export = PaymentPlatformModel;
  * @property {string} message - Response message
  * @property {boolean} success - Success or failure flag.
  */
+/**
+ * @typedef RefundPriorityRequestSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ */
+/**
+ * @typedef RefundPriorityResponseSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {string} configuration - Configuration for merchant or customer
+ * @property {string} [message] - Message
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ * @property {boolean} success - Success
+ */
 /**
  * @typedef RefundSessionDetail
  * @property {number} amount - Amount refunded.
@@ -748,6 +761,12 @@ export = PaymentPlatformModel;
  * @property {string} status - The status of the refund.
  * @property {number} total_refund_amount - The total amount refunded.
  */
+/**
+ * @typedef RefundSourcesPriority
+ * @property {string} description - Description of refund source
+ * @property {number} priority - Priority of refund source, 0 being highest
+ * @property {string} source - Source of refund
+ */
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -878,7 +897,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchnatPaymentModeRequest, MerchnatPaymentModeResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, ProductCODData, RefundAccountResponse, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
+    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, CODChargesLimitsResponse, CODdata, Code, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, DeletePayoutResponse, DeleteSubscriptionPaymentMethodResponse, EdcAddRequest, EdcAggregatorAndModelListResponse, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcDeviceListResponse, EdcDeviceStatsResponse, EdcDeviceUpdateResponse, EdcModelData, EdcUpdateRequest, ErrorCodeAndDescription, ErrorCodeDescription, ErrorDescription, ErrorResponse, GetOauthUrlResponse, GetPaymentCode, GetPaymentCodeResponse, GetPaymentLinkResponse, GetUserCODLimitResponse, HttpErrorCodeAndResponse, IfscCodeResponse, IntentApp, IntentAppErrorList, LinkStatus, MerchantOnBoardingRequest, MerchantOnBoardingResponse, MerchnatPaymentModeRequest, MerchnatPaymentModeResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, NotFoundResourceError, OrderBeneficiaryDetails, OrderBeneficiaryResponse, OrderDetail, Page, PaymentCode, PaymentConfirmationRequest, PaymentConfirmationResponse, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayConfigResponse, PaymentGatewayToBeReviewed, PaymentInitializationRequest, PaymentInitializationResponse, PaymentModeList, PaymentModeLogo, PaymentObjectListSerializer, PaymentOptions, PaymentOptionsResponse, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, PaymentStatusBulkHandlerRequest, PaymentStatusBulkHandlerResponse, PaymentStatusObject, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, Payout, PayoutAggregator, PayoutBankDetails, PayoutCustomer, PayoutMoreAttributes, PayoutRequest, PayoutResponse, PayoutsResponse, PollingPaymentLinkResponse, ProductCODData, RefundAccountResponse, RefundPriorityRequestSerializer, RefundPriorityResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, RefundSourcesPriority, RepaymentDetailsSerialiserPayAll, RepaymentRequestDetails, RepaymentResponse, ResendOrCancelPaymentRequest, ResendOrCancelPaymentResponse, ResendPaymentLinkResponse, RevokeOAuthToken, RootPaymentMode, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, SetCODForUserRequest, SetCODOptionResponse, StatisticsData, SubscriptionConfigResponse, SubscriptionPaymentMethodResponse, UpdatePayoutRequest, UpdatePayoutResponse, ValidateCustomerRequest, ValidateCustomerResponse };
 }
 /** @returns {AddBeneficiaryDetailsOTPRequest} */
 declare function AddBeneficiaryDetailsOTPRequest(): AddBeneficiaryDetailsOTPRequest;
@@ -2791,6 +2810,42 @@ type RefundAccountResponse = {
      */
     success: boolean;
 };
+/** @returns {RefundPriorityRequestSerializer} */
+declare function RefundPriorityRequestSerializer(): RefundPriorityRequestSerializer;
+type RefundPriorityRequestSerializer = {
+    /**
+     * - Apportion refund to multiple sources
+     */
+    apportion: boolean;
+    /**
+     * - Refund sources priority
+     */
+    refund_sources_priority: RefundSourcesPriority[];
+};
+/** @returns {RefundPriorityResponseSerializer} */
+declare function RefundPriorityResponseSerializer(): RefundPriorityResponseSerializer;
+type RefundPriorityResponseSerializer = {
+    /**
+     * - Apportion refund to multiple sources
+     */
+    apportion: boolean;
+    /**
+     * - Configuration for merchant or customer
+     */
+    configuration: string;
+    /**
+     * - Message
+     */
+    message?: string;
+    /**
+     * - Refund sources priority
+     */
+    refund_sources_priority: RefundSourcesPriority[];
+    /**
+     * - Success
+     */
+    success: boolean;
+};
 /** @returns {RefundSessionDetail} */
 declare function RefundSessionDetail(): RefundSessionDetail;
 type RefundSessionDetail = {
@@ -2901,6 +2956,22 @@ type RefundSessionResponseSerializer = {
      */
     total_refund_amount: number;
 };
+/** @returns {RefundSourcesPriority} */
+declare function RefundSourcesPriority(): RefundSourcesPriority;
+type RefundSourcesPriority = {
+    /**
+     * - Description of refund source
+     */
+    description: string;
+    /**
+     * - Priority of refund source, 0 being highest
+     */
+    priority: number;
+    /**
+     * - Source of refund
+     */
+    source: string;
+};
 /** @returns {RepaymentDetailsSerialiserPayAll} */
 declare function RepaymentDetailsSerialiserPayAll(): RepaymentDetailsSerialiserPayAll;
 type RepaymentDetailsSerialiserPayAll = {

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -792,6 +792,21 @@ const Joi = require("joi");
  * @property {boolean} success - Success or failure flag.
  */
 
+/**
+ * @typedef RefundPriorityRequestSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ */
+
+/**
+ * @typedef RefundPriorityResponseSerializer
+ * @property {boolean} apportion - Apportion refund to multiple sources
+ * @property {string} configuration - Configuration for merchant or customer
+ * @property {string} [message] - Message
+ * @property {RefundSourcesPriority[]} refund_sources_priority - Refund sources priority
+ * @property {boolean} success - Success
+ */
+
 /**
  * @typedef RefundSessionDetail
  * @property {number} amount - Amount refunded.
@@ -833,6 +848,13 @@ const Joi = require("joi");
  * @property {number} total_refund_amount - The total amount refunded.
  */
 
+/**
+ * @typedef RefundSourcesPriority
+ * @property {string} description - Description of refund source
+ * @property {number} priority - Priority of refund source, 0 being highest
+ * @property {string} source - Source of refund
+ */
+
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -1922,6 +1944,29 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {RefundPriorityRequestSerializer} */
+  static RefundPriorityRequestSerializer() {
+    return Joi.object({
+      apportion: Joi.boolean().required(),
+      refund_sources_priority: Joi.array()
+        .items(PaymentPlatformModel.RefundSourcesPriority())
+        .required(),
+    });
+  }
+
+  /** @returns {RefundPriorityResponseSerializer} */
+  static RefundPriorityResponseSerializer() {
+    return Joi.object({
+      apportion: Joi.boolean().required(),
+      configuration: Joi.string().allow("").required(),
+      message: Joi.string().allow(""),
+      refund_sources_priority: Joi.array()
+        .items(PaymentPlatformModel.RefundSourcesPriority())
+        .required(),
+      success: Joi.boolean().required(),
+    });
+  }
+
   /** @returns {RefundSessionDetail} */
   static RefundSessionDetail() {
     return Joi.object({
@@ -1965,6 +2010,15 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {RefundSourcesPriority} */
+  static RefundSourcesPriority() {
+    return Joi.object({
+      description: Joi.string().allow("").required(),
+      priority: Joi.number().required(),
+      source: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {RepaymentDetailsSerialiserPayAll} */
   static RepaymentDetailsSerialiserPayAll() {
     return Joi.object({

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 = {