@rossum/api-client 0.1.23 → 0.1.25

package/src/annotations/models/annotationData.schema.ts

@@ -1,98 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { idSchema, urlSchema } from '../../utils/codecUtils.schema';
-import { gridSchema } from './grid.schema';
-
-const valueContentSchema = z
-  .object({
-    value: z.string().nullable(),
-    normalizedValue: z.string().nullable(),
-    page: z.number().nullable(),
-    position: z
-      .tuple([z.number(), z.number(), z.number(), z.number()])
-      .nullable(),
-    rirText: z.string().nullable(),
-    rirRawText: z.string().nullable(),
-    ocrText: z.string().nullable(),
-    ocrRawText: z.string().nullable(),
-    rirPage: z.number().nullable(),
-    rirPosition: z.array(z.number()).nullable(),
-    ocrPosition: z.array(z.number()).nullable(),
-    rirConfidence: z.number().nullable(),
-    connectorPosition: z.array(z.number()).nullable(),
-    connectorText: z.string().nullable(),
-  })
-  .partial();
-
-export const datapointDataSchema = z.object({
-  id: idSchema.nullable(),
-  url: urlSchema.nullable(),
-  content: valueContentSchema.optional().nullable(),
-  category: z.literal('datapoint').nullable(),
-  schemaId: z.string().nullable(),
-  validationSources: z.array(z.string()).optional().nullable(),
-  timeSpent: z.number().optional().nullable(),
-  timeSpentOverall: z.number().optional().nullable(),
-});
-
-export const tupleDataSchema = z.object({
-  id: idSchema.nullable(),
-  url: urlSchema.nullable(),
-  category: z.literal('tuple').nullable(),
-  children: z.array(datapointDataSchema.nullable()),
-  schemaId: z.string(),
-});
-
-export const multivalueDataSchema = z.object({
-  id: idSchema.nullable(),
-  url: urlSchema.nullable(),
-  content: valueContentSchema.optional().nullable(),
-  children: z
-    .union([z.array(datapointDataSchema), z.array(tupleDataSchema)])
-    .nullable(),
-  category: z.literal('multivalue').nullable(),
-  schemaId: z.string().nullable(),
-  validationSources: z.array(z.string()).optional().nullable(),
-  timeSpent: z.number().optional().nullable(),
-  timeSpentOverall: z.number().optional().nullable(),
-  grid: gridSchema.optional().nullable(),
-  timeSpentGrid: z.number().optional().nullable(),
-  timeSpentGridOverall: z.number().optional().nullable(),
-});
-
-export const sectionDataSchema = z.object({
-  id: idSchema.nullable(),
-  url: urlSchema.nullable(),
-  children: z
-    .array(z.union([multivalueDataSchema, datapointDataSchema]))
-    .nullable(),
-  category: z.literal('section').nullable(),
-  schemaId: z.string().nullable(),
-});
-
-export const annotationDataSchema = z.object({
-  content: z.array(sectionDataSchema),
-  results: z.array(sectionDataSchema),
-});
-
-export const optionsSchema = z.object({
-  value: z.string(),
-  label: z.string(),
-});
-
-export const suggestedOperationsSchema = z.object({
-  op: z.string(),
-  id: z.string(),
-  value: z.object({
-    content: valueContentSchema,
-    hidden: z.boolean().optional(),
-    options: z.array(optionsSchema).optional().nullable(),
-    validation_sources: z.array(z.string()),
-  }),
-});
-
-export const updatedDatapointsSchema = datapointDataSchema.and(
-  z.object({
-    options: z.array(optionsSchema),
-  })
-);

package/src/annotations/models/annotationData.ts

