@gofynd/fdk-client-javascript 3.3.3 → 3.3.6

package/sdk/platform/Payment/PaymentPlatformClient.js

@@ -21,7 +21,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.UpdatePayoutDetails>} - Success response
    * @name 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/).
+   * @description: Enable or disable payout functionality. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/activateAndDectivatePayout/).
    */
   async activateAndDectivatePayout(
     { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -104,7 +104,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.DeletePayoutDetails>} - Success response
    * @name 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/).
+   * @description: Remove a payout transaction from the system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/deletePayout/).
    */
   async deletePayout(
     { uniqueTransferNo, requestHeaders } = { requestHeaders: {} },
@@ -187,7 +187,7 @@ class Payment {
    *
    * @name 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/).
+   * @description: Remove a payment method from subscription options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/deleteSubscriptionPaymentMethod/).
    */
   async deleteSubscriptionPaymentMethod(
     { uniqueExternalId, paymentMethodId, requestHeaders } = {
@@ -274,7 +274,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.PayoutsDetails>} - Success response
    * @name getAllPayouts
    * @summary: List payouts
-   * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/getAllPayouts/).
+   * @description: Retrieve a list of all payout transactions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getAllPayouts/).
    */
   async getAllPayouts(
     { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -355,7 +355,7 @@ class Payment {
    *   Success response
    * @name 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/).
+   * @description: Retrieve configuration settings for subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getSubscriptionConfig/).
    */
   async getSubscriptionConfig(
     { requestHeaders } = { requestHeaders: {} },
@@ -434,7 +434,7 @@ class Payment {
    *
    * @name 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/).
+   * @description: Retrieve payment methods for subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/getSubscriptionPaymentMethod/).
    */
   async getSubscriptionPaymentMethod(
     { uniqueExternalId, requestHeaders } = { requestHeaders: {} },
@@ -516,7 +516,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.PayoutDetails>} - Success response
    * @name 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/).
+   * @description: Store and process a payout transaction. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/savePayout/).
    */
   async savePayout(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -595,7 +595,7 @@ class Payment {
    *
    * @name 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/).
+   * @description: Store and process setup intent for subscriptions. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/saveSubscriptionSetupIntent/).
    */
   async saveSubscriptionSetupIntent(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -676,7 +676,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.UpdatePayoutDetails>} - Success response
    * @name 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/).
