@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.5

package/sdk/platform/Payment/PaymentPlatformClient.js

@@ -20,8 +20,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
    * @name activateAndDectivatePayout
-   * @summary: Partial Update Payout
-   * @description: Partial Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
+   * @summary: Activate/Deactivate payout.
+   * @description: Enable or disable payout functionality. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/activateAndDectivatePayout/).
    */
   async activateAndDectivatePayout(
     { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -103,8 +103,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.DeletePayoutResponse>} - Success response
    * @name deletePayout
-   * @summary: Delete Payout
-   * @description: Delete Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
+   * @summary: Delete payout.
+   * @description: Remove a payout transaction from the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deletePayout/).
    */
   async deletePayout(
     { uniqueTransferNo, requestHeaders } = { requestHeaders: {} },
@@ -186,8 +186,8 @@ class Payment {
    *   - Success response
    *
    * @name deleteSubscriptionPaymentMethod
-   * @summary: Delete Subscription Payment Method
-   * @description: Uses this api to Delete Subscription Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
+   * @summary: Delete subscription payment method.
+   * @description: Remove a payment method from subscription options. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
    */
   async deleteSubscriptionPaymentMethod(
     { uniqueExternalId, paymentMethodId, requestHeaders } = {
@@ -273,8 +273,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.PayoutsResponse>} - Success response
    * @name getAllPayouts
-   * @summary: Get All Payouts
-   * @description: Get All Payouts - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
+   * @summary: Get all payouts.
+   * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
    */
   async getAllPayouts(
     { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -354,8 +354,8 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.SubscriptionConfigResponse>} -
    *   Success response
    * @name getSubscriptionConfig
-   * @summary: List Subscription Config
-   * @description: Get all  Subscription Config details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
+   * @summary: Get subscription config.
+   * @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionConfig/).
    */
   async getSubscriptionConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -433,8 +433,8 @@ class Payment {
    *   - Success response
    *
    * @name getSubscriptionPaymentMethod
-   * @summary: List Subscription Payment Method
-   * @description: Get all  Subscription  Payment Method - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
+   * @summary: Get subscription payment method.
+   * @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getSubscriptionPaymentMethod/).
    */
   async getSubscriptionPaymentMethod(
     { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -515,8 +515,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.PayoutResponse>} - Success response
    * @name savePayout
-   * @summary: Save Payout
-   * @description: Save Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
+   * @summary: Save payout.
+   * @description: Store and process a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/savePayout/).
    */
   async savePayout(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -594,8 +594,8 @@ class Payment {
    *   - Success response
    *
    * @name saveSubscriptionSetupIntent
-   * @summary: Save Subscription Setup Intent
-   * @description: Uses this api to Save Subscription Setup Intent - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
+   * @summary: Save subscription setup intent.
+   * @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/saveSubscriptionSetupIntent/).
    */
   async saveSubscriptionSetupIntent(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -675,8 +675,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.UpdatePayoutResponse>} - Success response
    * @name updatePayout
-   * @summary: Update Payout
-   * @description: Update Payout - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
+   * @summary: Update payout.
+   * @description: Modify the details of a payout transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/updatePayout/).
    */
   async updatePayout(
     { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -756,8 +756,8 @@ class Payment {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<PaymentPlatformModel.IfscCodeResponse>} - Success response
    * @name verifyIfscCode
-   * @summary: Ifsc Code Verification
-   * @description: Get True or False for correct IFSC Code for adding bank details for refund - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
+   * @summary: Verify IFSC code.
+   * @description: Check the authenticity of an IFSC code. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
    */
   async verifyIfscCode(
     { ifscCode, requestHeaders } = { requestHeaders: {} },

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

@@ -136,6 +136,13 @@ export = PaymentPlatformModel;
  * @property {string} [payment_flow] - Payment_flow
  * @property {string} [api_link] - Api_link
  */
+/**
+ * @typedef PaymentDefaultSelection
+ * @property {string} [mode] - Default Selection Payment Mode
+ * @property {string} [identifier] - Identifier for Payment Mode
+ * @property {boolean} [skip] - Decide if the default payment mode will skip the
+ *   payment options page altogether or just be preferred on the Frontend
+ */
 /**
  * @typedef PaymentFlow
  * @property {AggregatorRoute} [bqr_razorpay]
@@ -156,6 +163,7 @@ export = PaymentPlatformModel;
  * @typedef PaymentOptionAndFlow
  * @property {RootPaymentMode[]} payment_option - Payment options
  * @property {PaymentFlow} payment_flows
+ * @property {PaymentDefaultSelection} [payment_default_selection]
  */
 /**
  * @typedef AdvanceObject
@@ -1169,7 +1177,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
+    export { PaymentGatewayConfigResponse, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigRequest, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorCodeAndResponse, IntentAppErrorList, ProductCODData, CODChargesLimitsResponse, PaymentModeLogo, IntentApp, PaymentModeList, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteResponse, PaymentOptionsResponse, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsResponse, PayoutBankDetails, PayoutRequest, PayoutResponse, UpdatePayoutResponse, UpdatePayoutRequest, DeletePayoutResponse, SubscriptionPaymentMethodResponse, DeleteSubscriptionPaymentMethodResponse, SubscriptionConfigResponse, SaveSubscriptionSetupIntentRequest, SaveSubscriptionSetupIntentResponse, RefundAccountResponse, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPRequest, IfscCodeResponse, OrderBeneficiaryDetails, OrderBeneficiaryResponse, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationRequest, PaymentConfirmationResponse, CODdata, GetUserCODLimitResponse, SetCODForUserRequest, SetCODOptionResponse, EdcModelData, EdcAggregatorAndModelListResponse, StatisticsData, EdcDeviceStatsResponse, EdcAddRequest, EdcDevice, EdcDeviceAddResponse, EdcDeviceDetailsResponse, EdcUpdateRequest, EdcDeviceUpdateResponse, Page, EdcDeviceListResponse, PaymentInitializationRequest, PaymentInitializationResponse, PaymentStatusUpdateRequest, PaymentStatusUpdateResponse, ResendOrCancelPaymentRequest, LinkStatus, ResendOrCancelPaymentResponse, PaymentStatusBulkHandlerRequest, PaymentObjectListSerializer, PaymentStatusObject, PaymentStatusBulkHandlerResponse, GetOauthUrlResponse, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentResponse, MerchantOnBoardingRequest, MerchantOnBoardingResponse, ValidateCustomerRequest, ValidateCustomerResponse, GetPaymentLinkResponse, ErrorDescription, ErrorResponse, CreatePaymentLinkMeta, CreatePaymentLinkRequest, CreatePaymentLinkResponse, PollingPaymentLinkResponse, CancelOrResendPaymentLinkRequest, ResendPaymentLinkResponse, CancelPaymentLinkResponse, Code, PaymentCode, GetPaymentCode, GetPaymentCodeResponse, PlatformPaymentModeResponse, MerchnatPaymentModeRequest, OrderDetail, AddressDetail, PaymentSessionDetail, PaymentSessionRequestSerializer, PaymentSessionResponseSerializer, RefundSessionDetail, RefundSessionRequestSerializer, RefundSessionResponseSerializer, PaymentDetailsSerializer, CartDetailsSerializer, RefundDetailsSerializer, PaymentSessionSerializer, RefundSourcesPriority, RefundPriorityResponseSerializer, RefundPriorityRequestSerializer, MerchantPaymentModeRequest, FromConfig, ToConfig, PlatformPaymentModeCopyConfigRequest, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderRequest, PaymentOrderData, PaymentOrderResponse, AggregatorVersionItemSchema, AggregatorVersionResponse, AggregatorVersionRequestSchema, AggregatorControlRequest, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema };
 }
 /** @returns {PaymentGatewayConfigResponse} */
 declare function PaymentGatewayConfigResponse(): PaymentGatewayConfigResponse;
@@ -1561,6 +1569,23 @@ type AggregatorRoute = {
      */
     api_link?: string;
 };
+/** @returns {PaymentDefaultSelection} */
+declare function PaymentDefaultSelection(): PaymentDefaultSelection;
+type PaymentDefaultSelection = {
+    /**
+     * - Default Selection Payment Mode
+     */
+    mode?: string;
+    /**
+     * - Identifier for Payment Mode
+     */
+    identifier?: string;
+    /**
+     * - Decide if the default payment mode will skip the
+     * payment options page altogether or just be preferred on the Frontend
+     */
+    skip?: boolean;
+};
 /** @returns {PaymentFlow} */
 declare function PaymentFlow(): PaymentFlow;
 type PaymentFlow = {
@@ -1586,6 +1611,7 @@ type PaymentOptionAndFlow = {
      */
     payment_option: RootPaymentMode[];
     payment_flows: PaymentFlow;
+    payment_default_selection?: PaymentDefaultSelection;
 };
 /** @returns {AdvanceObject} */
 declare function AdvanceObject(): AdvanceObject;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -153,6 +153,14 @@ const Joi = require("joi");
  * @property {string} [api_link] - Api_link
  */
 
+/**
+ * @typedef PaymentDefaultSelection
+ * @property {string} [mode] - Default Selection Payment Mode
+ * @property {string} [identifier] - Identifier for Payment Mode
+ * @property {boolean} [skip] - Decide if the default payment mode will skip the
+ *   payment options page altogether or just be preferred on the Frontend
+ */
+
 /**
  * @typedef PaymentFlow
  * @property {AggregatorRoute} [bqr_razorpay]
@@ -174,6 +182,7 @@ const Joi = require("joi");
  * @typedef PaymentOptionAndFlow
  * @property {RootPaymentMode[]} payment_option - Payment options
  * @property {PaymentFlow} payment_flows
+ * @property {PaymentDefaultSelection} [payment_default_selection]
  */
 
 /**
@@ -1491,6 +1500,15 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {PaymentDefaultSelection} */
+  static PaymentDefaultSelection() {
+    return Joi.object({
+      mode: Joi.string().allow("").allow(null),
+      identifier: Joi.string().allow("").allow(null),
+      skip: Joi.boolean().allow(null),
+    });
+  }
+
   /** @returns {PaymentFlow} */
   static PaymentFlow() {
     return Joi.object({
@@ -1517,6 +1535,7 @@ class PaymentPlatformModel {
         .items(PaymentPlatformModel.RootPaymentMode())
         .required(),
       payment_flows: PaymentPlatformModel.PaymentFlow().required(),
+      payment_default_selection: PaymentPlatformModel.PaymentDefaultSelection(),
     });
   }
 

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

@@ -10,7 +10,7 @@ declare class Rewards {
      * @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/).
+     * @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
      */
     getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -19,8 +19,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Get offer by name.
+     * @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
      */
     getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
@@ -31,8 +31,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Get rewards configuration.
+     * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
      */
     getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
     /**
@@ -41,8 +41,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Get user details.
+     * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
      */
     getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
     /**
@@ -53,34 +53,18 @@ declare class Rewards {
      * @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/).
+     * @summary: Get user points history.
+     * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
      */
     getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
-    /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.userId - User id
-     * @param {string} arg.companyId - Company id
-     * @param {string} arg.applicationId - Application id
-     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-     * @returns {Paginator<RewardsPlatformModel.HistoryRes>}
-     * @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.
-     */
-    getUserPointsHistoryPaginator({ userId, companyId, applicationId, pageSize, }?: {
-        userId: string;
-        companyId: string;
-        applicationId: string;
-        pageSize?: number;
-    }): 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/).
+     * @summary: Save giveaway.
+     * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
      */
     saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -91,8 +75,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Set rewards configuration.
+     * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
      */
     setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
     /**
@@ -101,8 +85,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Display giveaways.
+     * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
      */
     showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.GiveawayResponse>;
     /**
@@ -111,8 +95,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Show offers.
+     * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
      */
     showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
     /**
@@ -121,8 +105,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Update giveaway.
+     * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
      */
     updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -133,8 +117,8 @@ declare class Rewards {
      * @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/).
+     * @summary: Update offer by name.
+     * @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
      */
     updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
@@ -143,11 +127,10 @@ declare class Rewards {
      * @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/).
+     * @summary: Update user status.
+     * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
      */
     updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
 }
 import RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
 import RewardsPlatformModel = require("./RewardsPlatformModel");
-import Paginator = require("../../common/Paginator");

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js

@@ -22,7 +22,7 @@ class Rewards {
    * @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/).
+   * @description: Retrieve specific giveaway details by its unique identifier. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getGiveawayById/).
    */
   async getGiveawayById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -100,8 +100,8 @@ class Rewards {
    * @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/).
+   * @summary: Get offer by name.
+   * @description: Retrieve an offer by its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getOfferByName/).
    */
   async getOfferByName(
     { name, requestHeaders } = { requestHeaders: {} },
@@ -177,8 +177,8 @@ class Rewards {
    * @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/).
+   * @summary: Get rewards configuration.
+   * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getRewardsConfiguration/).
    */
   async getRewardsConfiguration(
     { requestHeaders } = { requestHeaders: {} },
@@ -252,8 +252,8 @@ class Rewards {
    * @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/).
+   * @summary: Get user details.
+   * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserDetails/).
    */
   async getUserDetails(
     { userId, requestHeaders } = { requestHeaders: {} },
@@ -329,8 +329,8 @@ class Rewards {
    * @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/).
+   * @summary: Get user points history.
+   * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/getUserPointsHistory/).
    */
   async getUserPointsHistory(
     { userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -410,52 +410,14 @@ class Rewards {
     return response;
   }
 
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.userId - User id
-   * @param {string} arg.companyId - Company id
-   * @param {string} arg.applicationId - Application id
-   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
-   * @returns {Paginator<RewardsPlatformModel.HistoryRes>}
-   * @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.
-   */
-  getUserPointsHistoryPaginator({
-    userId,
-    companyId,
-    applicationId,
-    pageSize,
-  } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "cursor";
-      const data = await this.getUserPointsHistory({
-        userId: userId,
-        companyId: companyId,
-        applicationId: applicationId,
-        pageId: pageId,
-        pageSize: pageSize,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback.bind(this));
-    return paginator;
-  }
-
   /**
    * @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/).
+   * @summary: Save giveaway.
+   * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
    */
   async saveGiveAway(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -535,8 +497,8 @@ class Rewards {
    * @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/).
+   * @summary: Set rewards configuration.
+   * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/setRewardsConfiguration/).
    */
   async setRewardsConfiguration(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -614,8 +576,8 @@ class Rewards {
    * @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/).
+   * @summary: Display giveaways.
+   * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
    */
   async showGiveaways(
     { pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -697,8 +659,8 @@ class Rewards {
    * @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/).
+   * @summary: Show offers.
+   * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
    */
   async showOffers(
     { requestHeaders } = { requestHeaders: {} },
@@ -767,8 +729,8 @@ class Rewards {
    * @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/).
+   * @summary: Update giveaway.
+   * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
    */
   async updateGiveAway(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -850,8 +812,8 @@ class Rewards {
    * @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/).
+   * @summary: Update offer by name.
+   * @description: Modify and manage an offer using its name. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateOfferByName/).
    */
   async updateOfferByName(
     { name, body, requestHeaders } = { requestHeaders: {} },
@@ -933,8 +895,8 @@ class Rewards {
    * @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/).
+   * @summary: Update user status.
+   * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateUserStatus/).
    */
   async updateUserStatus(
     { userId, body, requestHeaders } = { requestHeaders: {} },

package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts

@@ -200,8 +200,8 @@ declare class Serviceability {
      *   - Success response
      *
      * @name updatePincodeAuditHistory
-     * @summary: Auditlog configuration of application.
-     * @description: This API returns Audit logs of Pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
+     * @summary: Update pincode audit history.
+     * @description: Modify and update audit history records for pincode-related activities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeAuditHistory/).
      */
     updatePincodeAuditHistory({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeAuditHistoryParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMopUpdateAuditHistoryResponseData>;
     /**
@@ -214,8 +214,8 @@ declare class Serviceability {
      *   - Success response
      *
      * @name updatePincodeBulkView
-     * @summary: Bulk Update of pincode in the application.
-     * @description: This API constructs bulk write operations to update the MOP data for each pincode in the payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
+     * @summary: Update pincode bulk view.
+     * @description: Modify and update views related to bulk operations on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeBulkView/).
      */
     updatePincodeBulkView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeBulkViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeBulkViewResponse>;
     /**
@@ -228,8 +228,8 @@ declare class Serviceability {
      *   - Success response
      *
      * @name updatePincodeCoDListing
-     * @summary: Pincode count view of application.
-     * @description: This API returns count of active pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
+     * @summary: Update pincode CoD (Cash on Delivery) listing.
+     * @description: Modify and update listings for CoD based on pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeCoDListing/).
      */
     updatePincodeCoDListing({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeCoDListingParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeCodStatusListingResponse>;
     /**
@@ -241,8 +241,8 @@ declare class Serviceability {
      * @returns {Promise<ServiceabilityPlatformModel.PincodeMOPresponse>} -
      *   Success response
      * @name updatePincodeMopView
-     * @summary: PincodeView update of MOP.
-     * @description: This API updates Pincode method of payment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
+     * @summary: Update pincode MOP (Mode of Payment) view.
+     * @description: Modify and update views related to pincode MOP. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updatePincodeMopView/).
      */
     updatePincodeMopView({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdatePincodeMopViewParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PincodeMOPresponse>;
     /**