@rossum/api-client 0.1.18 → 0.1.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (86) hide show
  1. package/index.js +2 -0
  2. package/index.js.map +1 -1
  3. package/package.json +1 -1
  4. package/src/annotations/models/annotationData.schema.js +21 -54
  5. package/src/annotations/models/annotationData.schema.js.map +1 -1
  6. package/src/deleteRecommendations/endpoints/list.js.map +1 -1
  7. package/src/deleteRecommendations/endpoints/list.schema.js +3 -1
  8. package/src/deleteRecommendations/endpoints/list.schema.js.map +1 -1
  9. package/src/documents/endpoints/downloads.js.map +1 -1
  10. package/src/documents/endpoints/downloads.schema.js +17 -5
  11. package/src/documents/endpoints/downloads.schema.js.map +1 -1
  12. package/src/hooks/models/hookUtils.schema.js +5 -1
  13. package/src/hooks/models/hookUtils.schema.js.map +1 -1
  14. package/src/hooks/models/log.schema.js +6 -0
  15. package/src/hooks/models/log.schema.js.map +1 -1
  16. package/src/inboxes/endpoints/index.js +2 -0
  17. package/src/inboxes/endpoints/index.js.map +1 -1
  18. package/src/inboxes/endpoints/list.js +17 -0
  19. package/src/inboxes/endpoints/list.js.map +1 -0
  20. package/src/inboxes/endpoints/list.schema.js +8 -0
  21. package/src/inboxes/endpoints/list.schema.js.map +1 -0
  22. package/src/internal/endpoints/generateRejectionEmail.js +15 -0
  23. package/src/internal/endpoints/generateRejectionEmail.js.map +1 -0
  24. package/src/internal/endpoints/generateRejectionEmail.schema.js +23 -0
  25. package/src/internal/endpoints/generateRejectionEmail.schema.js.map +1 -0
  26. package/src/internal/endpoints/index.js +2 -0
  27. package/src/internal/endpoints/index.js.map +1 -1
  28. package/src/models/annotationStatus.schema.js +1 -0
  29. package/src/models/annotationStatus.schema.js.map +1 -1
  30. package/src/queues/endpoints/upload.js +2 -1
  31. package/src/queues/endpoints/upload.js.map +1 -1
  32. package/src/tasks/endpoints/get.js +2 -1
  33. package/src/tasks/endpoints/get.js.map +1 -1
  34. package/src/tasks/models/asyncTask.schema.js +5 -1
  35. package/src/tasks/models/asyncTask.schema.js.map +1 -1
  36. package/src/uploads/endpoints/index.js +8 -0
  37. package/src/uploads/endpoints/index.js.map +1 -0
  38. package/src/uploads/endpoints/post.js +20 -0
  39. package/src/uploads/endpoints/post.js.map +1 -0
  40. package/src/uploads/endpoints/post.schema.js +12 -0
  41. package/src/uploads/endpoints/post.schema.js.map +1 -0
  42. package/src/utils/requestConfig.js +2 -1
  43. package/src/utils/requestConfig.js.map +1 -1
  44. package/types/index.d.ts +7 -2
  45. package/types/src/annotations/endpoints/list.schema.d.ts +3 -3
  46. package/types/src/annotations/endpoints/patch.schema.d.ts +3 -3
  47. package/types/src/annotations/endpoints/validate.schema.d.ts +170 -170
  48. package/types/src/annotations/models/annotation.schema.d.ts +3 -3
  49. package/types/src/annotations/models/annotationData.d.ts +20 -48
  50. package/types/src/annotations/models/annotationData.schema.d.ts +1950 -1950
  51. package/types/src/annotations/models/annotationListResponse.d.ts +73 -73
  52. package/types/src/annotations/models/annotationListResponse.schema.d.ts +68 -68
  53. package/types/src/annotations/models/editPages.schema.d.ts +11 -11
  54. package/types/src/deleteRecommendations/endpoints/list.d.ts +3 -1
  55. package/types/src/deleteRecommendations/endpoints/list.schema.d.ts +7 -1
  56. package/types/src/documents/endpoints/downloads.d.ts +6 -0
  57. package/types/src/documents/endpoints/downloads.schema.d.ts +18 -2
  58. package/types/src/hookTemplates/models/hookTemplate.schema.d.ts +6 -6
  59. package/types/src/hooks/endpoints/logs.schema.d.ts +70 -0
  60. package/types/src/hooks/endpoints/patch.schema.d.ts +6 -6
  61. package/types/src/hooks/models/hook.schema.d.ts +9 -9
  62. package/types/src/hooks/models/hookUtils.d.ts +3 -2
  63. package/types/src/hooks/models/hookUtils.schema.d.ts +3 -2
  64. package/types/src/hooks/models/log.d.ts +7 -2
  65. package/types/src/hooks/models/log.schema.d.ts +42 -0
  66. package/types/src/inboxes/endpoints/index.d.ts +1 -0
  67. package/types/src/inboxes/endpoints/list.d.ts +7 -0
  68. package/types/src/inboxes/endpoints/list.schema.d.ts +8 -0
  69. package/types/src/internal/endpoints/generateRejectionEmail.d.ts +21 -0
  70. package/types/src/internal/endpoints/generateRejectionEmail.schema.d.ts +56 -0
  71. package/types/src/internal/endpoints/index.d.ts +1 -0
  72. package/types/src/models/annotationStatus.d.ts +1 -1
  73. package/types/src/models/annotationStatus.schema.d.ts +1 -1
  74. package/types/src/queues/endpoints/index.d.ts +1 -1
  75. package/types/src/queues/endpoints/patch.schema.d.ts +3 -3
  76. package/types/src/queues/endpoints/upload.d.ts +1 -1
  77. package/types/src/queues/models/queue.schema.d.ts +3 -3
  78. package/types/src/queues/models/queueCounts.schema.d.ts +1 -1
  79. package/types/src/tasks/endpoints/get.d.ts +1 -1
  80. package/types/src/tasks/endpoints/index.d.ts +1 -1
  81. package/types/src/tasks/models/asyncTask.d.ts +2 -1
  82. package/types/src/tasks/models/asyncTask.schema.d.ts +9 -4
  83. package/types/src/uploads/endpoints/index.d.ts +3 -0
  84. package/types/src/uploads/endpoints/post.d.ts +9 -0
  85. package/types/src/uploads/endpoints/post.schema.d.ts +15 -0
  86. package/types/src/utils/requestConfig.d.ts +1 -0