+   * @description: Modify the details of a payout transaction. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/updatePayout/).
    */
   async updatePayout(
     { uniqueTransferNo, body, requestHeaders } = { requestHeaders: {} },
@@ -757,7 +757,7 @@ class Payment {
    * @returns {Promise<PaymentPlatformModel.IfscCodeDetails>} - Success response
    * @name verifyIfscCode
    * @summary: Verify IFSC code
-   * @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/payment/verifyIfscCode/).
+   * @description: Checks the validity of the provided IFSC code and returns bank details if valid. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/payment/verifyIfscCode/).
    */
   async verifyIfscCode(
     { ifscCode, requestHeaders } = { requestHeaders: {} },

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

@@ -544,7 +544,7 @@ export = PaymentPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -795,6 +795,8 @@ export = PaymentPlatformModel;
  *   redirected after a successful payment.
  * @property {string} [failure_redirection_url] - URL to which the user will be
  *   redirected if the payment fails.
+ * @property {boolean} [send_communication] - Flag indicating whether to send
+ *   communications (e.g., SMS or email) for the payment link
  */
 /**
  * @typedef CreatePaymentLinkDetails
@@ -868,6 +870,25 @@ export = PaymentPlatformModel;
  * @property {Object} [offline] - Details to be updated for online payment configuration.
  * @property {Object} [online] - Details to be updated for offline payment configuration.
  */
+/**
+ * @typedef SkuDetails
+ * @property {string} [identifier] - SKU identifier of the offer
+ * @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
+ * @property {string} [sku_name] - Display name of the SKU
+ */
+/**
+ * @typedef AppliedOffer
+ * @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
+ *   discount that is applied on the total order value.
+ * @property {string} [offer_type] - Type of offer. It can be either a bank or
+ *   brand offer.
+ * @property {string} [offer_id] - Unique identifier for the offer.
+ * @property {string} [description] - Description of the offer.
+ * @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
+ * @property {Object} [meta] - Extra meta data specific to extension
+ * @property {SkuDetails[]} [sku_details] - List of sku details for which the
+ *   offer is applicable. This is applicable only for brand offers.
+ */
 /**
  * @typedef OrderDetail
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -879,6 +900,7 @@ export = PaymentPlatformModel;
  * @property {Object} aggregator_order_details - Aggregator order details
  *   generated by the payment gateway.
  * @property {string} aggregator - Name of the payment gateway aggregator.
+ * @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
  */
 /**
  * @typedef AddressDetail
@@ -1271,7 +1293,7 @@ export = PaymentPlatformModel;
 declare class PaymentPlatformModel {
 }
 declare namespace PaymentPlatformModel {
-    export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
+    export { PaymentGatewayConfigDetails, ErrorCodeDescription, PaymentGatewayConfig, PaymentGatewayConfigCreation, PaymentGatewayToBeReviewed, ErrorCodeAndDescription, HttpErrorDetails, IntentAppErrorList, ProductCODData, CODChargesLimitsDetails, PaymentModeLogo, IntentApp, PaymentModeList, PaymentConfirmationElement, RootPaymentMode, PaymentOptions, AggregatorRoute, PaymentDefaultSelection, PaymentFlow, PaymentOptionAndFlow, AdvanceObject, SplitObject, AdvancePaymentObject, PaymentModeRouteDetails, PaymentOptionsDetails, PayoutCustomer, PayoutMoreAttributes, PayoutAggregator, Payout, PayoutsDetails, PayoutBankDetails, PayoutCreation, PayoutDetails, UpdatePayoutDetails, UpdatePayoutCreation, DeletePayoutDetails, SubscriptionPaymentMethodDetails, DeleteSubscriptionPaymentMethodDetails, SubscriptionConfigDetails, SaveSubscriptionSetupIntentCreation, SaveSubscriptionSetupIntentDetails, RefundAccountDetails, NotFoundResourceError, BankDetailsForOTP, AddBeneficiaryDetailsOTPCreation, IfscCodeDetails, OrderBeneficiaryDetails, OrderBeneficiaryFetchResults, MultiTenderPaymentMeta, MultiTenderPaymentMethod, PaymentConfirmationCreation, PaymentConfirmationDetails, CODdata, CODLimitConfig, CODPaymentLimitConfig, GetUserBULimitResponseSchema, GetUserCODLimitDetails, SetCODForUserCreation, SetCODOptionDetails, EdcModelData, EdcAggregatorAndModelListDetails, StatisticsData, EdcDeviceStatsDetails, EdcAddCreation, EdcDevice, EdcDeviceAddDetails, EdcDeviceDetails, EdcUpdate, EdcDeviceUpdateDetails, Page, EdcDeviceListDetails, PaymentInitializationCreation, PaymentInitializationDetails, PaymentStatusUpdateCreation, PaymentStatusUpdateDetails, ResendOrCancelPaymentCreation, LinkStatus, ResendOrCancelPaymentDetails, PaymentStatusBulkHandlerCreation, PaymentObjectList, PaymentStatusObject, PaymentStatusBulkHandlerDetails, GetOauthUrlDetails, RevokeOAuthToken, RepaymentRequestDetails, RepaymentDetailsSerialiserPayAll, RepaymentDetails, MerchantOnBoardingCreation, MerchantOnBoardingDetails, ValidateCustomerCreation, ValidateCustomerDetails, GetPaymentLinkDetails, ErrorDescription, ErrorDetails, CreatePaymentLinkMeta, CreatePaymentLinkCreation, CreatePaymentLinkDetails, PollingPaymentLinkDetails, CancelOrResendPaymentLinkCreation, ResendPaymentLinkDetails, CancelPaymentLinkDetails, Code, PaymentCode, GetPaymentCode, GetPaymentCodeDetails, PlatformPaymentModeDetails, MerchnatPaymentModeCreation, SkuDetails, AppliedOffer, OrderDetail, AddressDetail, ReasonDetail, PaymentSessionDetail, PaymentSessionCreation, PaymentSessionPutDetails, RefundSessionDetail, RefundSessionCreation, RefundSessionDetails, PaymentDetails, CartDetails, RefundDetails, PaymentSessionFetchDetails, RefundSourcesPriority, RefundPriorityDetails, RefundPriorityCreation, MerchantPaymentModeCreation, FromConfig, ToConfig, PlatformPaymentModeCopyConfigCreation, PaymentMethodsMetaOrder, PaymentOrderMethods, PaymentOrderCreation, PaymentOrderData, PaymentOrderDetails, AggregatorVersionItemSchema, AggregatorVersionDetails, AggregatorVersionRequestSchema, PatchAggregatorControl, PaymentModeCustomConfigSchema, PaymentCustomConfigDetailsSchema, PaymentCustomConfigCustomerSchema, PaymentCustomConfigModeSchema, PaymentCustomConfigDetailsRequestSchema, PaymentCustomConfigCustomerRequestSchema, PaymentCustomConfigRequestSchema, PaymentCustomConfigResponseSchema, CustomerValidationSchema, UserCreditSchema, CreditAccountSummary, ValidateCustomerCreditSchema };
 }
 /** @returns {PaymentGatewayConfigDetails} */
 declare function PaymentGatewayConfigDetails(): PaymentGatewayConfigDetails;
@@ -2696,7 +2718,7 @@ type EdcDeviceUpdateDetails = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**
@@ -3374,6 +3396,11 @@ type CreatePaymentLinkCreation = {
      * redirected if the payment fails.
      */
     failure_redirection_url?: string;
+    /**
+     * - Flag indicating whether to send
+     * communications (e.g., SMS or email) for the payment link
+     */
+    send_communication?: boolean;
 };
 /** @returns {CreatePaymentLinkDetails} */
 declare function CreatePaymentLinkDetails(): CreatePaymentLinkDetails;
@@ -3566,6 +3593,57 @@ type MerchnatPaymentModeCreation = {
      */
     online?: any;
 };
+/** @returns {SkuDetails} */
+declare function SkuDetails(): SkuDetails;
+type SkuDetails = {
+    /**
+     * - SKU identifier of the offer
+     */
+    identifier?: string;
+    /**
+     * - Unique SKU identifier (example: GTIN, variant ID)
+     */
+    sku_id?: string;
+    /**
+     * - Display name of the SKU
+     */
+    sku_name?: string;
+};
+/** @returns {AppliedOffer} */
+declare function AppliedOffer(): AppliedOffer;
+type AppliedOffer = {
+    /**
+     * - Whether the offer is a mop or not. MOP is a
+     * discount that is applied on the total order value.
+     */
+    is_mop?: boolean;
+    /**
+     * - Type of offer. It can be either a bank or
+     * brand offer.
+     */
+    offer_type?: string;
+    /**
+     * - Unique identifier for the offer.
+     */
+    offer_id?: string;
+    /**
+     * - Description of the offer.
+     */
+    description?: string;
+    /**
+     * - Amount of the offer in paise. (Example: ₹1 = 100 paise)
+     */
+    amount?: number;
+    /**
+     * - Extra meta data specific to extension
+     */
+    meta?: any;
+    /**
+     * - List of sku details for which the
+     * offer is applicable. This is applicable only for brand offers.
+     */
+    sku_details?: SkuDetails[];
+};
 /** @returns {OrderDetail} */
 declare function OrderDetail(): OrderDetail;
 type OrderDetail = {
@@ -3596,6 +3674,10 @@ type OrderDetail = {
      * - Name of the payment gateway aggregator.
      */
     aggregator: string;
+    /**
+     * - List of offers applied on the order.
+     */
+    applied_offers?: AppliedOffer[];
 };
 /** @returns {AddressDetail} */
 declare function AddressDetail(): AddressDetail;

package/sdk/platform/Payment/PaymentPlatformModel.js

@@ -614,7 +614,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -891,6 +891,8 @@ const Joi = require("joi");
  *   redirected after a successful payment.
  * @property {string} [failure_redirection_url] - URL to which the user will be
  *   redirected if the payment fails.
+ * @property {boolean} [send_communication] - Flag indicating whether to send
+ *   communications (e.g., SMS or email) for the payment link
  */
 
 /**
@@ -976,6 +978,27 @@ const Joi = require("joi");
  * @property {Object} [online] - Details to be updated for offline payment configuration.
  */
 
+/**
+ * @typedef SkuDetails
+ * @property {string} [identifier] - SKU identifier of the offer
+ * @property {string} [sku_id] - Unique SKU identifier (example: GTIN, variant ID)
+ * @property {string} [sku_name] - Display name of the SKU
+ */
+
+/**
+ * @typedef AppliedOffer
+ * @property {boolean} [is_mop] - Whether the offer is a mop or not. MOP is a
+ *   discount that is applied on the total order value.
+ * @property {string} [offer_type] - Type of offer. It can be either a bank or
+ *   brand offer.
+ * @property {string} [offer_id] - Unique identifier for the offer.
+ * @property {string} [description] - Description of the offer.
+ * @property {number} [amount] - Amount of the offer in paise. (Example: ₹1 = 100 paise)
+ * @property {Object} [meta] - Extra meta data specific to extension
+ * @property {SkuDetails[]} [sku_details] - List of sku details for which the
+ *   offer is applicable. This is applicable only for brand offers.
+ */
+
 /**
  * @typedef OrderDetail
  * @property {string} gid - Global identifier of the entity (e.g. order, cart
@@ -987,6 +1010,7 @@ const Joi = require("joi");
  * @property {Object} aggregator_order_details - Aggregator order details
  *   generated by the payment gateway.
  * @property {string} aggregator - Name of the payment gateway aggregator.
+ * @property {AppliedOffer[]} [applied_offers] - List of offers applied on the order.
  */
 
 /**
@@ -2509,6 +2533,7 @@ class PaymentPlatformModel {
       external_order_id: Joi.string().allow("").required(),
       success_redirection_url: Joi.string().allow(""),
       failure_redirection_url: Joi.string().allow(""),
+      send_communication: Joi.boolean(),
     });
   }
 
@@ -2617,6 +2642,28 @@ class PaymentPlatformModel {
     });
   }
 
+  /** @returns {SkuDetails} */
+  static SkuDetails() {
+    return Joi.object({
+      identifier: Joi.string().allow(""),
+      sku_id: Joi.string().allow(""),
+      sku_name: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AppliedOffer} */
+  static AppliedOffer() {
+    return Joi.object({
+      is_mop: Joi.boolean(),
+      offer_type: Joi.string().allow(""),
+      offer_id: Joi.string().allow(""),
+      description: Joi.string().allow(""),
+      amount: Joi.number(),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
+      sku_details: Joi.array().items(PaymentPlatformModel.SkuDetails()),
+    });
+  }
+
   /** @returns {OrderDetail} */
   static OrderDetail() {
     return Joi.object({
@@ -2628,6 +2675,7 @@ class PaymentPlatformModel {
         .pattern(/\S/, Joi.any())
         .required(),
       aggregator: Joi.string().allow("").required(),
+      applied_offers: Joi.array().items(PaymentPlatformModel.AppliedOffer()),
     });
   }
 

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

@@ -10,7 +10,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name getGiveawayById
      * @summary: Get a giveaway
-     * @description: Retrieve specific giveaway details by its unique identifier. - 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://docs.fynd.com/partners/commerce/sdk/platform/rewards/getGiveawayById/).
      */
     getGiveawayById({ id, requestHeaders }?: RewardsPlatformApplicationValidator.GetGiveawayByIdParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -20,7 +20,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
      * @name 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/).
+     * @description: Retrieve an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getOfferByName/).
      */
     getOfferByName({ name, requestHeaders }?: RewardsPlatformApplicationValidator.GetOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
@@ -32,7 +32,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
      * @name 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/).
+     * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getRewardsConfiguration/).
      */
     getRewardsConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.ConfigurationRes>;
     /**
@@ -42,7 +42,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
      * @name getUserDetails
      * @summary: Get a user
-     * @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/).
+     * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getUserDetails/).
      */
     getUserDetails({ userId, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserDetailsParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.UserRes>;
     /**
@@ -54,7 +54,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
      * @name getUserPointsHistory
      * @summary: Get reward 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/).
+     * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getUserPointsHistory/).
      */
     getUserPointsHistory({ userId, pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.GetUserPointsHistoryParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.HistoryRes>;
     /**
@@ -64,7 +64,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name saveGiveAway
      * @summary: Create a giveaway
-     * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
+     * @description: Store and manage details of a giveaway. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/saveGiveAway/).
      */
     saveGiveAway({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SaveGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -76,7 +76,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
      * @name 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/).
+     * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/setRewardsConfiguration/).
      */
     setRewardsConfiguration({ body, requestHeaders }?: RewardsPlatformApplicationValidator.SetRewardsConfigurationParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.SetConfigurationRes>;
     /**
@@ -86,7 +86,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.ListGiveaway>} - Success response
      * @name showGiveaways
      * @summary: List giveaways
-     * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
+     * @description: Retrieve and display available giveaways. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/showGiveaways/).
      */
     showGiveaways({ pageId, pageSize, requestHeaders }?: RewardsPlatformApplicationValidator.ShowGiveawaysParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.ListGiveaway>;
     /**
@@ -96,7 +96,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
      * @name showOffers
      * @summary: List offers
-     * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
+     * @description: Display available offers for users. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/showOffers/).
      */
     showOffers({ requestHeaders }?: any, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer[]>;
     /**
@@ -106,7 +106,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
      * @name updateGiveAway
      * @summary: Update a giveaway
-     * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
+     * @description: Modify and update information about a giveaway. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateGiveAway/).
      */
     updateGiveAway({ id, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateGiveAwayParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Giveaway>;
     /**
@@ -118,7 +118,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
      * @name 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/).
+     * @description: Modify and manage an offer using its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateOfferByName/).
      */
     updateOfferByName({ name, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateOfferByNameParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.Offer>;
     /**
@@ -128,7 +128,7 @@ declare class Rewards {
      * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
      * @name 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/).
+     * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateUserStatus/).
      */
     updateUserStatus({ userId, body, requestHeaders }?: RewardsPlatformApplicationValidator.UpdateUserStatusParam, { responseHeaders }?: object): Promise<RewardsPlatformModel.AppUser>;
 }

package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js

@@ -22,7 +22,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
    * @name getGiveawayById
    * @summary: Get a giveaway
-   * @description: Retrieve specific giveaway details by its unique identifier. - 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://docs.fynd.com/partners/commerce/sdk/platform/rewards/getGiveawayById/).
    */
   async getGiveawayById(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -101,7 +101,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
    * @name 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/).
+   * @description: Retrieve an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getOfferByName/).
    */
   async getOfferByName(
     { name, requestHeaders } = { requestHeaders: {} },
@@ -178,7 +178,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.ConfigurationRes>} - Success response
    * @name 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/).
+   * @description: Retrieve the configuration settings for the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getRewardsConfiguration/).
    */
   async getRewardsConfiguration(
     { requestHeaders } = { requestHeaders: {} },
@@ -253,7 +253,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.UserRes>} - Success response
    * @name getUserDetails
    * @summary: Get a user
-   * @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/).
+   * @description: Retrieve comprehensive details about a user in the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getUserDetails/).
    */
   async getUserDetails(
     { userId, requestHeaders } = { requestHeaders: {} },
@@ -330,7 +330,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.HistoryRes>} - Success response
    * @name getUserPointsHistory
    * @summary: Get reward 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/).
+   * @description: Retrieve the history of points earned and redeemed by a user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/getUserPointsHistory/).
    */
   async getUserPointsHistory(
     { userId, pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -417,7 +417,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
    * @name saveGiveAway
    * @summary: Create a giveaway
-   * @description: Store and manage details of a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/saveGiveAway/).
+   * @description: Store and manage details of a giveaway. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/saveGiveAway/).
    */
   async saveGiveAway(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -498,7 +498,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.SetConfigurationRes>} - Success response
    * @name 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/).
+   * @description: Configure and modify the settings for the rewards program. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/setRewardsConfiguration/).
    */
   async setRewardsConfiguration(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -577,7 +577,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.ListGiveaway>} - Success response
    * @name showGiveaways
    * @summary: List giveaways
-   * @description: Retrieve and display available giveaways. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showGiveaways/).
+   * @description: Retrieve and display available giveaways. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/showGiveaways/).
    */
   async showGiveaways(
     { pageId, pageSize, requestHeaders } = { requestHeaders: {} },
@@ -660,7 +660,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Offer[]>} - Success response
    * @name showOffers
    * @summary: List offers
-   * @description: Display available offers for users. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/showOffers/).
+   * @description: Display available offers for users. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/showOffers/).
    */
   async showOffers(
     { requestHeaders } = { requestHeaders: {} },
@@ -730,7 +730,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Giveaway>} - Success response
    * @name updateGiveAway
    * @summary: Update a giveaway
