@gofynd/fdk-client-javascript 0.1.35

package/sdk/application/client/ShareApplicationClient.js

@@ -0,0 +1,268 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const ShareValidator = require("../models/ShareValidator");
+
+class Share {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getApplicationQRCode: "/service/application/share/v1.0/qr/",
+      getProductQRCodeBySlug:
+        "/service/application/share/v1.0/qr/products/{slug}/",
+      getCollectionQRCodeBySlug:
+        "/service/application/share/v1.0/qr/collection/{slug}/",
+      getUrlQRCode: "/service/application/share/v1.0/qr/url/",
+      createShortLink: "/service/application/share/v1.0/links/short-link/",
+      getShortLinkByHash:
+        "/service/application/share/v1.0/links/short-link/{hash}/",
+      getOriginalShortLinkByHash:
+        "/service/application/share/v1.0/links/short-link/{hash}/original/",
+    };
+    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.
+   * @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({} = {}) {
+    const { error } = ShareValidator.getApplicationQRCode().validate(
+      {},
+      { 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["getApplicationQRCode"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.getProductQRCodeBySlug().validate(
+      { slug },
+      { 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["getProductQRCodeBySlug"],
+        params: { slug },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.getCollectionQRCodeBySlug().validate(
+      { slug },
+      { 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["getCollectionQRCodeBySlug"],
+        params: { slug },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.getUrlQRCode().validate(
+      { url },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+    const query_params = {};
+    query_params["url"] = url;
+
+    const xHeaders = {};
+
+    return APIClient.execute(
+      this._conf,
+      "post",
+      constructUrl({
+        url: this._urls["getUrlQRCode"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.createShortLink().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["createShortLink"],
+        params: {},
+      }),
+      query_params,
+      body,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.getShortLinkByHash().validate(
+      { hash },
+      { 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["getShortLinkByHash"],
+        params: { hash },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @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 } = {}) {
+    const { error } = ShareValidator.getOriginalShortLinkByHash().validate(
+      { hash },
+      { 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["getOriginalShortLinkByHash"],
+        params: { hash },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Share;

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

@@ -0,0 +1,52 @@
+export = Theme;
+declare class Theme {
+    constructor(_conf: any);
+    _conf: any;
+    _relativeUrls: {
+        getAllPages: string;
+        getPage: string;
+        getAppliedTheme: string;
+        getThemeForPreview: string;
+    };
+    _urls: {};
+    updateUrls(urls: any): void;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @returns {Promise<AllAvailablePageSchema>} - Success response
+     * @summary: Get all pages of a theme
+     * @description: Use this API to retrieve all the available pages of a theme by its ID.
+     */
+    getAllPages({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {string} arg.pageValue - Value of the page to be retrieved
+     * @returns {Promise<AvailablePageSchema>} - Success response
+     * @summary: Get page of a theme
+     * @description: Use this API to retrieve a page of a theme.
+     */
+    getPage({ themeId, pageValue }?: {
+        themeId: string;
+        pageValue: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Get the theme currently applied to an application
+     * @description: An application has multiple themes, but only one theme can be applied at a time. Use this API to retrieve the theme currently applied to the application.
+     */
+    getAppliedTheme({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @returns {Promise<ThemesSchema>} - Success response
+     * @summary: Get a theme for a preview
+     * @description: A theme can be previewed before applying it. Use this API to retrieve the preview of a theme by its ID.
+     */
+    getThemeForPreview({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+}

package/sdk/application/client/ThemeApplicationClient.js

@@ -0,0 +1,161 @@
+const APIClient = require("../ApplicationAPIClient");
+const Paginator = require("../../common/Paginator");
+const constructUrl = require("../constructUrl");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const ThemeValidator = require("../models/ThemeValidator");
+
+class Theme {
+  constructor(_conf) {
+    this._conf = _conf;
+    this._relativeUrls = {
+      getAllPages: "/service/application/theme/v1.0/{theme_id}/page",
+      getPage: "/service/application/theme/v1.0/{theme_id}/{page_value}",
+      getAppliedTheme: "/service/application/theme/v1.0/applied-theme",
+      getThemeForPreview: "/service/application/theme/v1.0/{theme_id}/preview",
+    };
+    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 {string} arg.themeId - ID of the theme to be retrieved
+   * @returns {Promise<AllAvailablePageSchema>} - Success response
+   * @summary: Get all pages of a theme
+   * @description: Use this API to retrieve all the available pages of a theme by its ID.
+   */
+  getAllPages({ themeId } = {}) {
+    const { error } = ThemeValidator.getAllPages().validate(
+      { themeId },
+      { 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["getAllPages"],
+        params: { themeId },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.themeId - ID of the theme to be retrieved
+   * @param {string} arg.pageValue - Value of the page to be retrieved
+   * @returns {Promise<AvailablePageSchema>} - Success response
+   * @summary: Get page of a theme
+   * @description: Use this API to retrieve a page of a theme.
+   */
+  getPage({ themeId, pageValue } = {}) {
+    const { error } = ThemeValidator.getPage().validate(
+      { themeId, pageValue },
+      { 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["getPage"],
+        params: { themeId, pageValue },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @returns {Promise<ThemesSchema>} - Success response
+   * @summary: Get the theme currently applied to an application
+   * @description: An application has multiple themes, but only one theme can be applied at a time. Use this API to retrieve the theme currently applied to the application.
+   */
+  getAppliedTheme({} = {}) {
+    const { error } = ThemeValidator.getAppliedTheme().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["getAppliedTheme"],
+        params: {},
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.themeId - ID of the theme to be retrieved
+   * @returns {Promise<ThemesSchema>} - Success response
+   * @summary: Get a theme for a preview
+   * @description: A theme can be previewed before applying it. Use this API to retrieve the preview of a theme by its ID.
+   */
+  getThemeForPreview({ themeId } = {}) {
+    const { error } = ThemeValidator.getThemeForPreview().validate(
+      { themeId },
+      { 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["getThemeForPreview"],
+        params: { themeId },
+      }),
+      query_params,
+      undefined,
+      xHeaders
+    );
+  }
+}
+
+module.exports = Theme;