@gofynd/fdk-client-javascript 1.3.1 → 1.3.2

package/package.json

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

package/sdk/platform/Order/OrderPlatformModel.d.ts

@@ -970,7 +970,7 @@ export = OrderPlatformModel;
 /**
  * @typedef GSTDetailsData
  * @property {number} brand_calculated_amount
- * @property {string} [cgst_gst_fee]
+ * @property {number} [cgst_gst_fee]
  * @property {number} [cgst_tax_percentage]
  * @property {number} gst_fee
  * @property {string} [gst_tag]
@@ -978,10 +978,10 @@ export = OrderPlatformModel;
  * @property {string} [gstin_code]
  * @property {string} [hsn_code]
  * @property {string} [hsn_code_id]
- * @property {string} [igst_gst_fee]
+ * @property {number} [igst_gst_fee]
  * @property {number} [igst_tax_percentage]
  * @property {boolean} [is_default_hsn_code]
- * @property {string} [sgst_gst_fee]
+ * @property {number} [sgst_gst_fee]
  * @property {number} [sgst_tax_percentage]
  * @property {number} tax_collected_at_source
  * @property {number} value_of_good
@@ -1277,7 +1277,7 @@ export = OrderPlatformModel;
  * @property {string} [company_logo]
  * @property {string} [currency_symbol]
  * @property {string} [customer_note]
- * @property {number} [employee_id]
+ * @property {string} [employee_id]
  * @property {Object} [extra_meta]
  * @property {Object[]} [files]
  * @property {number} [mongo_cart_id]
@@ -3546,7 +3546,7 @@ type GiftCard = {
 declare function GSTDetailsData(): GSTDetailsData;
 type GSTDetailsData = {
     brand_calculated_amount: number;
-    cgst_gst_fee?: string;
+    cgst_gst_fee?: number;
     cgst_tax_percentage?: number;
     gst_fee: number;
     gst_tag?: string;
@@ -3554,10 +3554,10 @@ type GSTDetailsData = {
     gstin_code?: string;
     hsn_code?: string;
     hsn_code_id?: string;
-    igst_gst_fee?: string;
+    igst_gst_fee?: number;
     igst_tax_percentage?: number;
     is_default_hsn_code?: boolean;
-    sgst_gst_fee?: string;
+    sgst_gst_fee?: number;
     sgst_tax_percentage?: number;
     tax_collected_at_source: number;
     value_of_good: number;
@@ -3930,7 +3930,7 @@ type OrderMeta = {
     company_logo?: string;
     currency_symbol?: string;
     customer_note?: string;
-    employee_id?: number;
+    employee_id?: string;
     extra_meta?: any;
     files?: any[];
     mongo_cart_id?: number;

package/sdk/platform/Order/OrderPlatformModel.js

@@ -1080,7 +1080,7 @@ const Joi = require("joi");
 /**
  * @typedef GSTDetailsData
  * @property {number} brand_calculated_amount
- * @property {string} [cgst_gst_fee]
+ * @property {number} [cgst_gst_fee]
  * @property {number} [cgst_tax_percentage]
  * @property {number} gst_fee
  * @property {string} [gst_tag]
@@ -1088,10 +1088,10 @@ const Joi = require("joi");
  * @property {string} [gstin_code]
  * @property {string} [hsn_code]
  * @property {string} [hsn_code_id]
- * @property {string} [igst_gst_fee]
+ * @property {number} [igst_gst_fee]
  * @property {number} [igst_tax_percentage]
  * @property {boolean} [is_default_hsn_code]
- * @property {string} [sgst_gst_fee]
+ * @property {number} [sgst_gst_fee]
  * @property {number} [sgst_tax_percentage]
  * @property {number} tax_collected_at_source
  * @property {number} value_of_good
@@ -1416,7 +1416,7 @@ const Joi = require("joi");
  * @property {string} [company_logo]
  * @property {string} [currency_symbol]
  * @property {string} [customer_note]
- * @property {number} [employee_id]
+ * @property {string} [employee_id]
  * @property {Object} [extra_meta]
  * @property {Object[]} [files]
  * @property {number} [mongo_cart_id]
@@ -3900,7 +3900,7 @@ class OrderPlatformModel {
   static GSTDetailsData() {
     return Joi.object({
       brand_calculated_amount: Joi.number().required(),
-      cgst_gst_fee: Joi.string().allow(""),
+      cgst_gst_fee: Joi.number(),
       cgst_tax_percentage: Joi.number(),
       gst_fee: Joi.number().required(),
       gst_tag: Joi.string().allow(""),
@@ -3908,10 +3908,10 @@ class OrderPlatformModel {
       gstin_code: Joi.string().allow("").allow(null),
       hsn_code: Joi.string().allow(""),
       hsn_code_id: Joi.string().allow(""),
-      igst_gst_fee: Joi.string().allow(""),
+      igst_gst_fee: Joi.number(),
       igst_tax_percentage: Joi.number(),
       is_default_hsn_code: Joi.boolean(),
-      sgst_gst_fee: Joi.string().allow(""),
+      sgst_gst_fee: Joi.number(),
       sgst_tax_percentage: Joi.number(),
       tax_collected_at_source: Joi.number().required(),
       value_of_good: Joi.number().required(),
@@ -4299,7 +4299,7 @@ class OrderPlatformModel {
       company_logo: Joi.string().allow(""),
       currency_symbol: Joi.string().allow(""),
       customer_note: Joi.string().allow(""),
-      employee_id: Joi.number().allow(null),
+      employee_id: Joi.string().allow("").allow(null),
       extra_meta: Joi.any(),
       files: Joi.array().items(Joi.any()),
       mongo_cart_id: Joi.number(),

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

@@ -133,7 +133,7 @@ declare class Payment {
      * @summary: Get All Brand Payment Gateway Config Secret
      * @description: Get All Brand Payment Gateway Config Secret - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
      */
-    getBrandPaymentGatewayConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>;
+    getBrandPaymentGatewayConfig({ aggregator, configType, requestHeaders }?: PaymentPlatformApplicationValidator.GetBrandPaymentGatewayConfigParam, { responseHeaders }?: object): Promise<PaymentPlatformModel.PaymentGatewayConfigResponse>;
     /**
      * @param {PaymentPlatformApplicationValidator.GetEdcDeviceParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

package/sdk/platform/Payment/PaymentPlatformApplicationClient.js

@@ -808,13 +808,16 @@ class Payment {
    * @description: Get All Brand Payment Gateway Config Secret - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getBrandPaymentGatewayConfig/).
    */
   async getBrandPaymentGatewayConfig(
-    { requestHeaders } = { requestHeaders: {} },
+    { aggregator, configType, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
     const {
       error,
     } = PaymentPlatformApplicationValidator.getBrandPaymentGatewayConfig().validate(
-      {},
+      {
+        aggregator,
+        configType,
+      },
       { abortEarly: false, allowUnknown: true }
     );
     if (error) {
@@ -825,7 +828,10 @@ class Payment {
     const {
       error: warrning,
     } = PaymentPlatformApplicationValidator.getBrandPaymentGatewayConfig().validate(
-      {},
+      {
+        aggregator,
+        configType,
+      },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
@@ -836,6 +842,8 @@ class Payment {
     }
 
     const query_params = {};
+    query_params["aggregator"] = aggregator;
+    query_params["config_type"] = configType;
 
     const response = await PlatformAPIClient.execute(
       this.config,

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

@@ -39,7 +39,11 @@ export = PaymentPlatformApplicationValidator;
  * @property {string} orderId
  * @property {string} [requestHash]
  */
-/** @typedef GetBrandPaymentGatewayConfigParam */
+/**
+ * @typedef GetBrandPaymentGatewayConfigParam
+ * @property {string} [aggregator] - Aggregator slug
+ * @property {string} [configType]
+ */
 /**
  * @typedef GetEdcDeviceParam
  * @property {string} terminalUniqueIdentifier - Terminal unique identifier
@@ -191,7 +195,7 @@ declare class PaymentPlatformApplicationValidator {
     /** @returns {GetBankAccountDetailsOpenAPIParam} */
     static getBankAccountDetailsOpenAPI(): GetBankAccountDetailsOpenAPIParam;
     /** @returns {GetBrandPaymentGatewayConfigParam} */
-    static getBrandPaymentGatewayConfig(): any;
+    static getBrandPaymentGatewayConfig(): GetBrandPaymentGatewayConfigParam;
     /** @returns {GetEdcDeviceParam} */
     static getEdcDevice(): GetEdcDeviceParam;
     /** @returns {GetMerchantAggregatorPaymentModeDetailsParam} */
@@ -285,6 +289,13 @@ type GetBankAccountDetailsOpenAPIParam = {
     orderId: string;
     requestHash?: string;
 };
+type GetBrandPaymentGatewayConfigParam = {
+    /**
+     * - Aggregator slug
+     */
+    aggregator?: string;
+    configType?: string;
+};
 type GetEdcDeviceParam = {
     /**
      * - Terminal unique identifier
@@ -436,7 +447,6 @@ type VerifyCustomerForPaymentParam = {
 };
 type EdcAggregatorsAndModelListParam = any;
 type EdcDeviceStatsParam = any;
-type GetBrandPaymentGatewayConfigParam = any;
 type GetMerchantPaymentOptionParam = any;
 type GetPGConfigAggregatorsParam = any;
 type GetPaymentCodeOptionParam = any;

package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js

@@ -52,7 +52,11 @@ const PaymentPlatformModel = require("./PaymentPlatformModel");
  * @property {string} [requestHash]
  */
 
-/** @typedef GetBrandPaymentGatewayConfigParam */
+/**
+ * @typedef GetBrandPaymentGatewayConfigParam
+ * @property {string} [aggregator] - Aggregator slug
+ * @property {string} [configType]
+ */
 
 /**
  * @typedef GetEdcDeviceParam
@@ -286,7 +290,10 @@ class PaymentPlatformApplicationValidator {
 
   /** @returns {GetBrandPaymentGatewayConfigParam} */
   static getBrandPaymentGatewayConfig() {
-    return Joi.object({}).required();
+    return Joi.object({
+      aggregator: Joi.string().allow(""),
+      configType: Joi.string().allow(""),
+    }).required();
   }
 
   /** @returns {GetEdcDeviceParam} */

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

@@ -44,6 +44,12 @@ export = PaymentPlatformModel;
  * @property {number} status_code - HTTP status code
  * @property {boolean} success - Successful or failure
  */
+/**
+ * @typedef CODChargesLimitsResponse
+ * @property {number} [cod_charge] - Cod charges to be applied on order.
+ * @property {number} [max_cart_value] - Max allowed cart value for cod order.
+ * @property {number} [min_cart_value] - Min allowed cart value for cod order.
+ */
 /**
  * @typedef CODdata
  * @property {boolean} is_active - COD option is active or not
@@ -444,6 +450,7 @@ export = PaymentPlatformModel;
  * @property {string} [card_reference] - Card_reference
  * @property {string} [card_token] - Card_token
  * @property {string} [card_type] - Card_type
+ * @property {number} [cod_charges] - Cod charges to be applied on order.
  * @property {number} [cod_limit] - Cod limit
  * @property {number} [cod_limit_per_order] - Cod limit per order
  * @property {string} [code] - Code
@@ -464,6 +471,7 @@ export = PaymentPlatformModel;
  * @property {string} [merchant_code] - Merchant code
  * @property {string} [name] - Name
  * @property {string} [nickname] - Nickname
+ * @property {Object} [product_cod_data] - Product cod configurations.
  * @property {number} [remaining_limit] - Remaining limit
  * @property {number} [retry_count] - Retry_count
  * @property {number} [timeout] - Timeout
@@ -690,6 +698,11 @@ export = PaymentPlatformModel;
  * @property {number} [status_code] - HTTP status code
  * @property {boolean} [success] - Successful or failure
  */
+/**
+ * @typedef ProductCODData
+ * @property {Object} [cod_charges] - Cod charges and its allowed limits.
+ * @property {Object} [items] - Item id with its cod availability.
+ */
 /**
  * @typedef RefundAccountResponse
  * @property {Object} [data] - Refund account data.
@@ -865,7 +878,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { AddBeneficiaryDetailsOTPRequest, AddressDetail, BankDetailsForOTP, CancelOrResendPaymentLinkRequest, CancelPaymentLinkResponse, 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, 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, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, 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;
@@ -986,6 +999,22 @@ type CancelPaymentLinkResponse = {
      */
     success: boolean;
 };
+/** @returns {CODChargesLimitsResponse} */
+declare function CODChargesLimitsResponse(): CODChargesLimitsResponse;
+type CODChargesLimitsResponse = {
+    /**
+     * - Cod charges to be applied on order.
+     */
+    cod_charge?: number;
+    /**
+     * - Max allowed cart value for cod order.
+     */
+    max_cart_value?: number;
+    /**
+     * - Min allowed cart value for cod order.
+     */
+    min_cart_value?: number;
+};
 /** @returns {CODdata} */
 declare function CODdata(): CODdata;
 type CODdata = {
@@ -2077,6 +2106,10 @@ type PaymentModeList = {
      * - Card_type
      */
     card_type?: string;
+    /**
+     * - Cod charges to be applied on order.
+     */
+    cod_charges?: number;
     /**
      * - Cod limit
      */
@@ -2151,6 +2184,10 @@ type PaymentModeList = {
      * - Nickname
      */
     nickname?: string;
+    /**
+     * - Product cod configurations.
+     */
+    product_cod_data?: any;
     /**
      * - Remaining limit
      */
@@ -2725,6 +2762,18 @@ type PollingPaymentLinkResponse = {
      */
     success?: boolean;
 };
+/** @returns {ProductCODData} */
+declare function ProductCODData(): ProductCODData;
+type ProductCODData = {
+    /**
+     * - Cod charges and its allowed limits.
+     */
+    cod_charges?: any;
+    /**
+     * - Item id with its cod availability.
+     */
+    items?: any;
+};
 /** @returns {RefundAccountResponse} */
 declare function RefundAccountResponse(): RefundAccountResponse;
 type RefundAccountResponse = {

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -50,6 +50,13 @@ const Joi = require("joi");
  * @property {boolean} success - Successful or failure
  */
 
+/**
+ * @typedef CODChargesLimitsResponse
+ * @property {number} [cod_charge] - Cod charges to be applied on order.
+ * @property {number} [max_cart_value] - Max allowed cart value for cod order.
+ * @property {number} [min_cart_value] - Min allowed cart value for cod order.
+ */
+
 /**
  * @typedef CODdata
  * @property {boolean} is_active - COD option is active or not
@@ -501,6 +508,7 @@ const Joi = require("joi");
  * @property {string} [card_reference] - Card_reference
  * @property {string} [card_token] - Card_token
  * @property {string} [card_type] - Card_type
+ * @property {number} [cod_charges] - Cod charges to be applied on order.
  * @property {number} [cod_limit] - Cod limit
  * @property {number} [cod_limit_per_order] - Cod limit per order
  * @property {string} [code] - Code
@@ -521,6 +529,7 @@ const Joi = require("joi");
  * @property {string} [merchant_code] - Merchant code
  * @property {string} [name] - Name
  * @property {string} [nickname] - Nickname
+ * @property {Object} [product_cod_data] - Product cod configurations.
  * @property {number} [remaining_limit] - Remaining limit
  * @property {number} [retry_count] - Retry_count
  * @property {number} [timeout] - Timeout
@@ -769,6 +778,12 @@ const Joi = require("joi");
  * @property {boolean} [success] - Successful or failure
  */
 
+/**
+ * @typedef ProductCODData
+ * @property {Object} [cod_charges] - Cod charges and its allowed limits.
+ * @property {Object} [items] - Item id with its cod availability.
+ */
+
 /**
  * @typedef RefundAccountResponse
  * @property {Object} [data] - Refund account data.
@@ -1025,6 +1040,15 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {CODChargesLimitsResponse} */
+  static CODChargesLimitsResponse() {
+    return Joi.object({
+      cod_charge: Joi.number().allow(null),
+      max_cart_value: Joi.number().allow(null),
+      min_cart_value: Joi.number().allow(null),
+    });
+  }
+
   /** @returns {CODdata} */
   static CODdata() {
     return Joi.object({
@@ -1575,6 +1599,7 @@ class PaymentPlatformModel {
       card_reference: Joi.string().allow("").allow(null),
       card_token: Joi.string().allow("").allow(null),
       card_type: Joi.string().allow("").allow(null),
+      cod_charges: Joi.number().allow(null),
       cod_limit: Joi.number().allow(null),
       cod_limit_per_order: Joi.number().allow(null),
       code: Joi.string().allow("").allow(null),
@@ -1595,6 +1620,7 @@ class PaymentPlatformModel {
       merchant_code: Joi.string().allow("").allow(null),
       name: Joi.string().allow("").allow(null),
       nickname: Joi.string().allow("").allow(null),
+      product_cod_data: Joi.any().allow(null),
       remaining_limit: Joi.number().allow(null),
       retry_count: Joi.number().allow(null),
       timeout: Joi.number().allow(null),
@@ -1878,6 +1904,14 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {ProductCODData} */
+  static ProductCODData() {
+    return Joi.object({
+      cod_charges: Joi.any().allow(null),
+      items: Joi.any().allow(null),
+    });
+  }
+
   /** @returns {RefundAccountResponse} */
   static RefundAccountResponse() {
     return Joi.object({