nfeio.ts

/**
 * ⚠️  AUTO-GENERATED from nfeio.yaml
 *
 * Do not edit this file directly.
 *
 * To regenerate: npm run generate
 * Last generated: 2026-01-19T23:42:06.127Z
 * Generator: openapi-typescript
 */

/**
 * This file was auto-generated by openapi-typescript.
 * Do not make direct changes to the file.
 */


export type paths = {
  "/api/notifications/zip": {
    post: {
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["ZipRequest"];
          readonly "text/json": components["schemas"]["ZipRequest"];
          readonly "application/*+json": components["schemas"]["ZipRequest"];
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: never;
        };
      };
    };
  };
  "/api/notifications/{id}": {
    post: {
      parameters: {
        query?: {
          path?: string;
          outputType?: components["schemas"]["OutputType"];
        };
        path: {
          id: string;
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: never;
        };
      };
    };
  };
  "/api/notifications/workflow/finished": {
    post: {
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": string;
          readonly "text/json": string;
          readonly "application/*+json": string;
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: never;
        };
      };
    };
  };
  "/api/processing-jobs/resources/outputs": {
    get: {
      responses: {
        /** @description OK */
        200: {
          content: {
            readonly "text/plain": readonly components["schemas"]["ResourceInfo"][];
            readonly "application/json": readonly components["schemas"]["ResourceInfo"][];
            readonly "text/json": readonly components["schemas"]["ResourceInfo"][];
          };
        };
        /** @description Unauthorized */
        401: {
          content: {
            readonly "text/plain": components["schemas"]["ProblemDetails"];
            readonly "application/json": components["schemas"]["ProblemDetails"];
            readonly "text/json": components["schemas"]["ProblemDetails"];
          };
        };
      };
    };
  };
  "/api/processing-jobs": {
    get: {
      parameters: {
        query?: {
          PageSize?: number;
          Direction?: components["schemas"]["SortDirection"];
          Order?: components["schemas"]["SortOrder"];
          "Cursor.Value"?: string;
          HasCursor?: boolean;
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: {
            readonly "text/plain": components["schemas"]["ProcessingBatchSummaryResponsePage"];
            readonly "application/json": components["schemas"]["ProcessingBatchSummaryResponsePage"];
            readonly "text/json": components["schemas"]["ProcessingBatchSummaryResponsePage"];
          };
        };
        /** @description Unauthorized */
        401: {
          content: {
            readonly "text/plain": components["schemas"]["ProblemDetails"];
            readonly "application/json": components["schemas"]["ProblemDetails"];
            readonly "text/json": components["schemas"]["ProblemDetails"];
          };
        };
      };
    };
    post: {
      readonly requestBody?: {
        readonly content: {
          readonly "application/json": components["schemas"]["StartProcessingJobRequest"];
          readonly "text/json": components["schemas"]["StartProcessingJobRequest"];
          readonly "application/*+json": components["schemas"]["StartProcessingJobRequest"];
        };
      };
      responses: {
        /** @description Created */
        201: {
          content: {
            readonly "text/plain": components["schemas"]["ProcessingBatchesResponse"];
            readonly "application/json": components["schemas"]["ProcessingBatchesResponse"];
            readonly "text/json": components["schemas"]["ProcessingBatchesResponse"];
          };
        };
        /** @description Bad Request */
        400: {
          content: {
            readonly "text/plain": components["schemas"]["ProblemDetails"];
            readonly "application/json": components["schemas"]["ProblemDetails"];
            readonly "text/json": components["schemas"]["ProblemDetails"];
          };
        };
      };
    };
  };
  "/api/processing-jobs/{id}": {
    get: {
      parameters: {
        query?: {
          status?: readonly components["schemas"]["StatusProcess"][];
        };
        path: {
          id: string;
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: {
            readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"];
            readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"];
            readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"];
          };
        };
        /** @description Unauthorized */
        401: {
          content: {
            readonly "text/plain": components["schemas"]["ProblemDetails"];
            readonly "application/json": components["schemas"]["ProblemDetails"];
            readonly "text/json": components["schemas"]["ProblemDetails"];
          };
        };
      };
    };
    delete: {
      parameters: {
        path: {
          id: string;
        };
      };
      responses: {
        /** @description OK */
        200: {
          content: {
            readonly "text/plain": components["schemas"]["ProcessingBatchDetailResponse"];
            readonly "application/json": components["schemas"]["ProcessingBatchDetailResponse"];
            readonly "text/json": components["schemas"]["ProcessingBatchDetailResponse"];
          };
        };
        /** @description Unauthorized */
        401: {
          content: {
            readonly "text/plain": components["schemas"]["ProblemDetails"];
            readonly "application/json": components["schemas"]["ProblemDetails"];
            readonly "text/json": components["schemas"]["ProblemDetails"];
          };
        };
      };
    };
  };
};

export type webhooks = Record<string, never>;

