@gofynd/fdk-client-javascript 3.16.3 → 3.17.1

package/sdk/application/Rewards/RewardsApplicationClient.js

@@ -1,315 +0,0 @@
-const {
-  FDKClientValidationError,
-  FDKResponseValidationError,
-} = require("../../common/FDKError");
-
-const ApplicationAPIClient = require("../ApplicationAPIClient");
-const constructUrl = require("../constructUrl");
-const Paginator = require("../../common/Paginator");
-const { validateRequiredParams } = require("../../common/Validator");
-
-class Rewards {
-  constructor(_conf) {
-    this._conf = _conf;
-    this._relativeUrls = {
-      catalogueOrder:
-        "/service/application/rewards/v1.0/catalogue/offer/order/",
-      getOfferByName: "/service/application/rewards/v1.0/offers/{name}/",
-      getOrderDiscount:
-        "/service/application/rewards/v1.0/user/offer/order-discount/",
-      getUserPoints: "/service/application/rewards/v1.0/user/points/",
-      getUserPointsHistory:
-        "/service/application/rewards/v1.0/user/points/history/",
-      getUserReferralDetails:
-        "/service/application/rewards/v1.0/user/referral/",
-      redeemReferralCode:
-        "/service/application/rewards/v1.0/user/referral/redeem/",
-    };
-    this._urls = Object.entries(this._relativeUrls).reduce(
-      (urls, [method, relativeUrl]) => {
-        urls[method] = `${_conf.domain}${relativeUrl}`;
-        return urls;
-      },
-      {}
-    );
-  }
-
-  updateUrls(urls) {
-    this._urls = {
-      ...this._urls,
-      ...urls,
-    };
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<CatalogueOrderDetails>} - Success response
-   * @name catalogueOrder
-   * @summary: Order from catalogue
-   * @description: Place a reward on order items available in the catalogue. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/catalogueOrder/).
-   */
-  async catalogueOrder(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["catalogueOrder"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<Offer>} - Success response
-   * @name getOfferByName
-   * @summary: Get specific offer
-   * @description: Retrieves detailed information about an offer by its name. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOfferByName/).
-   */
-  async getOfferByName(
-    { name, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const errors = validateRequiredParams(arguments[0], ["name"]);
-    if (errors.length > 0) {
-      const error = new FDKClientValidationError({
-        message: "Missing required field",
-        details: errors,
-      });
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getOfferByName"],
-        params: { name },
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<OrderDiscountDetails>} - Success response
-   * @name getOrderDiscount
-   * @summary: Order discount
-   * @description: Retrieve the discount applied to a specific order. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getOrderDiscount/).
-   */
-  async getOrderDiscount(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["getOrderDiscount"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PointsDetails>} - Success response
-   * @name getUserPoints
-   * @summary: Current points
-   * @description: Retrieves the current reward points balance for the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPoints/).
-   */
-  async getUserPoints(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserPoints"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<PointsHistoryDetails>} - Success response
-   * @name getUserPointsHistory
-   * @summary: Points history
-   * @description: Gets the historical data of points earned or spent by the user. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserPointsHistory/).
-   */
-  async getUserPointsHistory(
-    { pageId, pageSize, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-    query_params["page_id"] = pageId;
-    query_params["page_size"] = pageSize;
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserPointsHistory"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<ReferralDetails>} - Success response
-   * @name getUserReferralDetails
-   * @summary: Referral details
-   * @description: Gets the details of the user’s referral status and codes. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/getUserReferralDetails/).
-   */
-  async getUserReferralDetails(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "get",
-      constructUrl({
-        url: this._urls["getUserReferralDetails"],
-        params: {},
-      }),
-      query_params,
-      undefined,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<RedeemReferralCodeDetails>} - Success response
-   * @name redeemReferralCode
-   * @summary: Redeem code
-   * @description: Applies a referral code to earn or redeem rewards. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/rewards/redeemReferralCode/).
-   */
-  async redeemReferralCode(
-    { body, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const query_params = {};
-
-    const xHeaders = {};
-
-    const response = await ApplicationAPIClient.execute(
-      this._conf,
-      "post",
-      constructUrl({
-        url: this._urls["redeemReferralCode"],
-        params: {},
-      }),
-      query_params,
-      body,
-      { ...xHeaders, ...requestHeaders },
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    return response;
-  }
-}
-
-module.exports = Rewards;

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

@@ -1,136 +0,0 @@
-export = Rewards;
-declare class Rewards {
-    constructor(config: any, applicationId: any);
-    config: any;
-    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 a giveaway
-     * @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>;
-    /**
-     * @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: Get offer by name
-     * @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>;
-    /**
-     * @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 rewards configuration
-     * @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>;
-    /**
-     * @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 a user
-     * @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>;
-    /**
-     * @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 reward user points history
-     * @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>;
-    /**
-     * @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: Create a giveaway
-     * @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>;
-    /**
-     * @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: Set rewards configuration
-     * @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>;
-    /**
-     * @param {RewardsPlatformApplicationValidator.ShowGiveawaysParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<RewardsPlatformModel.ListGiveaway>} - Success response
-     * @name showGiveaways
-     * @summary: List giveaways
-     * @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>;
-    /**
-     * @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 offers
-     * @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[]>;
-    /**
-     * @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: Update a giveaway
-     * @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>;
-    /**
-     * @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: 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>;
-    /**
-     * @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: 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>;
-}
-import RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
-import RewardsPlatformModel = require("./RewardsPlatformModel");