@rossum/api-client 0.1.23 → 0.1.25

package/src/engineFields/models/engineField.ts

@@ -1,30 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { EngineFieldType, Multiline } from './engineFieldType';
-
-export type EngineFieldSubtype =
-  | 'alphanumeric'
-  | 'numeric'
-  | 'country_code'
-  | 'currency_code'
-  | 'iban'
-  | 'vat_number'
-  | 'integer'
-  | 'rate'
-  | 'amount'
-  | 'period_end'
-  | 'period_begin'
-  // TODO: Temporary, BE should fix
-  | '';
-
-export type EngineField = {
-  id: ID;
-  url: Url;
-  engine: Url;
-  name: string;
-  label: string;
-  type: EngineFieldType;
-  subtype: EngineFieldSubtype | null;
-  preTrainedFieldId: string | null;
-  tabular: boolean;
-  multiline: Multiline;
-};

package/src/engineFields/models/engineFieldType.schema.ts

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const engineFieldTypeSchema = z.union([
-  z.literal('string'),
-  z.literal('number'),
-  z.literal('date'),
-  z.literal('enum'),
-]);
-
-export const multilineSchema = z.string();

package/src/engineFields/models/engineFieldType.ts

@@ -1,5 +0,0 @@
-export type EngineFieldType = 'string' | 'number' | 'date' | 'enum';
-
-// This is currently "true" / "false" but might be something else later.
-// The exact value is not important for ELIS F/E so better be safe.
-export type Multiline = string;

package/src/engineFields/models/index.ts

@@ -1,3 +0,0 @@
-export * from './engineField';
-export * from './engineFieldType';
-export * from './preTrainedField';

package/src/engineFields/models/preTrainedField.schema.ts

@@ -1,17 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import {
-  engineFieldTypeSchema,
-  multilineSchema,
-} from './engineFieldType.schema';
-
-export const preTrainedFieldSchema = z.object({
-  name: z.string(),
-  label: z.string(),
-  section: z.string(),
-  type: engineFieldTypeSchema,
-  subtype: z.string(),
-  tabular: z.boolean(),
-  description: z.string(),
-  multiline: multilineSchema,
-});

package/src/engineFields/models/preTrainedField.ts

@@ -1,12 +0,0 @@
-import { EngineFieldType, Multiline } from './engineFieldType';
-
-export type PreTrainedField = {
-  name: string;
-  label: string;
-  section: string;
-  type: EngineFieldType;
-  subtype: string;
-  tabular: boolean;
-  description: string;
-  multiline: Multiline;
-};

package/src/engines/endpoints/checkTemplateCompatibility.schema.ts

@@ -1,10 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const engineCheckTemplateCompatibilityPayloadSchema = z.object({
-  name: z.string(),
-});
-
-export const engineCheckTemplateCompatibilityResponseSchema = z.object({
-  compatible: z.boolean(),
-});

package/src/engines/endpoints/checkTemplateCompatibility.ts

@@ -1,26 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import {
-  engineCheckTemplateCompatibilityPayloadSchema,
-  engineCheckTemplateCompatibilityResponseSchema,
-} from './checkTemplateCompatibility.schema';
-
-export type EngineCheckTemplateCompatibilityPayload = {
-  name: string;
-};
-
-export type EngineCheckTemplateCompatibilityResponse = {
-  compatible: boolean;
-};
-
-export const checkTemplateCompatibility = (
-  engineId: ID,
-  payload: EngineCheckTemplateCompatibilityPayload
-) => {
-  return {
-    endpoint: `/engines/${engineId}/check_template_compatibility`,
-    method: 'POST',
-    responseSchema: engineCheckTemplateCompatibilityResponseSchema,
-    payload,
-    payloadSchema: engineCheckTemplateCompatibilityPayloadSchema,
-  } as const;
-};

package/src/engines/endpoints/create.schema.ts

@@ -1,8 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const engineCreatePayloadSchema = z.object({
-  name: z.string(),
-  description: z.string(),
-  type: z.literal('extractor'),
-});