@@ -1,86 +0,0 @@
-import { ID, Url } from '../../utils/codecUtils';
-import { Grid } from './grid';
-
-type ValueContent = Partial<{
-  value: string | null;
-  normalizedValue: string | null;
-  page: number | null;
-  position: null | [number, number, number, number];
-  rirText: string | null;
-  rirRawText: string | null;
-  ocrText: string | null;
-  ocrRawText: string | null;
-  rirPage: number | null;
-  rirPosition: Array<number> | null;
-  ocrPosition: number[] | null;
-  rirConfidence: number | null;
-  connectorPosition: null | Array<number>;
-  connectorText: string | null;
-}>;
-
-export type DatapointData = {
-  id: ID | null;
-  url: Url | null;
-  content?: ValueContent | null;
-  category: 'datapoint' | null;
-  schemaId: string | null;
-  validationSources?: Array<string> | null;
-  timeSpent?: number | null;
-  timeSpentOverall?: number | null;
-};
-
-export type TupleData = {
-  id: ID | null;
-  url: Url | null;
-  category: 'tuple' | null;
-  children: Array<DatapointData | null>;
-  schemaId: string;
-};
-
-export type MultivalueData = {
-  id: ID | null;
-  url: Url | null;
-  content?: ValueContent | null;
-  children: Array<DatapointData> | Array<TupleData> | null;
-  category: 'multivalue' | null;
-  schemaId: string | null;
-  validationSources?: Array<string> | null;
-  timeSpent?: number | null;
-  timeSpentOverall?: number | null;
-  grid?: Grid | null;
-  timeSpentGrid?: number | null;
-  timeSpentGridOverall?: number | null;
-};
-
-export type SectionData = {
-  id: ID | null;
-  url: Url | null;
-  children: Array<MultivalueData | DatapointData> | null;
-  category: 'section' | null;
-  schemaId: string | null;
-};
-
-export type AnnotationData = {
-  content: Array<SectionData>;
-  results: Array<SectionData>;
-};
-
-export type UpdatedDatapoints = DatapointData & {
-  options: Array<Options>;
-};
-
-export type Options = {
-  value: string;
-  label: string;
-};
-
-export type SuggestedOperations = {
-  op: string;
-  id: string;
-  value: {
-    content: ValueContent;
-    hidden?: boolean;
-    options?: Array<Options> | null;
-    validation_sources: Array<string>;
-  };
-};

package/src/annotations/models/annotationListSideload.schema.ts

@@ -1,43 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { documentSchema } from '../../documents/models/document.schema';
-import { labelSchema } from '../../labels/models/label.schema';
-import { queueSchema } from '../../queues/models/queue.schema';
-import { relationSchema } from '../../relations/models/relations.schema';
-import { userSchema } from '../../users/models/user.schema';
-import { workspaceSchema } from '../../workspaces/models/workspace.schema';
-import {
-  datapointDataSchema,
-  multivalueDataSchema,
-} from './annotationData.schema';
-
-export const sideloadOptionsSchema = z.union([
-  z.literal('documents'),
-  z.literal('modifiers'),
-  z.literal('content'),
-  z.literal('assignees'),
-  z.literal('relations'),
-  z.literal('labels'),
-  z.literal('childRelations'),
-  z.literal('exportedBys'),
-  z.literal('deletedBys'),
-  z.literal('confirmedBys'),
-  z.literal('rejectedBys'),
-  z.literal('workspaces'),
-]);
-
-export const annotationListSideloadSchema = z.object({
-  documents: z.array(documentSchema),
-  modifiers: z.array(userSchema),
-  content: z.array(z.union([datapointDataSchema, multivalueDataSchema])),
-  assignees: z.array(userSchema),
-  labels: z.array(labelSchema),
-  relations: z.array(relationSchema),
-  childRelations: z.array(relationSchema),
-  queues: z.array(queueSchema),
-  exportedBys: z.array(userSchema),
-  rejectedBys: z.array(userSchema),
-  confirmedBys: z.array(userSchema),
-  deletedBys: z.array(userSchema),
-  workspaces: z.array(workspaceSchema),
-});

package/src/annotations/models/annotationListSideload.ts

@@ -1,37 +0,0 @@
-import { Document } from '../../documents/models/document';
-import { Label } from '../../labels/models/label';
-import { Queue } from '../../queues/models/queue';
-import { Relation } from '../../relations/models/relations';
-import { User } from '../../users/models/user';
-import { Workspace } from '../../workspaces/models/workspace';
-import { DatapointData, MultivalueData } from './annotationData';
-
-export type SideloadOptions =
-  | 'documents'
-  | 'modifiers'
-  | 'content'
-  | 'assignees'
-  | 'relations'
-  | 'labels'
-  | 'childRelations'
-  | 'exportedBys'
-  | 'deletedBys'
-  | 'confirmedBys'
-  | 'rejectedBys'
-  | 'workspaces';
-
-export type AnnotationListSideload = {
-  documents: Document[];
-  modifiers: User[];
-  content: (DatapointData | MultivalueData)[];
-  assignees: User[];
-  labels: Label[];
-  relations: Relation[];
-  childRelations: Relation[];
-  queues: Queue[];
-  exportedBys: User[];
-  rejectedBys: User[];
-  confirmedBys: User[];
-  deletedBys: User[];
-  workspaces: Workspace[];
-};