@@ -13,7 +13,7 @@ export declare const queueSchema: z.ZodObject<{
13
13
  sessionTimeout: z.ZodString;
14
14
  rirUrl: z.ZodNullable<z.ZodString>;
15
15
  rirParams: z.ZodNullable<z.ZodString>;
16
- counts: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"importing">, z.ZodLiteral<"failed_import">, z.ZodLiteral<"split">, z.ZodLiteral<"to_review">, z.ZodLiteral<"reviewing">, z.ZodLiteral<"confirmed">, z.ZodLiteral<"rejected">, z.ZodLiteral<"exporting">, z.ZodLiteral<"exported">, z.ZodLiteral<"failed_export">, z.ZodLiteral<"postponed">, z.ZodLiteral<"deleted">, z.ZodLiteral<"purged">, z.ZodLiteral<"in_workflow">]>, z.ZodNumber>;
16
+ counts: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"created">, z.ZodLiteral<"importing">, z.ZodLiteral<"failed_import">, z.ZodLiteral<"split">, z.ZodLiteral<"to_review">, z.ZodLiteral<"reviewing">, z.ZodLiteral<"confirmed">, z.ZodLiteral<"rejected">, z.ZodLiteral<"exporting">, z.ZodLiteral<"exported">, z.ZodLiteral<"failed_export">, z.ZodLiteral<"postponed">, z.ZodLiteral<"deleted">, z.ZodLiteral<"purged">, z.ZodLiteral<"in_workflow">]>, z.ZodNumber>;
17
17
  defaultScoreThreshold: z.ZodNumber;
18
18
  automationEnabled: z.ZodBoolean;
19
19
  automationLevel: z.ZodUnion<[z.ZodLiteral<"always">, z.ZodLiteral<"confident">, z.ZodLiteral<"never">]>;
