@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -6,6 +6,29 @@ const Joi = require("joi");
  * @property {string} order_id
  */
 
+/**
+ * @typedef AddressDetail
+ * @property {string} address - Address details
+ * @property {string} address_type - Address type e.g. home, office
+ * @property {string} area - Area details
+ * @property {string} area_code - Customer pin/zip code
+ * @property {string} area_code_slug - Area slug code, use pin/zip code if not available
+ * @property {string} city - City name
+ * @property {string} country - Country name
+ * @property {string} country_iso_code - Country's code name e.g. `IN`, `GB`
+ * @property {string} country_phone_code - Country's phone code
+ * @property {string} [email] - Customer email
+ * @property {string} [expire_at] - Address expiry timestamp
+ * @property {string} g_address_id - Unique address id generated by Fynd platform
+ * @property {Object} [geo_location] - Location latitude and logitude
+ * @property {Object} [google_map_point] - Google map point of location
+ * @property {string} [landmark] - Landmark
+ * @property {string} name - Customer name
+ * @property {string} phone - Phone number
+ * @property {string} state - State of the customer
+ * @property {Object[]} [tags] - Optional address tag
+ */
+
 /**
  * @typedef BankDetailsForOTP
  * @property {string} account_holder
@@ -192,7 +215,7 @@ const Joi = require("joi");
 
 /**
  * @typedef ErrorResponse
- * @property {ErrorDescription} [error]
+ * @property {Object} [error]
  * @property {string} message - Message
  * @property {number} status_code - HTTP status code
  * @property {boolean} success - Successful or failure
@@ -251,7 +274,7 @@ const Joi = require("joi");
  * @typedef IntentApp
  * @property {string} [code] - Code
  * @property {string} [display_name] - Display_name
- * @property {PaymentModeLogo} [logos] - Logos
+ * @property {Object} [logos] - Logos
  * @property {string} [package_name] - Package_name
  */
 
@@ -282,6 +305,19 @@ const Joi = require("joi");
  * @property {boolean} success - Success/Failure of the transaction
  */
 
+/**
+ * @typedef MerchnatPaymentModeRequest
+ * @property {Object} [offline] - Details to be updated for online payment configuration.
+ * @property {Object} [online] - Details to be updated for offline payment configuration.
+ */
+
+/**
+ * @typedef MerchnatPaymentModeResponse
+ * @property {Object[]} [items] - List of all aggregator and payment mode details.
+ * @property {string} [message] - Message
+ * @property {boolean} success - Response is successful or not.
+ */
+
 /**
  * @typedef MultiTenderPaymentMeta
  * @property {string} [current_status]
@@ -335,6 +371,19 @@ const Joi = require("joi");
  * @property {boolean} [show_beneficiary_details] - Show beneficiary details or not.
  */
 
+/**
+ * @typedef OrderDetail
+ * @property {string} aggregator - Name of the payment gateway aggregator.
+ * @property {Object} aggregator_order_details - Aggregator order details
+ *   generated by the payment gateway.
+ * @property {number} amount - Amount paid.
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {string} status - Order status created by payment gateway aggregator.
+ */
+
 /**
  * @typedef Page
  * @property {number} [current]
@@ -468,7 +517,7 @@ const Joi = require("joi");
  *   Intent_app_error_dict_list
  * @property {string[]} [intent_app_error_list] - Intent_app_error_list
  * @property {boolean} [intent_flow] - Intent_flow
- * @property {PaymentModeLogo} [logo_url] - Logo
+ * @property {Object} [logo_url] - Logo
  * @property {string} [merchant_code] - Merchant code
  * @property {string} [name] - Name
  * @property {string} [nickname] - Nickname
@@ -516,6 +565,66 @@ const Joi = require("joi");
  * @property {boolean} success - Response is successful or not
  */
 
