/**
 * Apimatic APILib
 *
 * This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { ApiResponse, FileWrapper, RequestOptions } from '../core.js';
import { Accept4, accept4Schema } from '../models/accept4.js';
import { ContentType, contentTypeSchema } from '../models/contentType.js';
import { array, optional, string, unknown } from '../schema.js';
import { BaseController } from './baseController.js';
import { ApiError } from '@apimatic/core';
import { InternalServerErrorResponseError } from '../errors/internalServerErrorResponseError.js';
import { ProblemDetailsError } from '../errors/problemDetailsError.js';
import { UnauthorizedResponseError } from '../errors/unauthorizedResponseError.js';

export class DocsPortalManagementController extends BaseController {
  /**
   * Publish artifacts for a Hosted Portal.
   *
   * This endpoint regenerates all the artifacts for a hosted portal and uploads them to APIMatic's cloud
   * storage, from where the Portal fetches them. These artifacts include:
   *
   * 1. SDKs
   * 2. Docs
   * 3. API Specification files
   *
   * Call this endpoint to update your Hosted Portal after you update an API Entity via any of the Import
   * API Endpoints.
   *
   * __**Note: If you have an embedded portal against the same API Entity, artifacts for that portal will
   * get updated as well.**__
   *
   * @param apiEntityId   The ID of the API Entity to update the portal artifacts for.
   * @return Response from the API call
   */
  async publishHostedPortal(
    apiEntityId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<void>> {
    const req = this.createRequest('PUT');
    const mapped = req.prepareArgs({ apiEntityId: [apiEntityId, string()] });
    req.appendTemplatePath`/api-entities/${mapped.apiEntityId}/hosted-portal`;
    req.authenticate([{ authorization: true }]);
    return req.call(requestOptions);
  }

  /**
   * Publish artifacts for an Embedded Portal and get the Portal Embed script.
   *
   * This endpoint regenerates all the artifacts for an embedded portal and uploads them to APIMatic's
   * cloud storage, from where the Portal fetches them. These artifacts include:
   *
   * 1. SDKs
   * 2. Docs
   * 3. API Specification files
   *
   * Call this endpoint to update your Embedded Portal after you update an API Entity via any of the
   * Import API Endpoints. This endpoint returns the Portal Embed script in the response.
   *
   * __**Note: If you have a hosted portal against the same API Entity, artifacts for that portal will
   * get updated as well.**__
   *
   * @param apiEntityId   The ID of the API Entity to update the portal artifacts for.
   * @return Response from the API call
   */
  async publishEmbeddedPortal(
    apiEntityId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<void>> {
    const req = this.createRequest('PUT');
    const mapped = req.prepareArgs({ apiEntityId: [apiEntityId, string()] });
    req.appendTemplatePath`/api-entities/${mapped.apiEntityId}/embedded-portal`;
    req.authenticate([{ authorization: true }]);
    return req.call(requestOptions);
  }

  /**
   * Generate an On-premise Documentation Portal for an API Entity. This endpoint generates all artifacts
   * for the Portal and packages them together into a zip file along with the required HTML, CSS and JS
   * files. The generated artifacts include:
   *
   * 1. SDKs
   * 2. Docs
   * 3. API Specification files
   *
   * The endpoint returns a zip file that contains a static Site and can be hosted on any Web Server.
   *
   * @param apiEntityId   The ID of the API Entity to generate the Portal for.
   * @param accept        Example: application/zip
   * @return Response from the API call
   */
  async generateOnPremPortalViaApiEntity(
    apiEntityId: string,
    accept: Accept4,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<void>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      apiEntityId: [apiEntityId, string()],
      accept: [accept, accept4Schema],
    });
    req.header('Accept', mapped.accept);
    req.appendTemplatePath`/api-entities/${mapped.apiEntityId}/on-prem-portal`;
    req.authenticate([{ authorization: true }]);
    return req.call(requestOptions);
  }

  /**
   * Generate an On-premise Documentation Portal by uploading a Portal Build Input. This endpoint
   * generates all artifacts for the Portal and packages them together into a zip file along with the
   * required HTML, CSS and JS files. The generated artifacts include:
   *
   * 1. SDKs
   * 2. Docs
   * 3. API Specification files
   *
   * The endpoint returns a zip file that contains a static Site and can be hosted on any Web Server.
   *
   * @param contentType
   * @param file         The input file to the Portal Generator. Must contain the build file.
   * @return Response from the API call
   */
  async generateOnPremPortalViaBuildInput(
    contentType: ContentType,
    file: FileWrapper,
    queryParameters?: Record<string, string>,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<NodeJS.ReadableStream | Blob>> {
    const req = this.createRequest('POST', '/portal');
    const mapped = req.prepareArgs({
      contentType: [contentType, contentTypeSchema],
    });
    req.header('Content-Type', mapped.contentType);
    req.query(queryParameters);
    req.formData({ file: file });
    req.throwOn(400, ProblemDetailsError, 'Bad Request');
    req.throwOn(401, UnauthorizedResponseError, 'Unauthorized');
    req.throwOn(403, ProblemDetailsError, 'Subscription Issue');
    req.throwOn(
      422,
      ApiError,
      'Unprocessable Entity - Contains error.zip for build issues'
    );
    req.throwOn(500, InternalServerErrorResponseError, 'Internal Server Error');
    req.authenticate([{ authorization: true }]);
    return req.callAsStream(requestOptions);
  }

  /**
   * Generate Build Input for a Portal created using the UI workflow.  The Build Input will correspond to
   * the draft version of the Portal i.e. unpublished changes will also be included.
   * This can be used to create a backup of your Portal or to migrate from the UI workflow to the docs as
   * code workflow.
   *
   * @param apiGroupId
   * @param apiEntities
   * @return Response from the API call
   */
  async generateBuildInputForUnpublishedPortal(
    apiGroupId: string,
    apiEntities?: string[],
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<unknown | undefined>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      apiGroupId: [apiGroupId, string()],
      apiEntities: [apiEntities, optional(array(string()))],
    });
    req.query('apiEntities', mapped.apiEntities);
    req.appendTemplatePath`/portal/build/${mapped.apiGroupId}/draft`;
    req.authenticate([{ authorization: true }]);
    return req.callAsJson(optional(unknown()), requestOptions);
  }

  /**
   * Generate Build Input for a Portal created using the UI workflow.  The Build Input will correspond to
   * the published version of the Portal i.e. unpublished changes will not be inlcuded.
   * This can be used to create a backup of your Portal or to migrate from the UI workflow to the docs as
   * code workflow.
   *
   * @param apiGroupId
   * @param apiEntities
   * @return Response from the API call
   */
  async generateBuildInputForPublishedPortal(
    apiGroupId: string,
    apiEntities?: string[],
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<unknown | undefined>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      apiGroupId: [apiGroupId, string()],
      apiEntities: [apiEntities, optional(array(string()))],
    });
    req.query('apiEntities', mapped.apiEntities);
    req.appendTemplatePath`/portal/build/${mapped.apiGroupId}/published`;
    req.authenticate([{ authorization: true }]);
    return req.callAsJson(optional(unknown()), requestOptions);
  }

  /**
   * Unpublish a Hosted or Embedded Portal published for an API Entity. Calling this endpoint deletes all
   * the published artifacts for a Portal from APIMatic's cloud storage.
   *
   * In case of a Hosted Portal, to completely remove the Portal, this endpoint needs to be called
   * against all API versions that the Portal hosts.
   *
   * In case of an Embedded Portal, to completely remove the Portal, the user needs to manually remove
   * the Portal Embed script from the embedding site.
   *
   * @param apiEntityId   The ID of the API Entity to unpublish the Portal artifacts for.
   * @return Response from the API call
   */
  async unpublishPortal(
    apiEntityId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<void>> {
    const req = this.createRequest('DELETE');
    const mapped = req.prepareArgs({ apiEntityId: [apiEntityId, string()] });
    req.appendTemplatePath`/api-entities/${mapped.apiEntityId}/portal`;
    req.authenticate([{ authorization: true }]);
    return req.call(requestOptions);
  }
}