package/src/annotations/models/annotationStart.schema.ts

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

package/src/annotations/models/annotationStart.ts

@@ -1,4 +0,0 @@
-export type AnnotationStart = {
-  annotation: string;
-  sessionTimeout: string;
-};

package/src/annotations/models/editPages.schema.ts

@@ -1,42 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { annotationStatusSchema } from '../../shared/models/annotationStatus.schema';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const parentPageSchema = z.object({
-  page: urlSchema,
-  rotationDeg: z.number(),
-});
-
-export const editDataSourceSchema = z.union([
-  z.literal('automation'),
-  z.literal('suggest'),
-  z.literal('modified_suggest'),
-  z.literal('manual'),
-]);
-
-export const accessibleChildAnnotationSchema = z.object({
-  url: urlSchema,
-  queue: urlSchema,
-  status: annotationStatusSchema,
-  started: z.boolean(),
-  originalFileName: z.string(),
-  parentPages: z.array(parentPageSchema),
-});
-
-export const inaccessibleChildAnnotationSchema = z.object({
-  started: z.literal(false),
-  originalFileName: z.string(),
-  parentPages: z.array(parentPageSchema),
-});
-
-export const childAnnotationSchema = z.union([
-  accessibleChildAnnotationSchema,
-  inaccessibleChildAnnotationSchema,
-]);
-
-export const startEditPagesResponseSchema = z.object({
-  parentAnnotation: urlSchema,
-  sessionTimeout: z.string(),
-  children: z.array(childAnnotationSchema),
-});

package/src/annotations/models/editPages.ts

@@ -1,37 +0,0 @@
-import { AnnotationStatus } from '../../shared/models/annotationStatus';
-import { Url } from '../../utils/codecUtils';
-
-export type StartEditPagesResponse = {
-  parentAnnotation: Url;
-  sessionTimeout: string;
-  children: ChildAnnotation[];
-};
-
-export type ChildAnnotation =
-  | AccessibleChildAnnotation
-  | InaccessibleChildAnnotation;
-
-export type AccessibleChildAnnotation = {
-  url: Url;
-  queue: Url;
-  status: AnnotationStatus;
-  started: boolean;
-  originalFileName: string;
-  parentPages: ParentPage[];
-};
-
-export type InaccessibleChildAnnotation = {
-  started: false;
-  originalFileName: string;
-  parentPages: ParentPage[];
-};
-export type ParentPage = {
-  page: Url;
-  rotationDeg: number;
-};
-
-export type EditDataSource =
-  | 'automation'
-  | 'suggest'
-  | 'modified_suggest'
-  | 'manual';

package/src/annotations/models/grid.schema.ts

@@ -1,27 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const gridSchema = z
-  .object({
-    parts: z.array(
-      z.object({
-        page: z.number(),
-        columns: z.array(
-          z.object({
-            leftPosition: z.number(),
-            schemaId: z.string().nullable(),
-            headerTexts: z.array(z.string()),
-          })
-        ),
-        rows: z.array(
-          z.object({
-            topPosition: z.number(),
-            type: z.string().nullable(),
-          })
-        ),
-        width: z.number(),
-        height: z.number(),
-      })
-    ),
-  })
-  .nullable();

package/src/annotations/models/grid.ts

@@ -1,16 +0,0 @@
-export type Grid = {
-  parts: Array<{
-    page: number;
-    columns: Array<{
-      leftPosition: number;
-      schemaId: string | null;
-      headerTexts: Array<string>;
-    }>;
-    rows: Array<{
-      topPosition: number;
-      type: string | null;
-    }>;
-    width: number;
-    height: number;
-  }>;
-} | null;