+/**
+ * @typedef PaymentSessionDetail
+ * @property {string} [aggregator_customer_id] - Unique customer id generated by
+ *   payment gateway, not required for standard checkout.
+ * @property {string} aggregator_order_id - Unique order id or payment request
+ *   id generated by payment gateway
+ * @property {number} amount - Amount paid.
+ * @property {number} amount_captured - Amount which is captured or credited to
+ *   merchant account
+ * @property {number} [amount_refunded]
+ * @property {AddressDetail} billing_address - Billing address
+ * @property {string} cancel_url - Cancel url sent by Fynd platform at the time
+ *   of payment creation
+ * @property {boolean} [captured] - Whether the payment is captured (credited to
+ *   merchant account) by payment gateway.
+ * @property {string} [created] - Timestamp in epoch
+ * @property {string} currency - Currency of the payment.
+ * @property {string} g_user_id - Global user identifier - unique user id
+ *   generated by Fynd platform
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {string} [kind] - Optional kind of purchase/payment - one time
+ *   payment (sale) or subcription. defaults to sale.
+ * @property {string} [locale] - User's locale
+ * @property {string} [merchant_locale] - Merchant's locale
+ * @property {string} mode - Test or live, test mode uses test credentials so
+ *   that actual payment is not created.
+ * @property {string} payment_id - Unique transaction id generated by payment gateway
+ * @property {Object[]} payment_methods - Method of payment
+ * @property {AddressDetail} shipping_address - Shipping address
+ * @property {string} status - Stautus of the payment
+ * @property {string} success_url - Success url sent by Fynd platform at the
+ *   time of payment creation
+ */
+
+/**
+ * @typedef PaymentSessionRequestSerializer
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {OrderDetail} order_details - The details of the order.
+ * @property {PaymentSessionDetail[]} payment_details - The payment details with
+ *   the schema `PaymentSessionDetail`.
+ * @property {string} status - Status of the payment.
+ * @property {number} total_amount - Amount paid.
+ */
+
+/**
+ * @typedef PaymentSessionResponseSerializer
+ * @property {string} currency - Currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {Object[]} platform_transaction_details - Platform transaction details.
+ * @property {string} status - Status of the payment.
+ * @property {number} total_amount - Amount paid.
+ */
+
 /**
  * @typedef PaymentStatusBulkHandlerRequest
  * @property {string[]} merchant_order_id - List of order ids
@@ -668,6 +777,47 @@ const Joi = require("joi");
  * @property {boolean} success - Success or failure flag.
  */
 
