@rossum/api-client 0.1.24 → 0.1.25

package/src/billing/endpoints/getStats.schema.ts

@@ -1,30 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const billingStatsPayloadSchema = z
-  .object({
-    filters: z
-      .object({
-        beginDate: z.string(),
-        endDate: z.string(),
-        queues: z.array(urlSchema.nullable()),
-        organizations: z.array(urlSchema),
-      })
-      .partial(),
-    groupBy: z.array(
-      z.union([
-        z.literal('organization'),
-        z.literal('queue'),
-        z.literal('month'),
-        z.literal('week'),
-      ])
-    ),
-    orderBy: z.array(
-      z.union([z.literal('-billable_pages'), z.literal('-billable_documents')])
-    ),
-  })
-  .partial();
-
-export const billingStatsQuerySchema = paginationQuerySchema;

package/src/billing/endpoints/getStats.ts

@@ -1,36 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { PaginationQuery } from '../../utils/listQuery';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { BillingStatsListResponse } from '../models/billingStats';
-import { billingStatsListResponseSchema } from '../models/billingStats.schema';
-import {
-  billingStatsPayloadSchema,
-  billingStatsQuerySchema,
-} from './getStats.schema';
-
-export type BillingStatsPayload = Partial<{
-  filters: Partial<{
-    beginDate: string;
-    endDate: string;
-    queues: (Url | null)[];
-    organizations: Url[]; // Allowed only if endpoint === 'organization_groups'
-  }>;
-  groupBy: Array<'organization' | 'queue' | 'month' | 'week'>;
-  orderBy: Array<'-billable_pages' | '-billable_documents'>;
-}>;
-
-export type BillingStatsQuery = PaginationQuery;
-
-export const getStats =
-  (endpoint: 'organizations' | 'organization_groups') =>
-  (id: ID, payload: BillingStatsPayload, query: BillingStatsQuery) => {
-    return {
-      endpoint: `/${endpoint}/${id}/billing_stats`,
-      method: 'POST',
-      responseSchema: billingStatsListResponseSchema,
-      payloadSchema: billingStatsPayloadSchema,
-      payload,
-      querySchema: billingStatsQuerySchema,
-      query,
-    } as const;
-  };

package/src/billing/endpoints/getStatsExport.ts

@@ -1,16 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { BillingStatsPayload } from './getStats';
-import { billingStatsPayloadSchema } from './getStats.schema';
-
-export const getStatsExport =
-  (endpoint: 'organizations' | 'organization_groups') =>
-  (id: ID, payload: BillingStatsPayload) => {
-    return {
-      endpoint: `/${endpoint}/${id}/billing_stats/export`,
-      method: 'POST',
-      responseType: 'blob',
-      payloadSchema: billingStatsPayloadSchema,
-      payload,
-    } as const;
-  };

package/src/billing/index.ts

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

package/src/billing/models/billingHistory.schema.ts

@@ -1,47 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { paginationResponseSchema } from '../../utils/pagination.schema';
-
-export const billingHistoryValuesSchema = z.object({
-  purchasedPages: z.number(),
-  billablePages: z.number(),
-  purchasedDocuments: z.number(),
-  billableDocuments: z.number(),
-  extractedPagesWithLearning: z.number(),
-  extractedPagesWithoutLearning: z.number(),
-  splitPagesWithLearning: z.number(),
-  splitPagesWithoutLearning: z.number(),
-  extractedDocumentsWithLearning: z.number(),
-  extractedDocumentsWithoutLearning: z.number(),
-  splitDocumentsWithLearning: z.number(),
-  splitDocumentsWithoutLearning: z.number(),
-  ocrOnlyPages: z.number(),
-  ocrOnlyDocuments: z.number(),
-  purchasedExtractedPagesWithLearning: z.number(),
-  purchasedExtractedPagesWithoutLearning: z.number(),
-  purchasedSplitPagesWithLearning: z.number(),
-  purchasedSplitPagesWithoutLearning: z.number(),
-  purchasedExtractedDocumentsWithLearning: z.number(),
-  purchasedExtractedDocumentsWithoutLearning: z.number(),
-  purchasedSplitDocumentsWithLearning: z.number(),
-  purchasedSplitDocumentsWithoutLearning: z.number(),
-  purchasedOcrOnlyPages: z.number(),
-  purchasedOcrOnlyDocuments: z.number(),
-});
-
-export const billingHistorySchema = z.object({
-  beginDate: z.string(),
-  endDate: z.string(),
-  values: billingHistoryValuesSchema.and(
-    z.object({
-      isCurrent: z.boolean(),
-    })
-  ),
-});
-
-export const billingHistoryListResponseSchema = z.object({
-  pagination: paginationResponseSchema,
-  results: z.array(billingHistorySchema),
-  updatedAt: z.string(),
-  totals: billingHistoryValuesSchema,
-});