package/src/engines/endpoints/create.ts

@@ -1,19 +0,0 @@
-import { engineSchema } from '../models/engine.schema';
-import { engineCreatePayloadSchema } from './create.schema';
-
-export type EngineCreatePayload = {
-  name: string;
-  description: string;
-  // We are not allowed to create splitter engines.
-  type: 'extractor';
-};
-
-export const create = (payload: EngineCreatePayload) => {
-  return {
-    endpoint: `/engines`,
-    method: 'POST',
-    responseSchema: engineSchema,
-    payloadSchema: engineCreatePayloadSchema,
-    payload,
-  } as const;
-};

package/src/engines/endpoints/delete.ts

@@ -1,10 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { z } from 'zod';
-
-export const deleteEndpoint = (engineId: ID) => {
-  return {
-    endpoint: `/engines/${engineId}`,
-    method: 'DELETE',
-    responseSchema: z.unknown(),
-  } as const;
-};

package/src/engines/endpoints/duplicate.schema.ts

@@ -1,6 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const engineDuplicatePayloadSchema = z.object({
-  name: z.string(),
-});

package/src/engines/endpoints/duplicate.ts

@@ -1,17 +0,0 @@
-import { engineSchema } from '../models/engine.schema';
-import { ID } from '../../utils/codecUtils';
-import { engineDuplicatePayloadSchema } from './duplicate.schema';
-
-export type EngineDuplicatePayload = {
-  name: string;
-};
-
-export const duplicate = (engineId: ID, payload: EngineDuplicatePayload) => {
-  return {
-    endpoint: `/engines/${engineId}/duplicate`,
-    method: 'POST',
-    responseSchema: engineSchema,
-    payloadSchema: engineDuplicatePayloadSchema,
-    payload,
-  } as const;
-};

package/src/engines/endpoints/get.ts

@@ -1,10 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { engineSchema } from '../models/engine.schema';
-
-export const get = (engineId: ID) => {
-  return {
-    endpoint: `/engines/${engineId}`,
-    method: 'GET',
-    responseSchema: engineSchema,
-  } as const;
-};

package/src/engines/endpoints/index.ts

@@ -1,24 +0,0 @@
-import { create } from './create';
-import { deleteEndpoint } from './delete';
-import { get } from './get';
-import { list } from './list';
-import { patch } from './patch';
-import { duplicate } from './duplicate';
-import { queueStats } from './queueStats';
-import { checkTemplateCompatibility } from './checkTemplateCompatibility';
-export { type EngineCreatePayload } from './create';
-export { type EngineDuplicatePayload } from './duplicate';
-export { type EngineListQuery } from './list';
-export { type EnginePatchPayload } from './patch';
-export { type EngineCheckTemplateCompatibilityPayload } from './checkTemplateCompatibility';
-
-export const engines = {
-  create,
-  delete: deleteEndpoint,
-  get,
-  list,
-  patch,
-  duplicate,
-  queueStats,
-  checkTemplateCompatibility,
-};

package/src/engines/endpoints/list.schema.ts

@@ -1,18 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const engineListQuerySchema = z
-  .object({
-    type: z.union([z.literal('extractor'), z.literal('splitter')]),
-    ordering: z.array(
-      z.union([
-        z.literal('id'),
-        z.literal('-id'),
-        z.literal('type'),
-        z.literal('-type'),
-      ])
-    ),
-  })
-  .partial()
-  .and(paginationQuerySchema);

package/src/engines/endpoints/list.ts

@@ -1,20 +0,0 @@
-import { PaginationQuery } from '../../utils/listQuery';
-import { listResponse } from '../../utils/listResponse';
-import { engineSchema } from '../models/engine.schema';
-import { engineListQuerySchema } from './list.schema';
-
-export type EngineListQuery = Partial<{
-  type: 'extractor' | 'splitter';
-  ordering: ('id' | '-id' | 'type' | '-type')[];
-}> &
-  PaginationQuery;
-
-export const list = (query: EngineListQuery) => {
-  return {
-    endpoint: `/engines`,
-    method: 'GET',
-    responseSchema: listResponse(engineSchema),
-    query,
-    querySchema: engineListQuerySchema,
-  } as const;
-};