@@ -363,7 +363,7 @@ export declare const queueSchema: z.ZodObject<{
363
363
  hooks: string[];
364
364
  rirUrl: string | null;
365
365
  rirParams: string | null;
366
- counts: Partial<Record<"importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow", number>>;
366
+ counts: Partial<Record<"created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow", number>>;
367
367
  defaultScoreThreshold: number;
368
368
  automationEnabled: boolean;
369
369
  automationLevel: "never" | "always" | "confident";
@@ -442,7 +442,7 @@ export declare const queueSchema: z.ZodObject<{
442
442
  hooks: string[];
443
443
  rirUrl: string | null;
444
444
  rirParams: string | null;
445
- counts: Partial<Record<"importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow", number>>;
445
+ counts: Partial<Record<"created" | "importing" | "failed_import" | "split" | "to_review" | "reviewing" | "confirmed" | "rejected" | "exporting" | "exported" | "failed_export" | "postponed" | "deleted" | "purged" | "in_workflow", number>>;
446
446
  defaultScoreThreshold: number;
447
447
  automationEnabled: boolean;
448
448
  automationLevel: "never" | "always" | "confident";
@@ -1,2 +1,2 @@
1
1
  import { z } from 'zod';
2
- export declare const queueCountsSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"importing">, z.ZodLiteral<"failed_import">, z.ZodLiteral<"split">, z.ZodLiteral<"to_review">, z.ZodLiteral<"reviewing">, z.ZodLiteral<"confirmed">, z.ZodLiteral<"rejected">, z.ZodLiteral<"exporting">, z.ZodLiteral<"exported">, z.ZodLiteral<"failed_export">, z.ZodLiteral<"postponed">, z.ZodLiteral<"deleted">, z.ZodLiteral<"purged">, z.ZodLiteral<"in_workflow">]>, z.ZodNumber>;
2
+ export declare const queueCountsSchema: z.ZodRecord<z.ZodUnion<[z.ZodLiteral<"created">, z.ZodLiteral<"importing">, z.ZodLiteral<"failed_import">, z.ZodLiteral<"split">, z.ZodLiteral<"to_review">, z.ZodLiteral<"reviewing">, z.ZodLiteral<"confirmed">, z.ZodLiteral<"rejected">, z.ZodLiteral<"exporting">, z.ZodLiteral<"exported">, z.ZodLiteral<"failed_export">, z.ZodLiteral<"postponed">, z.ZodLiteral<"deleted">, z.ZodLiteral<"purged">, z.ZodLiteral<"in_workflow">]>, z.ZodNumber>;
@@ -4,4 +4,4 @@ import { AsyncTask } from '../models/asyncTask';
4
4
  export type GetAsyncTaskQuery = {
5
5
  noRedirect: boolean;
6
6
  };
7
- export declare const get: (taskId: ID, query: GetAsyncTaskQuery) => ElisRequestConfig<AsyncTask, GetAsyncTaskQuery, never>;
7
+ export declare const get: (taskId: ID, query: GetAsyncTaskQuery, signal?: AbortSignal) => ElisRequestConfig<AsyncTask, GetAsyncTaskQuery, never>;
@@ -1,3 +1,3 @@
1
1
  export declare const tasks: {
2
- get: (taskId: number, query: import("./get").GetAsyncTaskQuery) => import("../../utils/requestConfig").ElisRequestConfig<import("../models/asyncTask").AsyncTask, import("./get").GetAsyncTaskQuery, never>;
2
+ get: (taskId: number, query: import("./get").GetAsyncTaskQuery, signal?: AbortSignal | undefined) => import("../../utils/requestConfig").ElisRequestConfig<import("../models/asyncTask").AsyncTask, import("./get").GetAsyncTaskQuery, never>;
3
3
  };
@@ -1,5 +1,5 @@
1
1
  import { ID, Url } from '../../utils/codecUtils';
2
- export type AsyncTaskType = 'documents_download';
2
+ export type AsyncTaskType = 'documents_download' | 'upload_created';
3
3
  export type AsyncTaskStatus = 'running' | 'succeeded' | 'failed';
4
4
  export type AsyncTask = {
5
5
  id: ID;
@@ -12,5 +12,6 @@ export type AsyncTask = {
12
12
  resultUrl?: Url | null;
13
13
  content?: {
14
14
  fileName?: string;
15
+ upload?: string;
15
16
  };
16
17
  };
@@ -1,5 +1,5 @@
1
1
  import { z } from 'zod';
2
- export declare const asyncTaskTypeSchema: z.ZodLiteral<"documents_download">;
2
+ export declare const asyncTaskTypeSchema: z.ZodUnion<[z.ZodLiteral<"documents_download">, z.ZodLiteral<"upload_created">]>;
3
3
  export declare const asyncTaskStatusSchema: z.ZodUnion<[z.ZodLiteral<"running">, z.ZodLiteral<"succeeded">, z.ZodLiteral<"failed">]>;
4
4
  export declare const asyncTaskSchema: z.ZodObject<{
5
5
  id: z.ZodNumber;
@@ -7,18 +7,21 @@ export declare const asyncTaskSchema: z.ZodObject<{
7
7
  code: z.ZodOptional<z.ZodString>;
8
8
  detail: z.ZodNullable<z.ZodString>;
9
9
  expiresAt: z.ZodString;
10
- type: z.ZodLiteral<"documents_download">;
10
+ type: z.ZodUnion<[z.ZodLiteral<"documents_download">, z.ZodLiteral<"upload_created">]>;
11
11
  status: z.ZodUnion<[z.ZodLiteral<"running">, z.ZodLiteral<"succeeded">, z.ZodLiteral<"failed">]>;
12
12
  resultUrl: z.ZodNullable<z.ZodOptional<z.ZodString>>;
13
13
  content: z.ZodOptional<z.ZodObject<{
14
14
  fileName: z.ZodOptional<z.ZodString>;
15
+ upload: z.ZodOptional<z.ZodString>;
15
16
  }, "strip", z.ZodTypeAny, {
16
17
  fileName?: string | undefined;
18
+ upload?: string | undefined;
17
19
  }, {
18
20
  fileName?: string | undefined;
21
+ upload?: string | undefined;
19
22
  }>>;
20
23
  }, "strip", z.ZodTypeAny, {
21
- type: "documents_download";
24
+ type: "documents_download" | "upload_created";
22
25
  status: "running" | "succeeded" | "failed";
23
26
  url: string;
24
27
  id: number;
@@ -28,9 +31,10 @@ export declare const asyncTaskSchema: z.ZodObject<{
28
31
  resultUrl?: string | null | undefined;
29
32
  content?: {
30
33
  fileName?: string | undefined;
34
+ upload?: string | undefined;
31
35
  } | undefined;
32
36
  }, {
33
- type: "documents_download";
37
+ type: "documents_download" | "upload_created";
34
38
  status: "running" | "succeeded" | "failed";
35
39
  url: string;
36
40
  id: number;
@@ -40,5 +44,6 @@ export declare const asyncTaskSchema: z.ZodObject<{
40
44
  resultUrl?: string | null | undefined;
41
45
  content?: {
42
46
  fileName?: string | undefined;
47
+ upload?: string | undefined;
43
48
  } | undefined;
44
49
  }>;
@@ -0,0 +1,3 @@
1
+ export declare const uploads: {
2
+ post: (queueId: number, data: unknown, name?: string, signal?: AbortSignal | undefined) => import("../../utils/requestConfig").ElisRequestConfig<import("./post").UploadsPostResponse, import("./post").UploadsPostQuery, unknown>;
3
+ };
@@ -0,0 +1,9 @@
1
+ import { Url } from '../../utils/codecUtils';
2
+ import { ElisRequestConfig } from '../../utils/requestConfig';
3
+ export type UploadsPostQuery = {
4
+ queue: number;
5
+ };
6
+ export type UploadsPostResponse = {
7
+ url: Url;
8
+ };
9
+ export declare const post: (queueId: number, data: unknown, name?: string, signal?: AbortSignal) => ElisRequestConfig<UploadsPostResponse, UploadsPostQuery, unknown>;
@@ -0,0 +1,15 @@
1
+ import { z } from 'zod';
2
+ export declare const uploadsPostQuerySchema: z.ZodObject<{
3
+ queue: z.ZodNumber;
4
+ }, "strip", z.ZodTypeAny, {
5
+ queue: number;
6
+ }, {
7
+ queue: number;
8
+ }>;
9
+ export declare const uploadsPostResponseSchema: z.ZodObject<{
10
+ url: z.ZodString;
11
+ }, "strip", z.ZodTypeAny, {
12
+ url: string;
13
+ }, {
14
+ url: string;
15
+ }>;
@@ -10,6 +10,7 @@ type ElisRequestConfigBase = {
10
10
  withRossumRequestOrigin?: boolean;
11
11
  headers?: Record<string, string>;
12
12
  contentType?: ElisContentType;
13
+ signal?: AbortSignal;
13
14
  };
14
15
  type WithQuery<Q> = [Q] extends [never] ? {
15
16
  query?: never;