package/src/billing/models/billingHistory.ts

@@ -1,41 +0,0 @@
-import { PaginationResponse } from '../../utils/pagination';
-
-export type BillingHistoryValues = {
-  purchasedPages: number;
-  billablePages: number;
-  purchasedDocuments: number;
-  billableDocuments: number;
-  extractedPagesWithLearning: number;
-  extractedPagesWithoutLearning: number;
-  splitPagesWithLearning: number;
-  splitPagesWithoutLearning: number;
-  extractedDocumentsWithLearning: number;
-  extractedDocumentsWithoutLearning: number;
-  splitDocumentsWithLearning: number;
-  splitDocumentsWithoutLearning: number;
-  ocrOnlyPages: number;
-  ocrOnlyDocuments: number;
-  purchasedExtractedPagesWithLearning: number;
-  purchasedExtractedPagesWithoutLearning: number;
-  purchasedSplitPagesWithLearning: number;
-  purchasedSplitPagesWithoutLearning: number;
-  purchasedExtractedDocumentsWithLearning: number;
-  purchasedExtractedDocumentsWithoutLearning: number;
-  purchasedSplitDocumentsWithLearning: number;
-  purchasedSplitDocumentsWithoutLearning: number;
-  purchasedOcrOnlyPages: number;
-  purchasedOcrOnlyDocuments: number;
-};
-
-export type BillingHistory = {
-  beginDate: string;
-  endDate: string;
-  values: BillingHistoryValues & { isCurrent: boolean };
-};
-
-export type BillingHistoryListResponse = {
-  pagination: PaginationResponse;
-  results: BillingHistory[];
-  updatedAt: string;
-  totals: BillingHistoryValues;
-};

package/src/billing/models/billingStats.schema.ts

@@ -1,26 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-import { paginationResponseSchema } from '../../utils/pagination.schema';
-
-export const billingStatsValuesSchema = z.object({
-  billablePages: z.number(),
-  nonBillablePages: z.number(),
-  billableDocuments: z.number(),
-  nonBillableDocuments: z.number(),
-});
-
-export const billingStatsSchema = z.object({
-  organization: urlSchema.nullable(),
-  queue: urlSchema.nullable(),
-  beginDate: z.string(),
-  endDate: z.string(),
-  values: billingStatsValuesSchema,
-});
-
-export const billingStatsListResponseSchema = z.object({
-  pagination: paginationResponseSchema,
-  results: z.array(billingStatsSchema),
-  updatedAt: z.string(),
-  totals: billingStatsValuesSchema,
-});

package/src/billing/models/billingStats.ts

@@ -1,24 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { PaginationResponse } from '../../utils/pagination';
-
-export type BillingStatsValues = {
-  billablePages: number;
-  nonBillablePages: number;
-  billableDocuments: number;
-  nonBillableDocuments: number;
-};
-
-export type BillingStats = {
-  organization: Url | null;
-  queue: Url | null;
-  beginDate: string;
-  endDate: string;
-  values: BillingStatsValues;
-};
-
-export type BillingStatsListResponse = {
-  pagination: PaginationResponse;
-  results: BillingStats[];
-  updatedAt: string;
-  totals: BillingStatsValues;
-};

package/src/billing/models/index.ts

@@ -1,4 +0,0 @@
-export * from './billingHistory.schema';
-export * from './billingHistory';
-export * from './billingStats.schema';
-export * from './billingStats';

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

@@ -1,10 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const createConnectorPayloadSchema = z.object({
-  name: z.string(),
-  queues: z.array(z.string()),
-  serviceUrl: urlSchema,
-  authorizationToken: z.string(),
-});

package/src/connectors/endpoints/create.ts

