/**
 * AdvancedBilling
 *
 * This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
 */

import { ApiResponse, commaPrefix, RequestOptions } from '../core.js';
import {
  BatchJobResponse,
  batchJobResponseSchema,
} from '../models/batchJobResponse.js';
import { Invoice, invoiceSchema } from '../models/invoice.js';
import {
  ProformaInvoice,
  proformaInvoiceSchema,
} from '../models/proformaInvoice.js';
import { Subscription, subscriptionSchema } from '../models/subscription.js';
import { array, number, optional, string } from '../schema.js';
import { BaseController } from './baseController.js';
import { ApiError } from '@apimatic/core';
import { SingleErrorResponseError } from '../errors/singleErrorResponseError.js';

export class APIExportsController extends BaseController {
  /**
   * Lists exported proforma invoices for a provided `batch_id`. Use pagination to control responses
   * returned from the server.
   *
   * Example: `GET https://{subdomain}.chargify.com/api_exports/proforma_invoices/123/rows?
   * per_page=10000&page=1`.
   *
   * @param batchId  Id of a Batch Job.
   * @param perPage  This parameter indicates how many records to fetch in each request.  Default value is
   *                           100.  The maximum allowed values is 10000; any per_page value over 10000 will be changed
   *                           to 10000.
   * @param page     Result records are organized in pages. By default, the first page of results is
   *                           displayed. The page parameter specifies a page number of results to fetch. You can start
   *                           navigating through the pages to consume the results. You do this by passing in a page
   *                           parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no
   *                           results to return, then an empty result set will be returned. Use in query `page=1`.
   * @return Response from the API call
   */
  async listExportedProformaInvoices(
    {
      batchId,
      perPage,
      page,
    }: {
      batchId: string;
      perPage?: number;
      page?: number;
    },
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<ProformaInvoice[]>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      batchId: [batchId, string()],
      perPage: [perPage, optional(number())],
      page: [page, optional(number())],
    });
    req.query('per_page', mapped.perPage, commaPrefix);
    req.query('page', mapped.page, commaPrefix);
    req.appendTemplatePath`/api_exports/proforma_invoices/${mapped.batchId}/rows.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(array(proformaInvoiceSchema), requestOptions);
  }

  /**
   * Lists exported invoices for a provided `batch_id`. Use pagination to control responses returned from
   * the server.
   *
   * Example: `GET https://{subdomain}.chargify.com/api_exports/invoices/123/rows?per_page=10000&page=1`.
   *
   * @param batchId  Id of a Batch Job.
   * @param perPage  This parameter indicates how many records to fetch in each request.  Default value is
   *                           100.  The maximum allowed values is 10000; any per_page value over 10000 will be changed
   *                           to 10000.
   * @param page     Result records are organized in pages. By default, the first page of results is
   *                           displayed. The page parameter specifies a page number of results to fetch. You can start
   *                           navigating through the pages to consume the results. You do this by passing in a page
   *                           parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no
   *                           results to return, then an empty result set will be returned. Use in query `page=1`.
   * @return Response from the API call
   */
  async listExportedInvoices(
    {
      batchId,
      perPage,
      page,
    }: {
      batchId: string;
      perPage?: number;
      page?: number;
    },
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<Invoice[]>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      batchId: [batchId, string()],
      perPage: [perPage, optional(number())],
      page: [page, optional(number())],
    });
    req.query('per_page', mapped.perPage, commaPrefix);
    req.query('page', mapped.page, commaPrefix);
    req.appendTemplatePath`/api_exports/invoices/${mapped.batchId}/rows.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(array(invoiceSchema), requestOptions);
  }

  /**
   * Lists exported subscriptions for a provided `batch_id`. Use pagination to control responses returned
   * from the server.
   *
   * Example: `GET https://{subdomain}.chargify.com/api_exports/subscriptions/123/rows?
   * per_page=200&page=1`.
   *
   * @param batchId  Id of a Batch Job.
   * @param perPage  This parameter indicates how many records to fetch in each request.  Default value is
   *                           100.  The maximum allowed values is 10000; any per_page value over 10000 will be changed
   *                           to 10000.
   * @param page     Result records are organized in pages. By default, the first page of results is
   *                           displayed. The page parameter specifies a page number of results to fetch. You can start
   *                           navigating through the pages to consume the results. You do this by passing in a page
   *                           parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no
   *                           results to return, then an empty result set will be returned. Use in query `page=1`.
   * @return Response from the API call
   */
  async listExportedSubscriptions(
    {
      batchId,
      perPage,
      page,
    }: {
      batchId: string;
      perPage?: number;
      page?: number;
    },
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<Subscription[]>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({
      batchId: [batchId, string()],
      perPage: [perPage, optional(number())],
      page: [page, optional(number())],
    });
    req.query('per_page', mapped.perPage, commaPrefix);
    req.query('page', mapped.page, commaPrefix);
    req.appendTemplatePath`/api_exports/subscriptions/${mapped.batchId}/rows.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(array(subscriptionSchema), requestOptions);
  }

  /**
   * Creates a proforma invoices export and returns a batch job object.
   *
   * It is only available for Relationship Invoicing architecture.
   *
   * @return Response from the API call
   */
  async exportProformaInvoices(
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest(
      'POST',
      '/api_exports/proforma_invoices.json'
    );
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.throwOn(
      409,
      SingleErrorResponseError,
      true,
      "HTTP Response Not OK. Status code: {$statusCode}. Response: '{$response.body}'."
    );
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }

  /**
   * Creates an invoices export and returns a batch job object.
   *
   * @return Response from the API call
   */
  async exportInvoices(
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest('POST', '/api_exports/invoices.json');
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.throwOn(
      409,
      SingleErrorResponseError,
      true,
      "HTTP Response Not OK. Status code: {$statusCode}. Response: '{$response.body}'."
    );
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }

  /**
   * Creates a subscriptions export and returns a batch job object.
   *
   * @return Response from the API call
   */
  async exportSubscriptions(
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest('POST', '/api_exports/subscriptions.json');
    req.throwOn(
      409,
      SingleErrorResponseError,
      true,
      "HTTP Response Not OK. Status code: {$statusCode}. Response: '{$response.body}'."
    );
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }

  /**
   * Returns a batch job object for a proforma invoices export.
   *
   * @param batchId  Id of a Batch Job.
   * @return Response from the API call
   */
  async readProformaInvoicesExport(
    batchId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({ batchId: [batchId, string()] });
    req.appendTemplatePath`/api_exports/proforma_invoices/${mapped.batchId}.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }

  /**
   * Returns a batch job object for an invoices export.
   *
   * @param batchId  Id of a Batch Job.
   * @return Response from the API call
   */
  async readInvoicesExport(
    batchId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({ batchId: [batchId, string()] });
    req.appendTemplatePath`/api_exports/invoices/${mapped.batchId}.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }

  /**
   * Returns a batch job object for a subscriptions export.
   *
   * @param batchId  Id of a Batch Job.
   * @return Response from the API call
   */
  async readSubscriptionsExport(
    batchId: string,
    requestOptions?: RequestOptions
  ): Promise<ApiResponse<BatchJobResponse>> {
    const req = this.createRequest('GET');
    const mapped = req.prepareArgs({ batchId: [batchId, string()] });
    req.appendTemplatePath`/api_exports/subscriptions/${mapped.batchId}.json`;
    req.throwOn(404, ApiError, true, "Not Found:'{$response.body}'");
    req.authenticate([{ basicAuth: true }]);
    return req.callAsJson(batchJobResponseSchema, requestOptions);
  }
}