@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/RewardsApplicationClient.d.ts

@@ -0,0 +1,93 @@
+export = Rewards;
+declare class Rewards {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getPointsOnProduct: string;
+        getOfferByName: string;
+        getOrderDiscount: string;
+        getUserPoints: string;
+        getUserPointsHistory: string;
+        getUserReferralDetails: string;
+        redeemReferralCode: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {CatalogueOrderRequest} arg.body
+     * @returns {Promise<CatalogueOrderResponse>} - Success response
+     * @summary: Get the eligibility of reward points on a product
+     * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
+     */
+    getPointsOnProduct({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.name - The name given to the offer.
+     * @returns {Promise<Offer>} - Success response
+     * @summary: Get offer by name
+     * @description: Use this API to get the offer details and configuration by entering the name of the offer.
+     */
+    getOfferByName({ name }?: {
+        name: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {OrderDiscountRequest} arg.body
+     * @returns {Promise<OrderDiscountResponse>} - Success response
+     * @summary: Calculates the discount on order-amount
+     * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+     */
+    getOrderDiscount({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<PointsResponse>} - Success response
+     * @summary: Get reward points available with a user
+     * @description: Use this API to retrieve total available points of a user for current application
+     */
+    getUserPoints({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.pageId] - PageID is the ID of the requested page.
+     *   For first request it should be kept empty.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @returns {Promise<PointsHistoryResponse>} - Success response
+     * @summary: Get all transactions of reward points
+     * @description: Use this API to get a list of points transactions. The list of points history is paginated.
+     */
+    getUserPointsHistory({ pageId, pageSize }?: {
+        pageId?: string;
+        pageSize?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+     * @summary: Get all transactions of reward points
+     * @description: Use this API to get a list of points transactions. The list of points history is paginated.
+     */
+    getUserPointsHistoryPaginator({ pageSize }?: {
+        pageSize?: number;
+    }): Paginator;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ReferralDetailsResponse>} - Success response
+     * @summary: Get referral details of a user
+     * @description: Use this API to retrieve the referral details a user has configured in the application.
+     */
+    getUserReferralDetails({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {RedeemReferralCodeRequest} arg.body
+     * @returns {Promise<RedeemReferralCodeResponse>} - Success response
+     * @summary: Redeems a referral code and credits reward points to users
+     * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.
+     */
+    redeemReferralCode({ body }?: {
+        body: any;
+    }): Promise<any>;
+}
+import Paginator = require("../../common/Paginator");

package/sdk/application/client/RewardsApplicationClient.js

@@ -0,0 +1,293 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const RewardsValidator = require("../models/RewardsValidator");
+
+class Rewards {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getPointsOnProduct:
+        "/service/application/rewards/v1.0/catalogue/offer/order/",
+      getOfferByName: "/service/application/rewards/v1.0/offers/{name}/",
+      getOrderDiscount:
+        "/service/application/rewards/v1.0/user/offers/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 - Arg object.
+   * @param {CatalogueOrderRequest} arg.body
+   * @returns {Promise<CatalogueOrderResponse>} - Success response
+   * @summary: Get the eligibility of reward points on a product
+   * @description: Use this API to evaluate the amount of reward points that could be earned on any catalogue product.
+   */
+  getPointsOnProduct({ body } = {}) {
+    const { error } = RewardsValidator.getPointsOnProduct().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["getPointsOnProduct"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.name - The name given to the offer.
+   * @returns {Promise<Offer>} - Success response
+   * @summary: Get offer by name
+   * @description: Use this API to get the offer details and configuration by entering the name of the offer.
+   */
+  getOfferByName({ name } = {}) {
+    const { error } = RewardsValidator.getOfferByName().validate(
+      { name },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getOfferByName"],
+        params: { name },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {OrderDiscountRequest} arg.body
+   * @returns {Promise<OrderDiscountResponse>} - Success response
+   * @summary: Calculates the discount on order-amount
+   * @description: Use this API to calculate the discount on order-amount based on all the amount range configured in order_discount.
+   */
+  getOrderDiscount({ body } = {}) {
+    const { error } = RewardsValidator.getOrderDiscount().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["getOrderDiscount"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<PointsResponse>} - Success response
+   * @summary: Get reward points available with a user
+   * @description: Use this API to retrieve total available points of a user for current application
+   */
+  getUserPoints({} = {}) {
+    const { error } = RewardsValidator.getUserPoints().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getUserPoints"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.pageId] - PageID is the ID of the requested page.
+   *   For first request it should be kept empty.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @returns {Promise<PointsHistoryResponse>} - Success response
+   * @summary: Get all transactions of reward points
+   * @description: Use this API to get a list of points transactions. The list of points history is paginated.
+   */
+  getUserPointsHistory({ pageId, pageSize } = {}) {
+    const { error } = RewardsValidator.getUserPointsHistory().validate(
+      { pageId, pageSize },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["page_id"] = pageId;
+    query_params["page_size"] = pageSize;
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getUserPointsHistory"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {number} [arg.pageSize] - The number of items to retrieve in each page.
+   * @summary: Get all transactions of reward points
+   * @description: Use this API to get a list of points transactions. The list of points history is paginated.
+   */
+  getUserPointsHistoryPaginator({ pageSize } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "cursor";
+      const data = await this.getUserPointsHistory({
+        pageId: pageId,
+        pageSize: pageSize,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<ReferralDetailsResponse>} - Success response
+   * @summary: Get referral details of a user
+   * @description: Use this API to retrieve the referral details a user has configured in the application.
+   */
+  getUserReferralDetails({} = {}) {
+    const { error } = RewardsValidator.getUserReferralDetails().validate(
+      {},
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "get",
+      constructUrl({
+        url: this._urls["getUserReferralDetails"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {RedeemReferralCodeRequest} arg.body
+   * @returns {Promise<RedeemReferralCodeResponse>} - Success response
+   * @summary: Redeems a referral code and credits reward points to users
+   * @description: Use this API to enter a referral code following which, the configured points would be credited to a user's reward points account.
+   */
+  redeemReferralCode({ body } = {}) {
+    const { error } = RewardsValidator.redeemReferralCode().validate(
+      { body },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["redeemReferralCode"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Rewards;

package/sdk/application/client/ShareApplicationClient.d.ts

@@ -0,0 +1,87 @@
+export = Share;
+declare class Share {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getApplicationQRCode: string;
+        getProductQRCodeBySlug: string;
+        getCollectionQRCodeBySlug: string;
+        getUrlQRCode: string;
+        createShortLink: string;
+        getShortLinkByHash: string;
+        getOriginalShortLinkByHash: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of an app
+     * @description: Use this API to create a QR code of an app for sharing it with users who want to use the app.
+     */
+    getApplicationQRCode({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slug - A short, human-readable, URL-friendly
+     *   identifier of a product. You can get slug value from the endpoint.
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of a product
+     * @description: Use this API to create a QR code of a product for sharing it with users who want to view/purchase the product.
+     */
+    getProductQRCodeBySlug({ slug }?: {
+        slug: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slug - A short, human-readable, URL-friendly
+     *   identifier of a collection. You can get slug value from the endpoint.
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of a collection
+     * @description: Use this API to create a QR code of a collection of products for sharing it with users who want to view/purchase the collection.
+     */
+    getCollectionQRCodeBySlug({ slug }?: {
+        slug: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.url - A link or a web address
+     * @returns {Promise<QRCodeResp>} - Success response
+     * @summary: Create QR Code of a URL
+     * @description: Use this API to create a QR code of a URL for sharing it with users who want to visit the link.
+     */
+    getUrlQRCode({ url }?: {
+        url: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ShortLinkReq} arg.body
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Create a short link
+     * @description: Use this API to create a short link that is easy to write/share/read as compared to long URLs.
+     */
+    createShortLink({ body }?: {
+        body: any;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.hash - A string value used for converting long URL to
+     *   short URL and vice-versa.
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Get short link by hash
+     * @description: Use this API to get a short link by using a hash value.
+     */
+    getShortLinkByHash({ hash }?: {
+        hash: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.hash - A string value used for converting long URL to
+     *   short URL and vice-versa.
+     * @returns {Promise<ShortLinkRes>} - Success response
+     * @summary: Get original link by hash
+     * @description: Use this API to retrieve the original link from a short-link by using a hash value.
+     */
+    getOriginalShortLinkByHash({ hash }?: {
+        hash: string;
+    }): Promise<any>;
+}