@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

package/sdk/partner/PartnerAPIClient.d.ts

@@ -1,4 +1,8 @@
 export = APIClient;
+/**
+ * @typedef {Object} Options
+ * @property {boolean} responseHeaders - Whether response headers are returned or not.
+ */
 declare class APIClient {
     /**
      * @param {object} conf
@@ -6,7 +10,18 @@ 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): 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 {
+    export { Options };
+}
+type Options = {
+    /**
+     * - Whether response headers are returned or not.
+     */
+    responseHeaders: boolean;
+};

package/sdk/partner/PartnerAPIClient.js

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

package/sdk/partner/PartnerClient.d.ts

@@ -1,6 +1,25 @@
 export = PartnerClient;
+/**
+ * Represents the client for the partner APIs.
+ *
+ * @class
+ */
 declare class PartnerClient {
-    constructor(config: any);
-    config: any;
-    setExtraHeaders(header: any): void;
+    /**
+     * Creates an instance of PartnerClient.
+     *
+     * @param {import("./PartnerConfig")} config - The configuration for the
+     *   partner client.
+     */
+    constructor(config: import("./PartnerConfig"));
+    config: import("./PartnerConfig");
+    theme: Theme;
+    /**
+     * Sets the extra headers for the partner client.
+     *
+     * @param {object} header - The header object to set.
+     * @throws {FDKClientValidationError} When the provided header is not an object.
+     */
+    setExtraHeaders(header: object): void;
 }
+import Theme = require("./Theme/ThemePartnerClient");

package/sdk/partner/PartnerClient.js

@@ -1,10 +1,30 @@
+const Theme = require("./Theme/ThemePartnerClient");
+
 const { FDKClientValidationError } = require("../common/FDKError");
 
+/**
+ * Represents the client for the partner APIs.
+ *
+ * @class
+ */
 class PartnerClient {
+  /**
+   * Creates an instance of PartnerClient.
+   *
+   * @param {import("./PartnerConfig")} config - The configuration for the
+   *   partner client.
+   */
   constructor(config) {
     this.config = config;
+    this.theme = new Theme(config);
   }
 
+  /**
+   * Sets the extra headers for the partner client.
+   *
+   * @param {object} header - The header object to set.
+   * @throws {FDKClientValidationError} When the provided header is not an object.
+   */
   setExtraHeaders(header) {
     if (typeof header === "object") {
       this.config.extraHeaders.push(header);

package/sdk/partner/PartnerConfig.d.ts

@@ -1,30 +1,56 @@
 export = PartnerConfig;
+/**
+ * Represents the configuration for the partner.
+ *
+ * @class
+ */
 declare class PartnerConfig {
+    /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
     /**
-     * @param {Object} config
-     * @param {string} config.companyId
-     * @param {string} config.domain
-     * @param {string} config.apiKey
-     * @param {string} config.apiSecret
-     * @param {boolean} config.useAutoRenewTimer
+     * Creates an instance of PartnerConfig.
+     *
+     * @param {Object} config - The partner configuration.
+     * @param {string} config.organizationId - The ID of the organization.
+     * @param {string} [config.domain='https://api.fynd.com'] - The domain for
+     *   API. Write the full domain. Default is `'https://api.fynd.com'`
+     * @param {string} config.apiKey - The API key for authentication.
+     * @param {string} config.apiSecret - The API secret for authentication.
+     * @param {string} [config.scope] - The scope of the partner.
+     * @param {boolean} [config.useAutoRenewTimer=true] - Flag indicating whether
+     *   to use the auto-renew timer. Default is `true`
+     * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
+     *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
      */
     constructor(config: {
-        companyId: string;
-        domain: string;
+        organizationId: string;
+        domain?: string;
         apiKey: string;
         apiSecret: string;
-        useAutoRenewTimer: boolean;
+        scope?: string;
+        useAutoRenewTimer?: boolean;
+        logLevel?: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     });
-    organizationId: any;
+    organizationId: string;
     domain: string;
     apiKey: string;
     apiSecret: string;
-    scope: any;
+    scope: string;
     useAutoRenewTimer: boolean;
     oauthClient: OauthClient;
-    logLevel: any;
+    logLevel: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR";
     extraHeaders: any[];
-    setLogLevel(level: any): void;
-    getAccessToken(): Promise<any>;
+    /**
+     * Sets the log level for the partner.
+     *
+     * @param {logLevelEnum} level - The log level to set.
+     */
+    setLogLevel(level: "TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"): void;
+    /**
+     * Retrieves the access token from the OAuth client.
+     *
+     * @async
+     * @returns {Promise<string>} - The access token.
+     */
+    getAccessToken(): Promise<string>;
 }
 import OauthClient = require("./OAuthClient");

package/sdk/partner/PartnerConfig.js

@@ -1,14 +1,28 @@
 const OauthClient = require("./OAuthClient");
 const { setLoggerLevel } = require("../common/Logger");
 
+/**
+ * Represents the configuration for the partner.
+ *
+ * @class
+ */
 class PartnerConfig {
+  /** @typedef {"TRACE" | "DEBUG" | "INFO" | "WARN" | "ERROR"} logLevelEnum */
+
   /**
-   * @param {Object} config
-   * @param {string} config.companyId
-   * @param {string} config.domain
-   * @param {string} config.apiKey
-   * @param {string} config.apiSecret
-   * @param {boolean} config.useAutoRenewTimer
+   * Creates an instance of PartnerConfig.
+   *
+   * @param {Object} config - The partner configuration.
+   * @param {string} config.organizationId - The ID of the organization.
+   * @param {string} [config.domain='https://api.fynd.com'] - The domain for
+   *   API. Write the full domain. Default is `'https://api.fynd.com'`
+   * @param {string} config.apiKey - The API key for authentication.
+   * @param {string} config.apiSecret - The API secret for authentication.
+   * @param {string} [config.scope] - The scope of the partner.
+   * @param {boolean} [config.useAutoRenewTimer=true] - Flag indicating whether
+   *   to use the auto-renew timer. Default is `true`
+   * @param {logLevelEnum} [config.logLevel='ERROR'] - The log level. Available
+   *   options: TRACE, DEBUG, INFO, WARN, ERROR. Default is `'ERROR'`
    */
   constructor(config) {
     this.organizationId = config.organizationId;
@@ -26,10 +40,21 @@ class PartnerConfig {
     this.extraHeaders = [];
   }
 
+  /**
+   * Sets the log level for the partner.
+   *
+   * @param {logLevelEnum} level - The log level to set.
+   */
   setLogLevel(level) {
     setLoggerLevel(level);
   }
 
+  /**
+   * Retrieves the access token from the OAuth client.
+   *
+   * @async
+   * @returns {Promise<string>} - The access token.
+   */
   async getAccessToken() {
     let token = await this.oauthClient.getAccessToken();
     return token.access_token;

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>;
+}