package/src/engines/endpoints/patch.schema.ts

@@ -1,7 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { engineSchema } from '../models/engine.schema';
-
-export const enginePatchPayloadSchema = engineSchema
-  .partial()
-  .pick({ name: true, learningEnabled: true, description: true });

package/src/engines/endpoints/patch.ts

@@ -1,19 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { Engine } from '../models/engine';
-import { engineSchema } from '../models/engine.schema';
-import { enginePatchPayloadSchema } from './patch.schema';
-
-export type EnginePatchPayload = Pick<
-  Partial<Engine>,
-  'name' | 'learningEnabled' | 'description'
->;
-
-export const patch = (engineId: ID, payload: EnginePatchPayload) => {
-  return {
-    endpoint: `/engines/${engineId}`,
-    method: 'PATCH',
-    responseSchema: engineSchema,
-    payloadSchema: enginePatchPayloadSchema,
-    payload,
-  } as const;
-};

package/src/engines/endpoints/queueStats.schema.ts

@@ -1,10 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { queueSchema } from '../../queues/models/queue.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const engineQueueStatsQuerySchema = paginationQuerySchema;
-
-export const engineQueueStatsSideloadSchema = z.object({
-  queues: z.array(queueSchema),
-});

package/src/engines/endpoints/queueStats.ts

@@ -1,26 +0,0 @@
-import { Queue } from '../../queues/models/queue';
-import { ID } from '../../utils/codecUtils';
-import { PaginationQuery } from '../../utils/listQuery';
-import { listResponse } from '../../utils/listResponse';
-import { engineQueueStatsItemSchema } from '../models/engineQueueStatsItem.schema';
-import {
-  engineQueueStatsQuerySchema,
-  engineQueueStatsSideloadSchema,
-} from './queueStats.schema';
-
-export type EngineQueueStatsQuery = PaginationQuery;
-
-export type EngineQueueStatsSideload = {
-  queues: Queue[];
-};
-
-export const queueStats = (id: ID, query: EngineQueueStatsQuery) => {
-  return {
-    endpoint: `/engines/${id}/queue_stats`,
-    method: 'GET',
-    responseSchema: listResponse(engineQueueStatsItemSchema),
-    query,
-    querySchema: engineQueueStatsQuerySchema,
-    sideloadSchema: engineQueueStatsSideloadSchema,
-  } as const;
-};

package/src/engines/index.ts

@@ -1,3 +0,0 @@
-export * from './models';
-export * from './endpoints';
-

package/src/engines/models/engine.schema.ts

@@ -1,13 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-
-export const engineSchema = z.object({
-  id: idSchema,
-  url: urlSchema,
-  name: z.string(),
-  description: z.string().optional(),
-  type: z.union([z.literal('extractor'), z.literal('splitter')]),
-  learningEnabled: z.boolean(),
-  agendaId: z.string(),
-});

package/src/engines/models/engine.ts

@@ -1,11 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-
-export type Engine = {
-  id: ID;
-  url: Url;
-  name: string;
-  description?: string;
-  type: 'extractor' | 'splitter';
-  learningEnabled: boolean;
-  agendaId: string;
-};

package/src/engines/models/engineQueueStatsItem.schema.ts

@@ -1,8 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../types.schema';
-
-export const engineQueueStatsItemSchema = z.object({
-  url: urlSchema,
-  numberOfUsedEngineFields: z.number(),
-});

package/src/engines/models/engineQueueStatsItem.ts

@@ -1,6 +0,0 @@
-import { Url } from '../../types';
-
-export type EngineQueueStatsItem = {
-  url: Url;
-  numberOfUsedEngineFields: number;
-};

