@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/partner/Theme/ThemePartnerClient.js

@@ -0,0 +1,768 @@
+const Paginator = require("../../common/Paginator");
+const { FDKClientValidationError } = require("../../common/FDKError");
+const PartnerAPIClient = require("../PartnerAPIClient");
+const ThemeValidator = require("./ThemePartnerValidator");
+const ThemeModel = require("./ThemePartnerModel");
+const { Logger } = require("./../../common/Logger");
+
+class Theme {
+  constructor(config) {
+    this.config = config;
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getAllPages().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/page`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.createPage().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/page`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.updateMultiplePages().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "put",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/page`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getPage().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        pageValue,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/${pageValue}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.updatePage().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        pageValue,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "put",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/${pageValue}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.deletePage().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        pageValue,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}/${pageValue}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getApplicationThemes().validate(
+      {
+        companyId,
+        applicationId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v2.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/themes`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getThemeById().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v2.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.updateTheme().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "put",
+      `/service/partner/theme/v2.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = {
+      requestHeaders: {},
+    },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.deleteTheme().validate(
+      {
+        companyId,
+        applicationId,
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/partner/theme/v2.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/${themeId}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getOrganizationThemes().validate(
+      {
+        status,
+        pageSize,
+        pageNo,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["status"] = status;
+    query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/themes`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getOrganizationThemeDetails().validate(
+      {
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeId}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.updateDraftTheme().validate(
+      {
+        themeId,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "patch",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.submitOrganizationTheme().validate(
+      {
+        themeId,
+        body,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "put",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeId}`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.deleteOrganizationTheme().validate(
+      {
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "delete",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeId}`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getLatestVersionOfThemeBySlug().validate(
+      {
+        slugName,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/${slugName}/latest`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.createNewThemeInOrganization().validate(
+      {
+        body,
+        slug,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["slug"] = slug;
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "post",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme`,
+      query_params,
+      body,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getThemeRejectionReasons().validate(
+      {
+        themeId,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeId}/reasons`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+
+  /**
+   * @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 } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const { error } = ThemeValidator.getThemeVersions().validate(
+      {
+        themeSlug,
+        pageSize,
+        pageNo,
+      },
+      { abortEarly: false }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    const query_params = {};
+    query_params["page_size"] = pageSize;
+    query_params["page_no"] = pageNo;
+
+    return PartnerAPIClient.execute(
+      this.config,
+      "get",
+      `/service/partner/theme/v1.0/organization/${this.config.organizationId}/theme/${themeSlug}/versions`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+  }
+}
+module.exports = Theme;