export type components = {
  schemas: {
    readonly BatchProcessResponse: {
      readonly input?: string | null;
      readonly status?: string | null;
      readonly statusReason?: string | null;
      /** Format: date-time */
      readonly createdAt: string;
      /** Format: date-time */
      readonly updatedAt?: string | null;
      readonly outPuts?: (readonly components["schemas"]["OutPutResponse"][]) | null;
    };
    /** @enum {string} */
    readonly Environment: "Test" | "Production";
    readonly FileParsingOptionsRequest: {
      /**
       * Format: int32
       * @description Coluna que está o input
       * @example 1
       */
      readonly columnToParse?: number;
      readonly parsingType?: components["schemas"]["ParsingType"];
    };
    readonly GuidPaginationCursor: {
      /** Format: uuid */
      readonly value?: string;
    };
    readonly InputInfoRequest: {
      /**
       * @description Nome do processo
       * @example s3://bucket/input.json
       */
      readonly url?: string | null;
      readonly parsingOptions?: components["schemas"]["FileParsingOptionsRequest"];
      /**
       * @description Habilitar Cache
       * @example true
       */
      readonly useCache?: boolean;
    };
    readonly InputsResponse: {
      /** Format: int32 */
      readonly totalInputs?: number;
      readonly outputs?: (readonly string[]) | null;
    };
    readonly OutPutLinkResponse: {
      readonly fileName?: string | null;
      readonly url?: string | null;
    };
    readonly OutPutResponse: {
      readonly type?: string | null;
      readonly status?: string | null;
      readonly outPutLink?: components["schemas"]["OutPutLinkResponse"];
    };
    /** @enum {string} */
    readonly OutputType: "PDF" | "XML" | "Csv";
    /** @enum {string} */
    readonly ParsingType: "Csv" | "Xls";
    readonly ProblemDetails: {
      readonly type?: string | null;
      readonly title?: string | null;
      /** Format: int32 */
      readonly status?: number | null;
      readonly detail?: string | null;
      readonly instance?: string | null;
      [key: string]: unknown;
    };
    readonly ProcessingBatchDetailResponse: {
      /** Format: uuid */
      readonly id?: string;
      readonly name?: string | null;
      readonly createdBy?: string | null;
      readonly resourceName?: string | null;
      /** Format: date-time */
      readonly createdAt?: string;
      /** Format: date-time */
      readonly updatedAt?: string | null;
      readonly inputs?: components["schemas"]["InputsResponse"];
      readonly metrics?: components["schemas"]["ProcessingMetricsResponse"];
      readonly status?: string | null;
      readonly stage?: string | null;
      readonly batchProcesses?: (readonly components["schemas"]["BatchProcessResponse"][]) | null;
    };
    readonly ProcessingBatchSummaryResponse: {
      /** Format: uuid */
      readonly id?: string;
      /** Format: uuid */
      readonly parentId?: string | null;
      readonly name?: string | null;
      readonly createdBy?: string | null;
      readonly resourceName?: string | null;
      /** Format: date-time */
      readonly createdAt?: string;
      /** Format: date-time */
      readonly updatedAt?: string | null;
      readonly metrics?: components["schemas"]["ProcessingMetricsResponse"];
      readonly inputs?: components["schemas"]["InputsResponse"];
      readonly status?: string | null;
      readonly stage?: string | null;
      readonly autoGenerated?: boolean;
      readonly outPuts?: (readonly components["schemas"]["OutPutResponse"][]) | null;
    };
    readonly ProcessingBatchSummaryResponsePage: {
      readonly items?: (readonly components["schemas"]["ProcessingBatchSummaryResponse"][]) | null;
      readonly nextCursor?: components["schemas"]["GuidPaginationCursor"];
      readonly previousCursor?: components["schemas"]["GuidPaginationCursor"];
      readonly hasNext?: boolean;
      readonly hasPrevious?: boolean;
    };
    readonly ProcessingBatchesResponse: {
      /** Format: uuid */
      readonly id?: string;
      /** Format: date-time */
      readonly createdAt?: string;
      /** Format: date-time */
      readonly updatedAt?: string | null;
      readonly status?: string | null;
    };
    readonly ProcessingMetricsResponse: {
      /** Format: int32 */
      readonly total?: number;
      /** Format: int32 */
      readonly totalSuccess?: number;
      /** Format: int32 */
      readonly totalError?: number;
    };
    readonly ResourceInfo: {
      /** Format: int32 */
      readonly id?: number;
      readonly name?: string | null;
      readonly outputs?: (readonly components["schemas"]["OutputType"][]) | null;
    };
    readonly ResourceInfoRequest: {
      /**
       * Format: int32
       * @description ID da fonte de dados
       * @example 1
       */
      readonly id?: number;
      /**
       * @description Nome da fonte de dados
       * @example NFeSefaz
       */
      readonly name?: string | null;
      /**
       * @description Tipos de saidas
       * @example [
       *   "PDF",
       *   "XML"
       * ]
       */
      readonly outputs?: (readonly components["schemas"]["OutputType"][]) | null;
    };
    /** @enum {string} */
    readonly SortDirection: "Forward" | "Backward";
    /** @enum {string} */
    readonly SortOrder: "Asc" | "Desc";
    readonly StartProcessingJobRequest: {
      /**
       * @description Quem criou a requisição
       * @example joao.souza
       */
      readonly createdBy?: string | null;
      readonly input?: components["schemas"]["InputInfoRequest"];
      /**
       * @description Nome do processo
       * @example Processamento de Dados
       */
      readonly name?: string | null;
      readonly resource?: components["schemas"]["ResourceInfoRequest"];
      readonly environment?: components["schemas"]["Environment"];
    };
    /** @enum {string} */
    readonly StatusProcess: "Pending" | "Running" | "Completed" | "Duplicated" | "Error" | "PartialSuccess" | "Succeed";
    readonly ZipRequest: {
      /** Format: uuid */
      readonly id?: string;
      readonly type?: components["schemas"]["OutputType"];
      readonly blobName?: string | null;
    };
  };
  responses: never;
  parameters: never;
  requestBodies: never;
  headers: never;
  pathItems: never;
};

export type $defs = Record<string, never>;

export type external = Record<string, never>;

export type operations = Record<string, never>;