package/src/engines/models/index.ts

@@ -1 +0,0 @@
-export * from './engine';

package/src/errors/decodingError.ts

@@ -1,17 +0,0 @@
-/**
- * @noSchema
- */
-export type DecodingErrorContext = {
-  endpoint: string;
-  decodingOutput: string;
-};
-export class DecodingError extends Error {
-  endpoint: string;
-
-  constructor({ endpoint, decodingOutput }: DecodingErrorContext) {
-    super(`'${endpoint}': When decoding: \n ${decodingOutput}`);
-    this.name = 'DecodingError';
-    this.endpoint = endpoint;
-    Object.setPrototypeOf(this, DecodingError.prototype);
-  }
-}

package/src/errors/httpError.ts

@@ -1,74 +0,0 @@
-import { AxiosResponse } from 'axios';
-
-/**
- * @noSchema
- */
-export type ElisApiResponseStatus =
-  | 400
-  | 401
-  | 403
-  | 404
-  | 405
-  | 409
-  | 413
-  | 429
-  | 500
-  | 503
-  | number;
-
-const statusMessage: Record<ElisApiResponseStatus, string> = {
-  400: 'Bad request',
-  401: 'Unauthorized',
-  403: 'Forbidden',
-  404: 'Not Found',
-  405: 'Method not Allowed',
-  409: 'Conflict',
-  413: 'Payload Too Large',
-  429: 'Too many requests',
-  500: 'Internal Server Error',
-  503: 'Service Unavailable',
-};
-
-/**
- * @noSchema
- */
-export type HttpErrorContext = {
-  endpoint: string;
-  method?: string;
-  data?: unknown;
-  statusCode: ElisApiResponseStatus;
-  headers?: AxiosResponse['headers'];
-};
-
-export class HttpError extends Error {
-  code: number;
-
-  data?: unknown;
-
-  endpoint: string;
-
-  method: string;
-
-  headers?: AxiosResponse['headers'];
-
-  constructor({
-    endpoint,
-    method,
-    statusCode,
-    data,
-    headers,
-  }: HttpErrorContext) {
-    super(
-      `'${endpoint}': Request failed with code '${statusCode}': ${
-        statusMessage[statusCode] ?? 'Undocumented API error.'
-      }`
-    );
-    this.name = 'HttpError';
-    this.code = statusCode;
-    this.data = data;
-    this.endpoint = endpoint;
-    this.method = method ?? 'UNKNOWN';
-    this.headers = headers;
-    Object.setPrototypeOf(this, HttpError.prototype);
-  }
-}

package/src/errors/index.ts

@@ -1,17 +0,0 @@
-import { DecodingError } from './decodingError';
-import { HttpError } from './httpError';
-import { RequestError } from './requestError';
-
-export * from './httpError';
-export * from './decodingError';
-export * from './requestError';
-
-/**
- * @noSchema
- */
-export type ElisClientError = RequestError | HttpError | DecodingError;
-
-export const isElisClientError = (e: unknown): e is ElisClientError =>
-  e instanceof RequestError ||
-  e instanceof HttpError ||
-  e instanceof DecodingError;

package/src/errors/requestError.ts

@@ -1,18 +0,0 @@
-/**
- * @noSchema
- */
-export type RequestErrorContext = {
-  endpoint: string;
-  message: string;
-};
-
-export class RequestError extends Error {
-  endpoint: string;
-
-  constructor({ endpoint, message }: RequestErrorContext) {
-    super(`'${endpoint}': ${message}`);
-    this.name = 'RequestError';
-    this.endpoint = endpoint;
-    Object.setPrototypeOf(this, RequestError.prototype);
-  }
-}

package/src/genericEngines/endpoints/get.schema.ts

@@ -1,16 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const genericEngineGetQuerySchema = z
-  .object({
-    fields: z.array(
-      z.union([
-        z.literal('id'),
-        z.literal('name'),
-        z.literal('url'),
-        z.literal('schema'),
-        z.literal('description'),
-      ])
-    ),
-  })
-  .partial();