@@ -1,22 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { Connector } from '../models/connector';
-import { connectorSchema } from '../models/connector.schema';
-import { createConnectorPayloadSchema } from './create.schema';
-
-export type CreateConnectorPayload = {
-  name: string;
-  queues: Array<string>;
-  serviceUrl: Url;
-  authorizationToken: string;
-};
-
-export const create = (payload: CreateConnectorPayload) => {
-  return {
-    endpoint: `/connectors`,
-    method: 'POST',
-    responseSchema: connectorSchema,
-    payloadSchema: createConnectorPayloadSchema,
-    payload,
-  } as const;
-};

package/src/connectors/endpoints/delete.ts

@@ -1,11 +0,0 @@
-import { z } from 'zod';
-import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-
-export const deleteConnector = (connectorId: ID) => {
-  return {
-    endpoint: `/connectors/${connectorId}`,
-    method: 'DELETE',
-    responseSchema: z.unknown(),
-  } as const;
-};

package/src/connectors/endpoints/index.ts

@@ -1,9 +0,0 @@
-import { create } from './create';
-import { deleteConnector } from './delete';
-import { list } from './list';
-
-export const connectors = {
-  create,
-  deleteConnector,
-  list,
-};

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

@@ -1,13 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-import { paginationQuerySchema } from '../../utils/listQuery.schema';
-
-export const connectorListQuerySchema = z
-  .object({
-    id: z.union([idSchema, z.array(idSchema)]),
-    name: z.string(),
-    serviceUrl: urlSchema,
-  })
-  .partial()
-  .and(paginationQuerySchema);

package/src/connectors/endpoints/list.ts

@@ -1,24 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { PaginationQuery } from '../../utils/listQuery';
-import { ListResponse, listResponse } from '../../utils/listResponse';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { Connector } from '../models/connector';
-import { connectorSchema } from '../models/connector.schema';
-import { connectorListQuerySchema } from './list.schema';
-
-export type ConnectorListQuery = Partial<{
-  id: ID | ID[];
-  name: string;
-  serviceUrl: Url;
-}> &
-  PaginationQuery;
-
-export const list = (query: ConnectorListQuery = {}) => {
-  return {
-    endpoint: `/connectors`,
-    method: 'GET',
-    responseSchema: listResponse(connectorSchema),
-    query,
-    querySchema: connectorListQuerySchema,
-  } as const;
-};

package/src/connectors/index.ts

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

package/src/connectors/models/connector.schema.ts

@@ -1,18 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-
-export const connectorSchema = z.object({
-  id: idSchema,
-  name: z.string(),
-  queues: z.array(urlSchema),
-  url: urlSchema,
-  serviceUrl: urlSchema,
-  params: z.string().nullable(),
-  authorizationToken: z.string(),
-  authorizationType: z.string(),
-  clientSslCertificate: z.string().nullable(),
-  clientSslKey: z.string().optional(),
-  asynchronous: z.boolean(),
-  metadata: z.unknown().optional(),
-});

package/src/connectors/models/connector.ts

@@ -1,16 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-
-export type Connector = {
-  id: ID;
-  name: string;
-  queues: Array<Url>;
-  url: Url;
-  serviceUrl: Url;
-  params: string | null;
-  authorizationToken: string;
-  authorizationType: string;
-  clientSslCertificate: string | null;
-  clientSslKey?: string;
-  asynchronous: boolean;
-  metadata?: unknown;
-};

package/src/connectors/models/index.ts

@@ -1,2 +0,0 @@
-export * from './connector.schema';
-export * from './connector';

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

@@ -1,10 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const dedicatedEngineSchemaCreatePayloadSchema = z.object({
-  content: z.object({
-    trainingQueues: z.array(urlSchema),
-    fields: z.array(z.unknown()),
-  }),
-});

package/src/dedicatedEngineSchema/endpoints/create.ts

@@ -1,22 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { DedicatedEngineSchema } from '../models/dedicatedEngineSchema';
-import { dedicatedEngineSchemaSchema } from '../models/dedicatedEngineSchema.schema';
-import { dedicatedEngineSchemaCreatePayloadSchema } from './create.schema';
-
-export type DedicatedEngineSchemaCreatePayload = {
-  content: {
-    trainingQueues: Url[];
-    fields: unknown[];
-  };
-};
-
-export const create = (payload: DedicatedEngineSchemaCreatePayload) => {
-  return {
-    endpoint: `/dedicated_engine_schemas`,
-    method: 'POST',
-    responseSchema: dedicatedEngineSchemaSchema,
-    payload,
-    payloadSchema: dedicatedEngineSchemaCreatePayloadSchema,
-  } as const;
-};

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

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