package/src/annotations/models/index.ts

@@ -1,12 +0,0 @@
-export * from './annotation';
-export * from './annotation.schema';
-export * from './annotationData';
-export * from './annotationData.schema';
-export * from './editPages';
-export * from './editPages.schema';
-export * from './annotationStart';
-export * from './annotationStart.schema';
-export * from './usageReport';
-export * from './usageReport.schema';
-export * from './annotationListSideload';
-export * from './pageData';

package/src/annotations/models/pageData.schema.ts

@@ -1,18 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const pageDataItemSchema = z.object({
-  position: z.tuple([z.number(), z.number(), z.number(), z.number()]),
-  text: z.string(),
-});
-
-export const pageDataSchema = z.object({
-  pageNumber: z.number(),
-  granularity: z.union([
-    z.literal('words'),
-    z.literal('lines'),
-    z.literal('chars'),
-    z.literal('texts'),
-  ]),
-  items: z.array(pageDataItemSchema),
-});

package/src/annotations/models/pageData.ts

@@ -1,10 +0,0 @@
-export type PageDataItem = {
-  position: [number, number, number, number];
-  text: string;
-};
-
-export type PageData = {
-  pageNumber: number;
-  granularity: 'words' | 'lines' | 'chars' | 'texts';
-  items: PageDataItem[];
-};

package/src/annotations/models/processingDuration.schema.ts

@@ -1,11 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const processingDurationSchema = z.object({
-  timeSpentActive: z.number(),
-  timeSpentOverall: z.number(),
-  timeSpentEdit: z.number(),
-  timeSpentEmails: z.number(),
-  timeSpentBlockers: z.number(),
-  timeSpentOpening: z.number(),
-});

package/src/annotations/models/processingDuration.ts

@@ -1,8 +0,0 @@
-export type ProcessingDuration = {
-  timeSpentActive: number;
-  timeSpentOverall: number;
-  timeSpentEdit: number;
-  timeSpentEmails: number;
-  timeSpentBlockers: number;
-  timeSpentOpening: number;
-};

package/src/annotations/models/usageReport.schema.ts

@@ -1,46 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const timeAndCorrectionsPerFieldSchema = z.object({
-  schemaId: z.string(),
-  label: z.string(),
-  totalCount: z.number(),
-  correctedRatio: z.number(),
-  timeSpentAvgS: z.number(),
-});
-
-export const valuesBaseSchema = z
-  .object({
-    importedCount: z.number().nullable(),
-    exportedCount: z.number().nullable(),
-    deletedCount: z.number().nullable(),
-    confirmedCount: z.number().nullable(),
-    rejectedAutomaticallyCount: z.number().nullable(),
-    rejectedCount: z.number().nullable(),
-    rejectedManuallyCount: z.number().nullable(),
-    turnaroundAvgS: z.number().nullable(),
-    correctionsPerDocumentAvg: z.number().nullable(),
-    exportedOnTimeCount: z.number().nullable(),
-    exportedLateCount: z.number().nullable(),
-    exportedAutomatedCount: z.number().nullable(),
-    timePerDocumentAvgS: z.number().nullable(),
-    usage: z.number().nullable(),
-  })
-  .partial();
-
-const valuesSchema = z
-  .object({
-    timeAndCorrectionsPerField: z.array(timeAndCorrectionsPerFieldSchema),
-  })
-  .and(valuesBaseSchema);
-
-export const serieSchema = z.object({
-  beginDate: z.string(),
-  endDate: z.string(),
-  values: valuesSchema,
-});
-
-export const usageReportSchema = z.object({
-  series: z.array(serieSchema),
-  totals: valuesBaseSchema,
-});

package/src/annotations/models/usageReport.ts