+/**
+ * @typedef RefundSessionDetail
+ * @property {number} amount - Amount refunded.
+ * @property {string} [balance_transaction] - Balance transaction.
+ * @property {string} created - Timestamp in epoch.
+ * @property {string} currency - Currency of the payment.
+ * @property {string} payment_id - Unique payment id generated by payment gateway.
+ * @property {string} [reason] - Reason for refund, optional
+ * @property {string} [receipt_number] - Unique receipt for refund, generated by
+ *   payment gateway, if not available can be utr.
+ * @property {string} [refund_utr] - Unique refund utr generated by payment gateway.
+ * @property {string} request_id - Refund request id, unique id generated by Fynd platform
+ * @property {string} [source_transfer_reversal] - Description in case of
+ *   reversal of payment.
+ * @property {string} status - Status of the refund.
+ * @property {string} [transfer_reversal] - Description in case of reversal of payment.
+ */
+
+/**
+ * @typedef RefundSessionRequestSerializer
+ * @property {string} currency - The currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {PaymentSessionDetail} payment_details - Details of the payment
+ * @property {RefundSessionDetail[]} [refund_details] - Details of the refund
+ * @property {string} status - The status of the refund.
+ * @property {number} total_amount - The total amount refunded.
+ */
+
+/**
+ * @typedef RefundSessionResponseSerializer
+ * @property {string} currency - The currency of the payment.
+ * @property {string} gid - Global identifier of the entity (e.g. order, cart
+ *   etc.) against which payment_session was initiated. This is generated by
+ *   Fynd payments platform and is unique.
+ * @property {Object[]} platform_refund_details - Details of the refund
+ * @property {string} status - The status of the refund.
+ * @property {number} total_refund_amount - The total amount refunded.
+ */
+
 /**
  * @typedef RepaymentDetailsSerialiserPayAll
  * @property {string} aggregator_order_id - Id of payment gateway
@@ -823,6 +973,31 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {AddressDetail} */
+  static AddressDetail() {
+    return Joi.object({
+      address: Joi.string().allow("").required(),
+      address_type: Joi.string().allow("").required(),
+      area: Joi.string().allow("").required(),
+      area_code: Joi.string().allow("").required(),
+      area_code_slug: Joi.string().allow("").required(),
+      city: Joi.string().allow("").required(),
+      country: Joi.string().allow("").required(),
+      country_iso_code: Joi.string().allow("").required(),
+      country_phone_code: Joi.string().allow("").required(),
+      email: Joi.string().allow(""),
+      expire_at: Joi.string().allow(""),
+      g_address_id: Joi.string().allow("").required(),
+      geo_location: Joi.any(),
+      google_map_point: Joi.any(),
+      landmark: Joi.string().allow(""),
+      name: Joi.string().allow("").required(),
+      phone: Joi.string().allow("").required(),
+      state: Joi.string().allow("").required(),
+      tags: Joi.array().items(Joi.any()),
+    });
+  }
+
   /** @returns {BankDetailsForOTP} */
   static BankDetailsForOTP() {
     return Joi.object({
@@ -1052,7 +1227,7 @@ class PaymentPlatformModel {
   /** @returns {ErrorResponse} */
   static ErrorResponse() {
     return Joi.object({
-      error: PaymentPlatformModel.ErrorDescription(),
+      error: Joi.any().allow(null),
       message: Joi.string().allow("").required(),
       status_code: Joi.number().required(),
       success: Joi.boolean().required(),
@@ -1127,7 +1302,7 @@ class PaymentPlatformModel {
     return Joi.object({
       code: Joi.string().allow("").allow(null),
       display_name: Joi.string().allow("").allow(null),
-      logos: PaymentPlatformModel.PaymentModeLogo(),
+      logos: Joi.any().allow(null),
       package_name: Joi.string().allow("").allow(null),
     });
   }
@@ -1167,6 +1342,23 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {MerchnatPaymentModeRequest} */
+  static MerchnatPaymentModeRequest() {
+    return Joi.object({
+      offline: Joi.any().allow(null),
+      online: Joi.any().allow(null),
+    });
+  }
+
+  /** @returns {MerchnatPaymentModeResponse} */
+  static MerchnatPaymentModeResponse() {
+    return Joi.object({
+      items: Joi.array().items(Joi.any()),
+      message: Joi.string().allow("").allow(null),
+      success: Joi.boolean().required(),
+    });
+  }
+
   /** @returns {MultiTenderPaymentMeta} */
   static MultiTenderPaymentMeta() {
     return Joi.object({
@@ -1232,6 +1424,18 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {OrderDetail} */
+  static OrderDetail() {
+    return Joi.object({
+      aggregator: Joi.string().allow("").required(),
+      aggregator_order_details: Joi.any().required(),
+      amount: Joi.number().required(),
+      currency: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      status: Joi.string().allow("").required(),
+    });
+  }
+
   /** @returns {Page} */
   static Page() {
     return Joi.object({
@@ -1387,7 +1591,7 @@ class PaymentPlatformModel {
       ),
       intent_app_error_list: Joi.array().items(Joi.string().allow("")),
       intent_flow: Joi.boolean().allow(null),
-      logo_url: PaymentPlatformModel.PaymentModeLogo(),
+      logo_url: Joi.any().allow(null),
       merchant_code: Joi.string().allow("").allow(null),
       name: Joi.string().allow("").allow(null),
       nickname: Joi.string().allow("").allow(null),
@@ -1446,6 +1650,58 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {PaymentSessionDetail} */
+  static PaymentSessionDetail() {
+    return Joi.object({
+      aggregator_customer_id: Joi.string().allow(""),
+      aggregator_order_id: Joi.string().allow("").required(),
+      amount: Joi.number().required(),
+      amount_captured: Joi.number().required(),
+      amount_refunded: Joi.number(),
+      billing_address: PaymentPlatformModel.AddressDetail().required(),
+      cancel_url: Joi.string().allow("").required(),
+      captured: Joi.boolean(),
+      created: Joi.string().allow(""),
+      currency: Joi.string().allow("").required(),
+      g_user_id: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      kind: Joi.string().allow(""),
+      locale: Joi.string().allow(""),
+      merchant_locale: Joi.string().allow(""),
+      mode: Joi.string().allow("").required(),
+      payment_id: Joi.string().allow("").required(),
+      payment_methods: Joi.array().items(Joi.any()).required(),
+      shipping_address: PaymentPlatformModel.AddressDetail().required(),
+      status: Joi.string().allow("").required(),
+      success_url: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {PaymentSessionRequestSerializer} */
+  static PaymentSessionRequestSerializer() {
+    return Joi.object({
+      currency: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      order_details: PaymentPlatformModel.OrderDetail().required(),
+      payment_details: Joi.array()
+        .items(PaymentPlatformModel.PaymentSessionDetail())
+        .required(),
+      status: Joi.string().allow("").required(),
+      total_amount: Joi.number().required(),
+    });
+  }
+
+  /** @returns {PaymentSessionResponseSerializer} */
+  static PaymentSessionResponseSerializer() {
+    return Joi.object({
+      currency: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      platform_transaction_details: Joi.array().items(Joi.any()).required(),
+      status: Joi.string().allow("").required(),
+      total_amount: Joi.number().required(),
+    });
+  }
+
   /** @returns {PaymentStatusBulkHandlerRequest} */
   static PaymentStatusBulkHandlerRequest() {
     return Joi.object({
@@ -1632,6 +1888,49 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {RefundSessionDetail} */
+  static RefundSessionDetail() {
+    return Joi.object({
+      amount: Joi.number().required(),
+      balance_transaction: Joi.string().allow(""),
+      created: Joi.string().allow("").required(),
+      currency: Joi.string().allow("").required(),
+      payment_id: Joi.string().allow("").required(),
+      reason: Joi.string().allow(""),
+      receipt_number: Joi.string().allow(""),
+      refund_utr: Joi.string().allow(""),
+      request_id: Joi.string().allow("").required(),
+      source_transfer_reversal: Joi.string().allow(""),
+      status: Joi.string().allow("").required(),
+      transfer_reversal: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {RefundSessionRequestSerializer} */
+  static RefundSessionRequestSerializer() {
+    return Joi.object({
+      currency: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      payment_details: PaymentPlatformModel.PaymentSessionDetail().required(),
+      refund_details: Joi.array().items(
+        PaymentPlatformModel.RefundSessionDetail()
+      ),
+      status: Joi.string().allow("").required(),
+      total_amount: Joi.number().required(),
+    });
+  }
+
+  /** @returns {RefundSessionResponseSerializer} */
+  static RefundSessionResponseSerializer() {
+    return Joi.object({
+      currency: Joi.string().allow("").required(),
+      gid: Joi.string().allow("").required(),
+      platform_refund_details: Joi.array().items(Joi.any()).required(),
+      status: Joi.string().allow("").required(),
+      total_refund_amount: Joi.number().required(),
+    });
+  }
+
   /** @returns {RepaymentDetailsSerialiserPayAll} */
   static RepaymentDetailsSerialiserPayAll() {
     return Joi.object({

package/sdk/platform/PlatformAPIClient.d.ts

@@ -1,7 +1,7 @@
 export = APIClient;
 /**
  * @typedef {Object} Options
- * @property {boolean} headers - Whether headers are returned or not.
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
  */
 declare class APIClient {
     /**
@@ -21,7 +21,7 @@ declare namespace APIClient {
 }
 type Options = {
     /**
-     * - Whether headers are returned or not.
+     * - Whether response headers are returned or not.
      */
-    headers: boolean;
+    responseHeaders: boolean;
 };

package/sdk/platform/PlatformAPIClient.js

@@ -2,7 +2,7 @@ const { fdkAxios } = require("../common/AxiosHelper");
 
 /**
  * @typedef {Object} Options
- * @property {boolean} headers - Whether headers are returned or not.
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
  */
 
 class APIClient {
@@ -34,7 +34,7 @@ class APIClient {
         ...extraHeaders,
         ...xHeaders,
       },
-      _returnHeaders: options.headers,
+      responseHeaders: options.responseHeaders,
     };
     rawRequest = JSON.parse(JSON.stringify(rawRequest));
 

package/sdk/platform/PlatformClient.d.ts

@@ -25,9 +25,9 @@ declare class PlatformClient {
     inventory: Inventory;
     lead: Lead;
     order: Order;
-    partner: Partner;
     payment: Payment;
     serviceability: Serviceability;
+    theme: Theme;
     webhook: Webhook;
     /**
      * Creates an instance of PlatformApplicationClient to interact with a
@@ -60,8 +60,8 @@ import Finance = require("./Finance/FinancePlatformClient");
 import Inventory = require("./Inventory/InventoryPlatformClient");
 import Lead = require("./Lead/LeadPlatformClient");
 import Order = require("./Order/OrderPlatformClient");
-import Partner = require("./Partner/PartnerPlatformClient");
 import Payment = require("./Payment/PaymentPlatformClient");
 import Serviceability = require("./Serviceability/ServiceabilityPlatformClient");
+import Theme = require("./Theme/ThemePlatformClient");
 import Webhook = require("./Webhook/WebhookPlatformClient");
 import PlatformApplicationClient = require("./PlatformApplicationClient");

package/sdk/platform/PlatformClient.js

@@ -24,12 +24,12 @@ const Lead = require("./Lead/LeadPlatformClient");
 
 const Order = require("./Order/OrderPlatformClient");
 
-const Partner = require("./Partner/PartnerPlatformClient");
-
 const Payment = require("./Payment/PaymentPlatformClient");
 
 const Serviceability = require("./Serviceability/ServiceabilityPlatformClient");
 
+const Theme = require("./Theme/ThemePlatformClient");
+
 const Webhook = require("./Webhook/WebhookPlatformClient");
 
 const PlatformApplicationClient = require("./PlatformApplicationClient");
@@ -75,12 +75,12 @@ class PlatformClient {
 
     this.order = new Order(config);
 
-    this.partner = new Partner(config);
-
     this.payment = new Payment(config);
 
     this.serviceability = new Serviceability(config);
 
+    this.theme = new Theme(config);
+
     this.webhook = new Webhook(config);
   }
 

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts

@@ -5,50 +5,58 @@ declare class Rewards {
     applicationId: any;
     /**
      * @param {RewardsPlatformApplicationValidator.GetGiveawayByIdParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name getGiveawayById
      * @summary: Get giveaway by ID.
      * @description: Retrieve the specific giveaway by giveaway ID. It will show all the details of the requested giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
      */
-    getGiveawayById({ id }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
+    getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
      * @param {RewardsPlatformApplicationValidator.GetOfferByNameParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
      * @name getOfferByName
      * @summary: Fetch a offer by its name
      * @description: Fetch the specific offer details and configuration by the name of the offer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
      */
-    getOfferByName({ name }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer>;
+    getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
+     * @param {RewardsPlatformApplicationValidator.GetRewardsConfigurationParam} arg
+     *   - Arg object
+     *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
      * @name getRewardsConfiguration
      * @summary: Get all valid android paths
      * @description: Use this API to get a list of valid android paths required by the Rewards INIT API to validate a fraudulent device. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
      */
-    getRewardsConfiguration({ headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.ConfigurationRes>;
+    getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
     /**
      * @param {RewardsPlatformApplicationValidator.GetUserDetailsParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
      * @name getUserDetails
      * @summary: Get user reward details
      * @description: Fetches the user details and the user reward details with their current reward points for the specific user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
      */
-    getUserDetails({ userId }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.UserRes>;
+    getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
     /**
      * @param {RewardsPlatformApplicationValidator.GetUserPointsHistoryParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
      * @name getUserPointsHistory
      * @summary: Get all transactions of reward points
      * @description: Fetches a list of points transactions like giveaway points, signup points, referral points, order earn points, redeem points and expired points. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
      */
-    getUserPointsHistory({ userId, pageId, pageSize }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.HistoryRes>;
+    getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
     /**
      * @param {Object} arg - Arg object.
      * @param {string} arg.userId - User id
@@ -67,70 +75,78 @@ declare class Rewards {
     }): Paginator<RewardsPlatformModel.HistoryRes>;
     /**
      * @param {RewardsPlatformApplicationValidator.SaveGiveAwayParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name saveGiveAway
      * @summary: List of giveaways of the current application.
      * @description: Creates a new giveaway in the current application, specifying the target audience, points allocation, as well as the name and display name of the giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
      */
-    saveGiveAway({ body }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
+    saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
      * @param {RewardsPlatformApplicationValidator.SetRewardsConfigurationParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
      * @name setRewardsConfiguration
      * @summary: Updates the collection with given android paths.
      * @description: Updates the configuration or inserts new records with the given android paths. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
      */
-    setRewardsConfiguration({ body }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.SetConfigurationRes>;
+    setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
     /**
      * @param {RewardsPlatformApplicationValidator.ShowGiveawaysParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.GiveawayResponse>} - Success response
      * @name showGiveaways
      * @summary: List of giveaways of the current application.
      * @description: Fetch the detailed compilation of live, completed, and scheduled point-based giveaways created. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
      */
-    showGiveaways({ pageId, pageSize }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.GiveawayResponse>;
+    showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.GiveawayResponse>;
     /**
+     * @param {RewardsPlatformApplicationValidator.ShowOffersParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
      * @name showOffers
      * @summary: List of offers of the current application.
      * @description: Retrieve the list of offers within the current application, including order_discount, order, sign_up, and referral, along with their respective details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
      */
-    showOffers({ headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer[]>;
+    showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
     /**
      * @param {RewardsPlatformApplicationValidator.UpdateGiveAwayParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name updateGiveAway
      * @summary: Updates the giveaway by it's ID.
      * @description: Make the necessary updates to the giveaway based on its giveaway ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
      */
-    updateGiveAway({ id, body }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Giveaway>;
+    updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
      * @param {RewardsPlatformApplicationValidator.UpdateOfferByNameParam} arg
      *   - Arg object
      *
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
      * @name updateOfferByName
      * @summary: Update offer by name
      * @description: Update the specific offer details and its configuration by offer name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
      */
-    updateOfferByName({ name, body }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.Offer>;
+    updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
      * @param {RewardsPlatformApplicationValidator.UpdateUserStatusParam} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PlatformAPIClient").Options} - Options
      * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
      * @name updateUserStatus
      * @summary: Update user status
      * @description: Update the user status by marking them as a block or unblock. It can be done by changing the active flag in request body. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
      */
-    updateUserStatus({ userId, body }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { headers }?: import("../PlatformAPIClient").Options): Promise<RewardsPlatformModel.AppUser>;
+    updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
 }
 import RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
 import RewardsPlatformModel = require("./RewardsPlatformModel");