@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1

package/sdk/common/utils.js

@@ -1,3 +1,5 @@
+const { FDKException } = require("./FDKError");
+
 const SLUG_DELIMETER = ":::";
 const transformRequestOptions = (params) => {
   let options = "";
@@ -153,6 +155,30 @@ const NAV_TYPE = {
   POPUP: "popup",
 };
 
+const isBrowser = () => {
+  return (
+    typeof window !== "undefined" && typeof window.document !== "undefined"
+  );
+};
+
+const isNode = () => {
+  return (
+    typeof process !== "undefined" &&
+    process.versions != null &&
+    process.versions.node != null
+  );
+};
+
+const convertStringToBase64 = (string) => {
+  if (isNode()) {
+    return Buffer.from(string, "utf-8").toString("base64");
+  } else if (isBrowser()) {
+    return window.btoa(string);
+  } else {
+    throw FDKException("Base64 conversion error: Unsupported environment");
+  }
+};
+
 module.exports = {
   transformRequestOptions,
   getParamsFromItem,
@@ -161,5 +187,8 @@ module.exports = {
   generateUrlWithParams,
   findBestMatchingLink,
   validURL,
+  convertStringToBase64,
+  isBrowser,
+  isNode,
   NAV_TYPE,
 };

package/sdk/partner/PartnerAPIClient.d.ts

@@ -1,7 +1,7 @@
 export = APIClient;
 /**
  * @typedef {Object} Options
- * @property {boolean} headers - Whether headers are returned or not.
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
  */
 declare class APIClient {
     /**
@@ -10,9 +10,10 @@ declare class APIClient {
      * @param {string} url
      * @param {object} query
      * @param {object} body
+     * @param {object} xHeaders
      * @param {Options} options
      */
-    static execute(conf: object, method: string, url: string, query: object, body: object, options: Options): Promise<any>;
+    static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<any>;
     get(url: any, config: any): Promise<any>;
 }
 declare namespace APIClient {
@@ -20,7 +21,7 @@ declare namespace APIClient {
 }
 type Options = {
     /**
-     * - Whether headers are returned or not.
+     * - Whether response headers are returned or not.
      */
-    headers: boolean;
+    responseHeaders: boolean;
 };

package/sdk/partner/PartnerAPIClient.js

@@ -2,7 +2,7 @@ const { fdkAxios } = require("../common/AxiosHelper");
 
 /**
  * @typedef {Object} Options
- * @property {boolean} headers - Whether headers are returned or not.
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
  */
 
 class APIClient {
@@ -12,9 +12,10 @@ class APIClient {
    * @param {string} url
    * @param {object} query
    * @param {object} body
+   * @param {object} xHeaders
    * @param {Options} options
    */
-  static async execute(conf, method, url, query, body, options) {
+  static async execute(conf, method, url, query, body, xHeaders, options) {
     const token = await conf.oauthClient.getNewAccessToken();
 
     const extraHeaders = conf.extraHeaders.reduce((acc, curr) => {
@@ -22,7 +23,7 @@ class APIClient {
       return acc;
     }, {});
 
-    const rawRequest = {
+    let rawRequest = {
       baseURL: conf.domain,
       method: method,
       url: url,
@@ -31,9 +32,11 @@ class APIClient {
       headers: {
         Authorization: "Bearer " + token,
         ...extraHeaders,
+        ...xHeaders,
       },
-      _returnHeaders: options.headers,
+      responseHeaders: options.responseHeaders,
     };
+    rawRequest = JSON.parse(JSON.stringify(rawRequest));
 
     return fdkAxios.request(rawRequest);
   }

package/sdk/partner/PartnerClient.d.ts

@@ -13,6 +13,7 @@ declare class PartnerClient {
      */
     constructor(config: import("./PartnerConfig"));
     config: import("./PartnerConfig");
+    theme: Theme;
     /**
      * Sets the extra headers for the partner client.
      *
@@ -21,3 +22,4 @@ declare class PartnerClient {
      */
     setExtraHeaders(header: object): void;
 }
+import Theme = require("./Theme/ThemePartnerClient");

package/sdk/partner/PartnerClient.js

@@ -1,3 +1,5 @@
+const Theme = require("./Theme/ThemePartnerClient");
+
 const { FDKClientValidationError } = require("../common/FDKError");
 
 /**
@@ -14,6 +16,7 @@ class PartnerClient {
    */
   constructor(config) {
     this.config = config;
+    this.theme = new Theme(config);
   }
 
   /**

package/sdk/partner/Theme/ThemePartnerClient.d.ts

@@ -0,0 +1,299 @@
+export = Theme;
+declare class Theme {
+    constructor(config: any);
+    config: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get all pages of a theme
+     * @description: Use this API to retrieve all the available pages of a theme by its ID.
+     */
+    getAllPages({ companyId, applicationId, themeId, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme
+     * @param {AvailablePageSchema} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Create a page
+     * @description: Use this API to create a page for a theme by its ID.
+     */
+    createPage({ companyId, applicationId, themeId, body, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        body: AvailablePageSchema;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {AllAvailablePageSchema} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Update multiple pages of a theme
+     * @description: Use this API to update multiple pages of a theme by its ID.
+     */
+    updateMultiplePages({ companyId, applicationId, themeId, body, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        body: AllAvailablePageSchema;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {string} arg.pageValue - Value of the page to be retrieved
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get page of a theme
+     * @description: Use this API to retrieve a page of a theme.
+     */
+    getPage({ companyId, applicationId, themeId, pageValue, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        pageValue: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme
+     * @param {string} arg.pageValue - Value of the page to be updated
+     * @param {AvailablePageSchema} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Updates a page
+     * @description: Use this API to update a page for a theme by its ID.
+     */
+    updatePage({ companyId, applicationId, themeId, pageValue, body, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        pageValue: string;
+        body: AvailablePageSchema;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - Company ID
+     * @param {string} arg.applicationId - Application ID
+     * @param {string} arg.themeId - ID of the theme
+     * @param {string} arg.pageValue - Value of the page to be updated
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Deletes a page
+     * @description: Use this API to delete a page for a theme by its ID and page_value.
+     */
+    deletePage({ companyId, applicationId, themeId, pageValue, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        pageValue: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - The ID of the company
+     * @param {string} arg.applicationId - The ID of the application
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get all the themes for a specific application
+     * @description: Use this API to get list of theme
+     */
+    getApplicationThemes({ companyId, applicationId, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - The ID of the company
+     * @param {string} arg.applicationId - The ID of the application
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get Theme By Theme Id
+     * @description: Use this API to get theme details
+     */
+    getThemeById({ companyId, applicationId, themeId, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - The ID of the company.
+     * @param {string} arg.applicationId - The ID of the application.
+     * @param {string} arg.themeId - The ID of the theme.
+     * @param {UpdateThemeRequestBody} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Update theme for a specific company and application
+     * @description: Update theme for a specific company and application
+     */
+    updateTheme({ companyId, applicationId, themeId, body, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        body: UpdateThemeRequestBody;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} arg.companyId - The ID of the company.
+     * @param {string} arg.applicationId - The ID of the application.
+     * @param {string} arg.themeId - The ID of the theme to be deleted.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Delete a theme
+     * @description: This endpoint is used to delete a theme from the specified company and application.
+     */
+    deleteTheme({ companyId, applicationId, themeId, requestHeaders }?: {
+        companyId: number;
+        applicationId: string;
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.status] - The status of the theme
+     * @param {number} [arg.pageSize] - Number of themes per page
+     * @param {number} [arg.pageNo] - Page number to retrieve
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get organization's themes
+     * @description: Get organization's themes
+     */
+    getOrganizationThemes({ status, pageSize, pageNo, requestHeaders }?: {
+        status?: string;
+        pageSize?: number;
+        pageNo?: number;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get theme details for an organization
+     * @description: Fetches the theme details for a specific organization and theme ID
+     */
+    getOrganizationThemeDetails({ themeId, requestHeaders }?: {
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {MarketplaceTheme} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Update theme draft/submitted
+     * @description: Update theme draft/submitted
+     */
+    updateDraftTheme({ themeId, body, requestHeaders }?: {
+        themeId: string;
+        body: MarketplaceTheme;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {MarketplaceTheme} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Submit a theme
+     * @description: Use this api to Submit a theme
+     */
+    submitOrganizationTheme({ themeId, body, requestHeaders }?: {
+        themeId: string;
+        body: MarketplaceTheme;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Delete a theme
+     * @description: This endpoint allows you to delete a theme by providing the organization and theme IDs.
+     */
+    deleteOrganizationTheme({ themeId, requestHeaders }?: {
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.slugName - Slug of theme
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get latest version of specified theme
+     * @description: Use this api to get latest version of specified theme
+     */
+    getLatestVersionOfThemeBySlug({ slugName, requestHeaders }?: {
+        slugName: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} [arg.slug] - The slug of the theme.
+     * @param {MarketplaceTheme} arg.body
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Create a new theme for the organization
+     * @description: Use this api to create a new theme for the organization
+     */
+    createNewThemeInOrganization({ body, slug, requestHeaders }?: {
+        slug?: string;
+        body: MarketplaceTheme;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - The ID of the theme
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get theme rejection reasons
+     * @description: Use this api to get theme rejection reasons
+     */
+    getThemeRejectionReasons({ themeId, requestHeaders }?: {
+        themeId: string;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeSlug - The slug of the theme.
+     * @param {number} [arg.pageSize] - The number of items to return per page.
+     * @param {number} [arg.pageNo] - The page number to return.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PartnerAPIClient").Options} - Options
+     * @summary: Get theme versions
+     * @description: Retrieve a list of theme versions for a specific theme in an organization.
+     */
+    getThemeVersions({ themeSlug, pageSize, pageNo, requestHeaders }?: {
+        themeSlug: string;
+        pageSize?: number;
+        pageNo?: number;
+        requestHeaders?: object;
+    }, { responseHeaders }?: import("../PartnerAPIClient").Options): Promise<any>;
+}