package/src/genericEngines/endpoints/get.ts

@@ -1,18 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { genericEngineSchema } from '../models/genericEngine.schema';
-import { genericEngineGetQuerySchema } from './get.schema';
-
-export type GenericEngineGetQuery = Partial<{
-  fields: ('id' | 'name' | 'url' | 'schema' | 'description')[];
-}>;
-
-export const get = (engineId: ID, query: GenericEngineGetQuery = {}) => {
-  return {
-    endpoint: `/generic_engines/${engineId}`,
-    method: 'GET',
-    responseSchema: genericEngineSchema,
-    query,
-    querySchema: genericEngineGetQuerySchema,
-  } as const;
-};

package/src/genericEngines/endpoints/index.ts

@@ -1,9 +0,0 @@
-import { get } from './get';
-import { list } from './list';
-export { type GenericEngineListQuery } from './list';
-export { type GenericEngineGetQuery } from './get';
-
-export const genericEngines = {
-  get,
-  list,
-};

package/src/genericEngines/endpoints/list.schema.ts

@@ -1,43 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const genericEngineListQuerySchema = z.object({
-  pageSize: z.number().optional(),
-  page: z.number().optional(),
-  fields: z
-    .array(
-      z.union([
-        z.literal('id'),
-        z.literal('name'),
-        z.literal('url'),
-        z.literal('schema'),
-        z.literal('description'),
-        z.literal('documentationUrl'),
-      ])
-    )
-    .optional(),
-  ordering: z
-    .array(
-      z.union([
-        z.literal('id'),
-        z.literal('name'),
-        z.literal('url'),
-        z.literal('schema'),
-        z.literal('description'),
-        z.literal('documentationUrl'),
-        z.literal('-id'),
-        z.literal('-name'),
-        z.literal('-url'),
-        z.literal('-schema'),
-        z.literal('-description'),
-        z.literal('-documentationUrl'),
-      ])
-    )
-    .optional(),
-  id: z.union([z.number(), z.array(z.number())]).optional(),
-  name: z.union([z.number(), z.array(z.number())]).optional(),
-  url: z.union([z.number(), z.array(z.number())]).optional(),
-  schema: z.union([z.number(), z.array(z.number())]).optional(),
-  description: z.union([z.number(), z.array(z.number())]).optional(),
-  documentationUrl: z.union([z.number(), z.array(z.number())]).optional(),
-});

package/src/genericEngines/endpoints/list.ts

@@ -1,48 +0,0 @@
-import { ListResponse, listResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { GenericEngine } from '../models/genericEngine';
-import { genericEngineSchema } from '../models/genericEngine.schema';
-import { genericEngineListQuerySchema } from './list.schema';
-
-export type GenericEngineListQuery = {
-  pageSize?: number;
-  page?: number;
-  fields?: (
-    | 'id'
-    | 'name'
-    | 'url'
-    | 'schema'
-    | 'description'
-    | 'documentationUrl'
-  )[];
-  ordering?: (
-    | 'id'
-    | 'name'
-    | 'url'
-    | 'schema'
-    | 'description'
-    | 'documentationUrl'
-    | '-id'
-    | '-name'
-    | '-url'
-    | '-schema'
-    | '-description'
-    | '-documentationUrl'
-  )[];
-  id?: number | number[];
-  name?: number | number[];
-  url?: number | number[];
-  schema?: number | number[];
-  description?: number | number[];
-  documentationUrl?: number | number[];
-};
-
-export const list = (query: GenericEngineListQuery = {}) => {
-  return {
-    endpoint: `/generic_engines`,
-    method: 'GET',
-    responseSchema: listResponse(genericEngineSchema),
-    query,
-    querySchema: genericEngineListQuerySchema,
-  } as const;
-};

package/src/genericEngines/index.ts

@@ -1,3 +0,0 @@
-export * from './models';
-export * from './endpoints';
-