-   * @description: Modify and update information about a giveaway. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/rewards/updateGiveAway/).
+   * @description: Modify and update information about a giveaway. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateGiveAway/).
    */
   async updateGiveAway(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -813,7 +813,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.Offer>} - Success response
    * @name 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/).
+   * @description: Modify and manage an offer using its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateOfferByName/).
    */
   async updateOfferByName(
     { name, body, requestHeaders } = { requestHeaders: {} },
@@ -896,7 +896,7 @@ class Rewards {
    * @returns {Promise<RewardsPlatformModel.AppUser>} - Success response
    * @name 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/).
+   * @description: Change and update the status of a user in the rewards system. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/rewards/updateUserStatus/).
    */
   async updateUserStatus(
     { userId, body, requestHeaders } = { requestHeaders: {} },

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

@@ -50,7 +50,7 @@ export = RewardsPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.
@@ -228,7 +228,7 @@ type RewardsRule = {
 declare function Page(): Page;
 type Page = {
     /**
-     * - The total number of items on the page.
+     * - The total number of all items across all pages.
      */
     item_total?: number;
     /**

package/sdk/platform/Rewards/RewardsPlatformModel.js

@@ -58,7 +58,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total] - The total number of items on the page.
+ * @property {number} [item_total] - The total number of all items across all pages.
  * @property {string} [next_id] - The identifier for the next page.
  * @property {boolean} [has_previous] - Indicates whether there is a previous page.
  * @property {boolean} [has_next] - Indicates whether there is a next page.