package/src/dedicatedEngineSchema/endpoints/get.ts

@@ -1,22 +0,0 @@
-import { ID } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { DedicatedEngineSchema } from '../models/dedicatedEngineSchema';
-import { dedicatedEngineSchemaSchema } from '../models/dedicatedEngineSchema.schema';
-import { dedicatedEngineSchemaGetQuerySchema } from './get.schema';
-
-export type DedicatedEngineSchemaGetQuery = Partial<{
-  fields: ('id' | 'url' | 'content')[];
-}>;
-
-export const get = (
-  engineSchemaId: ID,
-  query: DedicatedEngineSchemaGetQuery = {}
-) => {
-  return {
-    endpoint: `/dedicated_engine_schemas/${engineSchemaId}`,
-    method: 'GET',
-    responseSchema: dedicatedEngineSchemaSchema,
-    query,
-    querySchema: dedicatedEngineSchemaGetQuerySchema,
-  } as const;
-};

package/src/dedicatedEngineSchema/endpoints/index.ts

@@ -1,17 +0,0 @@
-import { create } from './create';
-import { get } from './get';
-import { patch } from './patch';
-import { predict } from './predict';
-import { validate } from './validate';
-export { type DedicatedEngineSchemaPatchPayload } from './patch';
-export { type DedicatedEngineSchemaCreatePayload } from './create';
-export { type DedicatedEngineSchemaGetQuery } from './get';
-export { type DedicatedEngineSchemaValidatePayload } from './validate';
-
-export const engineSchemas = {
-  get,
-  create,
-  patch,
-  predict,
-  validate,
-};

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

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-import { dedicatedEngineSchemaObjectPatchModelSchema } from '../models/dedicatedEngineSchemaObject.schema';
-
-export const dedicatedEngineSchemaPatchPayloadSchema = z.object({
-  content: z.object({
-    trainingQueues: z.array(urlSchema),
-    fields: z.array(dedicatedEngineSchemaObjectPatchModelSchema),
-  }),
-});

package/src/dedicatedEngineSchema/endpoints/patch.ts

@@ -1,26 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { DedicatedEngineSchema } from '../models/dedicatedEngineSchema';
-import { dedicatedEngineSchemaSchema } from '../models/dedicatedEngineSchema.schema';
-import { DedicatedEngineSchemaObjectPatchModel } from '../models/dedicatedEngineSchemaObject';
-import { dedicatedEngineSchemaPatchPayloadSchema } from './patch.schema';
-
-export type DedicatedEngineSchemaPatchPayload = {
-  content: {
-    trainingQueues: Url[];
-    fields: DedicatedEngineSchemaObjectPatchModel[];
-  };
-};
-
-export const patch = (
-  engineSchemaId: ID,
-  payload: DedicatedEngineSchemaPatchPayload
-) => {
-  return {
-    endpoint: `/dedicated_engine_schemas/${engineSchemaId}`,
-    method: 'PATCH',
-    responseSchema: dedicatedEngineSchemaSchema,
-    payloadSchema: dedicatedEngineSchemaPatchPayloadSchema,
-    payload,
-  } as const;
-};

package/src/dedicatedEngineSchema/endpoints/predict.schema.ts

@@ -1,12 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-import { dedicatedEngineSchemaContentSchema } from '../models/dedicatedEngineSchema.schema';
-
-export const dedicatedEngineSchemaPredictPayloadSchema = z.object({
-  trainingQueues: z.array(urlSchema),
-});
-
-export const dedicatedEngineSchemaPredictResponseSchema = z.object({
-  content: dedicatedEngineSchemaContentSchema,
-});

package/src/dedicatedEngineSchema/endpoints/predict.ts

@@ -1,25 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { DedicatedEngineSchemaContent } from '../models/dedicatedEngineSchema';
-import {
-  dedicatedEngineSchemaPredictPayloadSchema,
-  dedicatedEngineSchemaPredictResponseSchema,
-} from './predict.schema';
-
-export type DedicatedEngineSchemaPredictPayload = {
-  trainingQueues: Url[];
-};
-
-export type DedicatedEngineSchemaPredictResponse = {
-  content: DedicatedEngineSchemaContent;
-};
-
-export const predict = (payload: DedicatedEngineSchemaPredictPayload) => {
-  return {
-    endpoint: `/dedicated_engine_schemas/predict`,
-    method: 'POST',
-    responseSchema: dedicatedEngineSchemaPredictResponseSchema,
-    payload,
-    payloadSchema: dedicatedEngineSchemaPredictPayloadSchema,
-  } as const;
-};