@@ -1,39 +0,0 @@
-export type TimeAndCorrectionsPerField = {
-  schemaId: string;
-  label: string;
-  totalCount: number;
-  correctedRatio: number;
-  timeSpentAvgS: number;
-};
-
-export type ValuesBase = Partial<{
-  importedCount: number | null;
-  exportedCount: number | null;
-  deletedCount: number | null;
-  confirmedCount: number | null;
-  rejectedAutomaticallyCount: number | null;
-  rejectedCount: number | null;
-  rejectedManuallyCount: number | null;
-  turnaroundAvgS: number | null;
-  correctionsPerDocumentAvg: number | null;
-  exportedOnTimeCount: number | null;
-  exportedLateCount: number | null;
-  exportedAutomatedCount: number | null;
-  timePerDocumentAvgS: number | null;
-  usage: number | null;
-}>;
-
-type Values = {
-  timeAndCorrectionsPerField: Array<TimeAndCorrectionsPerField>;
-} & ValuesBase;
-
-export type Serie = {
-  beginDate: string;
-  endDate: string;
-  values: Values;
-};
-
-export type UsageReport = {
-  series: Array<Serie>;
-  totals: ValuesBase;
-};

package/src/authentication/endpoints/getMembershipToken.schema.ts

@@ -1,13 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-import { urlSchema } from '../../utils/codecUtils.schema';
-
-export const membershipTokenPaylodSchema = z.object({
-  organization: urlSchema,
-  origin: z.string().optional(),
-});
-
-export const membershipTokenResponseSchema = z.object({
-  key: z.string(),
-  organization: urlSchema,
-});

package/src/authentication/endpoints/getMembershipToken.ts

@@ -1,26 +0,0 @@
-import { Url } from '../../utils/codecUtils';
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import {
-  membershipTokenPaylodSchema,
-  membershipTokenResponseSchema,
-} from './getMembershipToken.schema';
-
-export type MembershipTokenPaylod = {
-  organization: Url;
-  origin?: string;
-};
-
-export type MembershipTokenResponse = {
-  key: string;
-  organization: Url;
-};
-
-export const getMembershipToken = (payload: MembershipTokenPaylod) => {
-  return {
-    endpoint: `/auth/membership_token`,
-    method: 'POST',
-    responseSchema: membershipTokenResponseSchema,
-    payloadSchema: membershipTokenPaylodSchema,
-    payload,
-  } as const;
-};

package/src/authentication/endpoints/index.ts

@@ -1,29 +0,0 @@
-import { getMembershipToken } from './getMembershipToken';
-import { login } from './login';
-import { changePassword } from './password/change';
-import { confirmPassword } from './password/confirm';
-import { resetPassword } from './password/reset';
-import { scorePassword } from './password/score';
-import { patch } from './patch';
-import { token } from './token';
-import { user } from './user';
-export { type LoginPayload } from './login';
-export { type ChangePasswordPayload } from './password/change';
-export {
-  type ScorePasswordPayload,
-  type ScorePasswordResponse,
-} from './password/score';
-
-export const authentication = {
-  login,
-  token,
-  user,
-  patch,
-  getMembershipToken,
-  password: {
-    change: changePassword,
-    confirm: confirmPassword,
-    reset: resetPassword,
-    score: scorePassword,
-  },
-};

package/src/authentication/endpoints/login.schema.ts

@@ -1,9 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const loginPayloadSchema = z.object({
-  username: z.string(),
-  password: z.string(),
-  scope: z.string().optional(),
-  origin: z.string().optional(),
-});

package/src/authentication/endpoints/login.ts

@@ -1,22 +0,0 @@
-import { ElisRequestConfig } from '../../utils/requestConfig';
-import { AuthInfo } from '../models/authInfo';
-import { authInfoSchema } from '../models/authInfo.schema';
-import { loginPayloadSchema } from './login.schema';
-
-export type LoginPayload = {
-  username: string;
-  password: string;
-  scope?: string;
-  origin?: string;
-};
-
-export const login = (payload: LoginPayload) => {
-  return {
-    authorize: false,
-    endpoint: `/auth/login`,
-    method: 'POST',
-    responseSchema: authInfoSchema,
-    payloadSchema: loginPayloadSchema,
-    payload,
-  } as const;
-};

package/src/authentication/endpoints/password/change.schema.ts

@@ -1,12 +0,0 @@
-// Generated by ts-to-zod
-import { z } from 'zod';
-
-export const changePasswordPayloadSchema = z.object({
-  new_password1: z.string(),
-  new_password2: z.string(),
-  old_password: z.string(),
-});
-
-export const changePasswordResponseSchema = z.object({
-  detail: z.string(),
-});