package/src/dedicatedEngineSchema/endpoints/validate.schema.ts

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-import { dedicatedEngineSchemaObjectPatchModelSchema } from '../models/dedicatedEngineSchemaObject.schema';
-
-export const dedicatedEngineSchemaValidatePayloadSchema = z.object({
-  content: z.object({
-    trainingQueues: z.array(urlSchema),
-    fields: z.array(dedicatedEngineSchemaObjectPatchModelSchema),
-  }),
-});

package/src/dedicatedEngineSchema/endpoints/validate.ts

@@ -1,29 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { DedicatedEngineSchemaObjectPatchModel } from '../models/dedicatedEngineSchemaObject';
-import { DedicatedEngineSchemaValidationResult } from '../models/integrityValidationResults';
-import { dedicatedEngineSchemaValidationResultSchema } from '../models/integrityValidationResults.schema';
-import { dedicatedEngineSchemaValidatePayloadSchema } from './validate.schema';
-
-// TODO: Patch model is inaccurate here even if it is the same
-// using it now to avoid duplication, but open to discussion:
-// How to address this until our TS strict mode is turned on and domain models refactored
-// to Zod?
-// in general these io-ts models are spreading complexity that Zod will help with
-// by using compose/omit/partial utilities?
-export type DedicatedEngineSchemaValidatePayload = {
-  content: {
-    trainingQueues: Url[];
-    fields: DedicatedEngineSchemaObjectPatchModel[];
-  };
-};
-
-export const validate = (payload: DedicatedEngineSchemaValidatePayload) => {
-  return {
-    endpoint: `/dedicated_engine_schemas/validate`,
-    method: 'POST',
-    responseSchema: dedicatedEngineSchemaValidationResultSchema,
-    payload,
-    payloadSchema: dedicatedEngineSchemaValidatePayloadSchema,
-  } as const;
-};

package/src/dedicatedEngineSchema/index.ts

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

package/src/dedicatedEngineSchema/models/datapointField.schema.ts

@@ -1,39 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import {
-  datapointFieldSourceSchema,
-  datapointFieldSourcePatchModelSchema,
-} from './datapointFieldSource.schema';
-
-export const datapointFieldTypeSchema = z.union([
-  z.literal('number'),
-  z.literal('string'),
-  z.literal('date'),
-  z.literal('enum'),
-]);
-
-export const baseDatapointFieldSchema = z.object({
-  category: z.literal('datapoint'),
-  engineOutputId: z.string(),
-  type: datapointFieldTypeSchema,
-  label: z.string(),
-  trained: z.boolean(),
-  description: z.string(),
-  sources: z.array(datapointFieldSourceSchema),
-});
-
-export const datapointFieldPatchModelSchema = z
-  .object({
-    category: z.literal('datapoint'),
-  })
-  .and(
-    z
-      .object({
-        engineOutputId: z.string(),
-        type: datapointFieldTypeSchema,
-        label: z.string(),
-        description: z.string(),
-        sources: z.array(datapointFieldSourcePatchModelSchema),
-      })
-      .partial()
-  );

package/src/dedicatedEngineSchema/models/datapointField.ts

@@ -1,26 +0,0 @@
-import {
-  DatapointFieldSource,
-  DatapointFieldSourcePatchModel,
-} from './datapointFieldSource';
-
-export type DatapointFieldType = 'number' | 'string' | 'date' | 'enum';
-
-export type BaseDatapointField = {
-  category: 'datapoint';
-  engineOutputId: string;
-  type: DatapointFieldType;
-  label: string;
-  trained: boolean; // readonly(D.boolean),
-  description: string;
-  sources: DatapointFieldSource[];
-};
-
-export type DatapointFieldPatchModel = {
-  category: 'datapoint';
-} & Partial<{
-  engineOutputId: string;
-  type: DatapointFieldType;
-  label: string;
-  description: string;
-  sources: DatapointFieldSourcePatchModel[];
-}>;