@d19n/youfibre-odin-sdk 2.0.342 → 2.0.344

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 (98) hide show
  1. package/README.md +26 -2
  2. package/dist/EntityRegistry.d.ts +4 -0
  3. package/dist/EntityRegistry.js +4 -0
  4. package/dist/OdinApiClient.d.ts +8 -0
  5. package/dist/OdinApiClient.js +16 -0
  6. package/dist/OdinDbClient.d.ts +8 -0
  7. package/dist/OdinDbClient.js +16 -0
  8. package/dist/accessors-v2/DocumentAccessor.d.ts +112 -0
  9. package/dist/accessors-v2/DocumentAccessor.js +191 -0
  10. package/dist/accessors-v2/DocumentProcessingAccessor.d.ts +112 -0
  11. package/dist/accessors-v2/DocumentProcessingAccessor.js +191 -0
  12. package/dist/accessors-v2/index.d.ts +2 -0
  13. package/dist/accessors-v2/index.js +7 -3
  14. package/dist/actions-v2/CreateAiRouteRequestDto.d.ts +1 -1
  15. package/dist/actions-v2/CreateChurnRequestDto.d.ts +2 -0
  16. package/dist/actions-v2/CreateChurnRequestDto.js +2 -0
  17. package/dist/actions-v2/CreateDocumentDto.d.ts +235 -0
  18. package/dist/actions-v2/CreateDocumentDto.js +57 -0
  19. package/dist/actions-v2/CreateDocumentProcessingDto.d.ts +192 -0
  20. package/dist/actions-v2/CreateDocumentProcessingDto.js +57 -0
  21. package/dist/actions-v2/CreateLeadSalesAppDto.d.ts +9 -17
  22. package/dist/actions-v2/UpdateDocumentDto.d.ts +236 -0
  23. package/dist/actions-v2/UpdateDocumentDto.js +59 -0
  24. package/dist/actions-v2/UpdateMessageReadByCustomerDto.d.ts +72 -0
  25. package/dist/actions-v2/UpdateMessageReadByCustomerDto.js +56 -0
  26. package/dist/api-sdk-v2/CommitmentApi.d.ts +48 -0
  27. package/dist/api-sdk-v2/CommitmentApi.js +155 -0
  28. package/dist/api-sdk-v2/ContractBuyOutApi.d.ts +2 -0
  29. package/dist/api-sdk-v2/ContractBuyOutApi.js +6 -0
  30. package/dist/api-sdk-v2/DocumentApi.d.ts +52 -0
  31. package/dist/api-sdk-v2/DocumentApi.js +167 -0
  32. package/dist/api-sdk-v2/DocumentProcessingApi.d.ts +50 -0
  33. package/dist/api-sdk-v2/DocumentProcessingApi.js +161 -0
  34. package/dist/api-sdk-v2/EquipmentReturnApi.d.ts +45 -0
  35. package/dist/api-sdk-v2/EquipmentReturnApi.js +151 -0
  36. package/dist/api-sdk-v2/EquipmentReturnItemApi.d.ts +45 -0
  37. package/dist/api-sdk-v2/EquipmentReturnItemApi.js +151 -0
  38. package/dist/api-sdk-v2/FileApi.d.ts +4 -0
  39. package/dist/api-sdk-v2/FileApi.js +12 -0
  40. package/dist/api-sdk-v2/OrderApi.d.ts +2 -0
  41. package/dist/api-sdk-v2/OrderApi.js +6 -0
  42. package/dist/db-accessors-v2/DocumentDbAccessor.d.ts +180 -0
  43. package/dist/db-accessors-v2/DocumentDbAccessor.js +265 -0
  44. package/dist/db-accessors-v2/DocumentProcessingDbAccessor.d.ts +180 -0
  45. package/dist/db-accessors-v2/DocumentProcessingDbAccessor.js +265 -0
  46. package/dist/db-accessors-v2/index.d.ts +2 -0
  47. package/dist/db-accessors-v2/index.js +7 -3
  48. package/dist/db-sdk-v2/CommitmentDb.d.ts +120 -0
  49. package/dist/db-sdk-v2/CommitmentDb.js +204 -0
  50. package/dist/db-sdk-v2/ContractBuyOutDb.d.ts +2 -0
  51. package/dist/db-sdk-v2/ContractBuyOutDb.js +6 -0
  52. package/dist/db-sdk-v2/DocumentDb.d.ts +124 -0
  53. package/dist/db-sdk-v2/DocumentDb.js +216 -0
  54. package/dist/db-sdk-v2/DocumentProcessingDb.d.ts +122 -0
  55. package/dist/db-sdk-v2/DocumentProcessingDb.js +210 -0
  56. package/dist/db-sdk-v2/EquipmentReturnDb.d.ts +117 -0
  57. package/dist/db-sdk-v2/EquipmentReturnDb.js +200 -0
  58. package/dist/db-sdk-v2/EquipmentReturnItemDb.d.ts +117 -0
  59. package/dist/db-sdk-v2/EquipmentReturnItemDb.js +200 -0
  60. package/dist/db-sdk-v2/FileDb.d.ts +4 -0
  61. package/dist/db-sdk-v2/FileDb.js +12 -0
  62. package/dist/db-sdk-v2/OrderDb.d.ts +2 -0
  63. package/dist/db-sdk-v2/OrderDb.js +6 -0
  64. package/dist/entities-v2/AiRouteRequest.d.ts +23 -11
  65. package/dist/entities-v2/AiRouteRequest.js +15 -3
  66. package/dist/entities-v2/Commitment.d.ts +154 -0
  67. package/dist/entities-v2/Commitment.js +115 -0
  68. package/dist/entities-v2/ContractBuyOut.d.ts +7 -0
  69. package/dist/entities-v2/ContractBuyOut.js +5 -1
  70. package/dist/entities-v2/Document.d.ts +1145 -0
  71. package/dist/entities-v2/Document.js +220 -0
  72. package/dist/entities-v2/DocumentProcessing.d.ts +272 -0
  73. package/dist/entities-v2/DocumentProcessing.js +156 -0
  74. package/dist/entities-v2/EquipmentReturn.d.ts +66 -0
  75. package/dist/entities-v2/EquipmentReturn.js +64 -0
  76. package/dist/entities-v2/EquipmentReturnItem.d.ts +66 -0
  77. package/dist/entities-v2/EquipmentReturnItem.js +64 -0
  78. package/dist/entities-v2/File.d.ts +81 -1
  79. package/dist/entities-v2/File.js +9 -1
  80. package/dist/entities-v2/Message.d.ts +27 -1
  81. package/dist/entities-v2/Message.js +2 -0
  82. package/dist/entities-v2/Order.d.ts +49 -8
  83. package/dist/entities-v2/Order.js +24 -4
  84. package/dist/entities-v2/YfStockCount.d.ts +197 -1
  85. package/dist/entities-v2/YfStockCount.js +28 -0
  86. package/dist/records-v2/ContractBuyOutRecord.d.ts +20 -0
  87. package/dist/records-v2/ContractBuyOutRecord.js +33 -0
  88. package/dist/records-v2/DocumentProcessingRecord.d.ts +227 -0
  89. package/dist/records-v2/DocumentProcessingRecord.js +315 -0
  90. package/dist/records-v2/DocumentRecord.d.ts +355 -0
  91. package/dist/records-v2/DocumentRecord.js +468 -0
  92. package/dist/records-v2/FileRecord.d.ts +59 -3
  93. package/dist/records-v2/FileRecord.js +83 -1
  94. package/dist/records-v2/MessageRecord.d.ts +28 -0
  95. package/dist/records-v2/MessageRecord.js +37 -0
  96. package/dist/records-v2/index.d.ts +2 -0
  97. package/dist/records-v2/index.js +10 -4
  98. package/package.json +1 -1
@@ -0,0 +1,192 @@
1
+ /**
2
+ * CreateDocumentProcessing Action DTO
3
+ *
4
+ * CreateDocumentProcessing
5
+ *
6
+ * @module AiModule
7
+ * @entity DocumentProcessing
8
+ * @entityType DEFAULT
9
+ * @actionKey CreateDocumentProcessing
10
+ * @event k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for CreateDocumentProcessing created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing
19
+ */
20
+ export interface CreateDocumentProcessingMessage extends OdinRecordCreatedEvent<CreateDocumentProcessingDto, CreateDocumentProcessingProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateDocumentProcessing action
24
+ *
25
+ * @property Required fields: 3
26
+ * @property Optional fields: 15
27
+ */
28
+ export interface CreateDocumentProcessingProperties {
29
+ /**
30
+ * Use case
31
+ *
32
+ * What the run did. Add values as producers are added.
33
+ * @type {ENUM}
34
+ * @required
35
+ */
36
+ UseCase: string;
37
+ /**
38
+ * Started at
39
+ *
40
+ * When the run started.
41
+ * @type {DATE_TIME}
42
+ * @required
43
+ */
44
+ StartedAt: string;
45
+ /**
46
+ * Status
47
+ *
48
+ * SUCCESS when every part ran; PARTIAL when some questions or pages were not processed; FAILED when nothing was written.
49
+ * @type {ENUM}
50
+ * @required
51
+ */
52
+ Status: string;
53
+ /**
54
+ * Pipeline
55
+ *
56
+ * The code path that ran, e.g. V10926FormReviewService.
57
+ * @type {TEXT}
58
+ */
59
+ PipelineName?: string | null;
60
+ /**
61
+ * Pipeline version
62
+ *
63
+ * Rubric spreadsheet version, prompt version or release tag.
64
+ * @type {TEXT}
65
+ */
66
+ PipelineVersion?: string | null;
67
+ /**
68
+ * Provider
69
+ *
70
+ * Which model provider answered.
71
+ * @type {ENUM}
72
+ */
73
+ Provider?: string | null;
74
+ /**
75
+ * Model
76
+ *
77
+ * Model id reported by the provider, e.g. Qwen3.8-27B-FP8.
78
+ * @type {TEXT}
79
+ */
80
+ Model?: string | null;
81
+ /**
82
+ * Prompt or rubric hash
83
+ *
84
+ * sha256 of the prompt or rubric the run used.
85
+ * @type {TEXT}
86
+ */
87
+ PromptOrRubricHash?: string | null;
88
+ /**
89
+ * Finished at
90
+ *
91
+ * When the run finished.
92
+ * @type {DATE_TIME}
93
+ */
94
+ FinishedAt?: string | null;
95
+ /**
96
+ * Duration (ms)
97
+ *
98
+ * Wall time of the run.
99
+ * @type {NUMBER}
100
+ */
101
+ DurationMs?: number | null;
102
+ /**
103
+ * Outcome
104
+ *
105
+ * Short human summary: for a review, PASS, FAIL and skipped counts; for describe, characters written.
106
+ * @type {TEXT}
107
+ */
108
+ OutcomeSummary?: string | null;
109
+ /**
110
+ * Outcome record entity
111
+ *
112
+ * Entity of the record the run wrote, e.g. FieldServiceModule:OutcomeFormValidation or SupportModule:Note.
113
+ * @type {TEXT}
114
+ */
115
+ OutcomeRecordEntity?: string | null;
116
+ /**
117
+ * Outcome record id
118
+ *
119
+ * Id of that record.
120
+ * @type {TEXT}
121
+ */
122
+ OutcomeRecordId?: string | null;
123
+ /**
124
+ * Process execution id
125
+ *
126
+ * Id of the process-execution record for the run.
127
+ * @type {TEXT}
128
+ */
129
+ ProcessExecutionId?: string | null;
130
+ /**
131
+ * AI route request id
132
+ *
133
+ * Id of the AiRouteRequest row for the model call, where one exists.
134
+ * @type {TEXT}
135
+ */
136
+ AiRouteRequestId?: string | null;
137
+ /**
138
+ * Error category
139
+ *
140
+ * SYSTEM_ERROR, USER_RESOLVABLE, EXTERNAL_ERROR, TIMEOUT or CANCELLED when the run failed.
141
+ * @type {TEXT}
142
+ */
143
+ ErrorCategory?: string | null;
144
+ /**
145
+ * Error
146
+ *
147
+ * First 500 characters of the failure message.
148
+ * @type {TEXT}
149
+ */
150
+ ErrorMessage?: string | null;
151
+ /**
152
+ * Has detail file
153
+ *
154
+ * True when a PROCESSING_OUTPUT file is linked with the per-question or per-page detail.
155
+ * @type {BOOLEAN}
156
+ */
157
+ HasDetailFile?: boolean | null;
158
+ }
159
+ /**
160
+ * CreateDocumentProcessing
161
+ *
162
+ * @actionType CREATE - Creates a new DocumentProcessing record
163
+ * @module AiModule
164
+ * @entity DocumentProcessing
165
+ * @entityType DEFAULT (Default)
166
+ * @event k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing
167
+ * @permission schema.action.createdocumentprocessing.trigger
168
+ * @benchmark This action is tracked for performance benchmarks
169
+ */
170
+ export declare class CreateDocumentProcessingDto extends OdinRecordCreateDto<CreateDocumentProcessingProperties> {
171
+ /** Used by SDK generators to identify action type */
172
+ static readonly ACTION_TYPE = "CREATE";
173
+ static readonly ACTION_KEY = "CreateDocumentProcessing";
174
+ static readonly MODULE_NAME = "AiModule";
175
+ static readonly ENTITIES: string[];
176
+ static readonly ENTITY_TYPE = "DEFAULT";
177
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing";
178
+ static readonly PERMISSION = "schema.action.createdocumentprocessing.trigger";
179
+ /** Step metadata - entity this action targets */
180
+ static readonly STEP_ENTITY = "AiModule:DocumentProcessing";
181
+ static readonly STEP_SCHEMA_ID = "c08e5012-2a2c-4dfb-a5e1-5c3107056630";
182
+ static readonly STEP_SCHEMA_ACTION_ID = "e0f59b9e-e1a9-4b22-ba02-64d67403ec4d";
183
+ static readonly STEP_SCHEMA_TYPE_ID = "a77f2e0b-2e7a-44aa-8ea7-19b6908df82e";
184
+ static readonly STEP_TYPE = "DEFAULT";
185
+ static readonly AUTO_LINK_PARENT = true;
186
+ readonly actionName: string;
187
+ readonly schemaActionId: string;
188
+ readonly entity: string;
189
+ constructor(properties: CreateDocumentProcessingProperties, options?: {
190
+ journeyId?: string;
191
+ });
192
+ }
@@ -0,0 +1,57 @@
1
+ "use strict";
2
+ /**
3
+ * CreateDocumentProcessing Action DTO
4
+ *
5
+ * CreateDocumentProcessing
6
+ *
7
+ * @module AiModule
8
+ * @entity DocumentProcessing
9
+ * @entityType DEFAULT
10
+ * @actionKey CreateDocumentProcessing
11
+ * @event k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateDocumentProcessingDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateDocumentProcessing
20
+ *
21
+ * @actionType CREATE - Creates a new DocumentProcessing record
22
+ * @module AiModule
23
+ * @entity DocumentProcessing
24
+ * @entityType DEFAULT (Default)
25
+ * @event k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing
26
+ * @permission schema.action.createdocumentprocessing.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class CreateDocumentProcessingDto extends core_1.OdinRecordCreateDto {
30
+ constructor(properties, options) {
31
+ super({
32
+ entity: 'AiModule:DocumentProcessing',
33
+ type: 'DEFAULT',
34
+ properties,
35
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
36
+ });
37
+ this.actionName = 'CreateDocumentProcessing';
38
+ this.schemaActionId = 'e0f59b9e-e1a9-4b22-ba02-64d67403ec4d';
39
+ this.entity = 'AiModule:DocumentProcessing';
40
+ }
41
+ }
42
+ exports.CreateDocumentProcessingDto = CreateDocumentProcessingDto;
43
+ /** Used by SDK generators to identify action type */
44
+ CreateDocumentProcessingDto.ACTION_TYPE = 'CREATE';
45
+ CreateDocumentProcessingDto.ACTION_KEY = 'CreateDocumentProcessing';
46
+ CreateDocumentProcessingDto.MODULE_NAME = 'AiModule';
47
+ CreateDocumentProcessingDto.ENTITIES = ['DocumentProcessing'];
48
+ CreateDocumentProcessingDto.ENTITY_TYPE = 'DEFAULT';
49
+ CreateDocumentProcessingDto.EVENT_NAME = 'k1.t-hEOJjsDb.AiModule.DocumentProcessing.Create.CreateDocumentProcessing';
50
+ CreateDocumentProcessingDto.PERMISSION = 'schema.action.createdocumentprocessing.trigger';
51
+ /** Step metadata - entity this action targets */
52
+ CreateDocumentProcessingDto.STEP_ENTITY = 'AiModule:DocumentProcessing';
53
+ CreateDocumentProcessingDto.STEP_SCHEMA_ID = 'c08e5012-2a2c-4dfb-a5e1-5c3107056630';
54
+ CreateDocumentProcessingDto.STEP_SCHEMA_ACTION_ID = 'e0f59b9e-e1a9-4b22-ba02-64d67403ec4d';
55
+ CreateDocumentProcessingDto.STEP_SCHEMA_TYPE_ID = 'a77f2e0b-2e7a-44aa-8ea7-19b6908df82e';
56
+ CreateDocumentProcessingDto.STEP_TYPE = 'DEFAULT';
57
+ CreateDocumentProcessingDto.AUTO_LINK_PARENT = true;
@@ -21,7 +21,7 @@ export interface CreateLeadSalesAppMessage extends OdinRecordCreatedEvent<Create
21
21
  /**
22
22
  * Properties for CreateLeadSalesApp action
23
23
  *
24
- * @property Required fields: 5
24
+ * @property Required fields: 4
25
25
  * @property Optional fields: 0
26
26
  */
27
27
  export interface CreateLeadSalesAppProperties {
@@ -33,6 +33,14 @@ export interface CreateLeadSalesAppProperties {
33
33
  * @required
34
34
  */
35
35
  Name: string;
36
+ /**
37
+ * first name
38
+ *
39
+ * Display name/title for Lead records. Primary identifier for Sales team.
40
+ * @type {TEXT}
41
+ * @required
42
+ */
43
+ FirstName: string;
36
44
  /**
37
45
  * Nast name
38
46
  *
@@ -49,22 +57,6 @@ export interface CreateLeadSalesAppProperties {
49
57
  * @required
50
58
  */
51
59
  Type: string;
52
- /**
53
- * Source
54
- *
55
- * Lead source (Sales - Lead)
56
- * @type {ENUM}
57
- * @required
58
- */
59
- Source: string;
60
- /**
61
- * EmailAddress
62
- *
63
- * email address (Sales - Lead)
64
- * @type {EMAIL}
65
- * @required
66
- */
67
- EmailAddress: string;
68
60
  }
69
61
  /**
70
62
  * CreateLeadSalesApp
@@ -0,0 +1,236 @@
1
+ /**
2
+ * UpdateDocument Action DTO
3
+ *
4
+ * UpdateDocument
5
+ *
6
+ * @module AiModule
7
+ * @entity Document
8
+ * @entityType DEFAULT
9
+ * @actionKey UpdateDocument
10
+ * @event k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for UpdateDocument updated events
17
+ *
18
+ * @event k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument
19
+ */
20
+ export interface UpdateDocumentMessage extends OdinRecordUpdatedEvent<UpdateDocumentDto, UpdateDocumentProperties> {
21
+ }
22
+ /**
23
+ * Properties for UpdateDocument action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 24
27
+ */
28
+ export interface UpdateDocumentProperties {
29
+ /**
30
+ * Source module
31
+ *
32
+ * Module of the record the document belongs to, e.g. FieldServiceModule.
33
+ * @type {TEXT}
34
+ */
35
+ SourceModule?: string | null;
36
+ /**
37
+ * Source entity
38
+ *
39
+ * Entity of the source record, e.g. RegionNInternalInstallForm.
40
+ * @type {TEXT}
41
+ */
42
+ SourceEntity?: string | null;
43
+ /**
44
+ * Source record id
45
+ *
46
+ * Id of the source record. With SourceEntity, the key the helper upserts on.
47
+ * @type {TEXT}
48
+ */
49
+ SourceRecordId?: string | null;
50
+ /**
51
+ * Source record number
52
+ *
53
+ * Record number of the source record, for people.
54
+ * @type {TEXT}
55
+ */
56
+ SourceRecordNumber?: string | null;
57
+ /**
58
+ * Files
59
+ *
60
+ * The File records that make up the document: photos, signatures, PDFs.
61
+ * @type {FILE_MULTIPLE}
62
+ */
63
+ Files?: string | null;
64
+ /**
65
+ * File count
66
+ *
67
+ * Number of File records in Files.
68
+ * @type {NUMBER}
69
+ */
70
+ FileCount?: number | null;
71
+ /**
72
+ * Sub-type
73
+ *
74
+ * Finer kind within the record type: the form entity name, the previous provider, the invoice type.
75
+ * @type {TEXT}
76
+ */
77
+ SubType?: string | null;
78
+ /**
79
+ * Format
80
+ *
81
+ * Physical shape of the document.
82
+ * @type {ENUM}
83
+ */
84
+ Format?: string | null;
85
+ /**
86
+ * Submitted by (id)
87
+ *
88
+ * User or contact id that submitted the document.
89
+ * @type {TEXT}
90
+ */
91
+ SubmittedById?: string | null;
92
+ /**
93
+ * Submitted by
94
+ *
95
+ * Name of the user or contact that submitted the document.
96
+ * @type {TEXT}
97
+ */
98
+ SubmittedByName?: string | null;
99
+ /**
100
+ * Submitted at
101
+ *
102
+ * When the source record was created.
103
+ * @type {DATE_TIME}
104
+ */
105
+ SubmittedAt?: string | null;
106
+ /**
107
+ * Submitted via
108
+ *
109
+ * The channel the document arrived through.
110
+ * @type {ENUM}
111
+ */
112
+ SubmittedVia?: string | null;
113
+ /**
114
+ * Business record entity
115
+ *
116
+ * The business record the document belongs to: FieldServiceModule:WorkOrder, OrderModule:Order, CrmModule:Account.
117
+ * @type {TEXT}
118
+ */
119
+ BusinessRecordEntity?: string | null;
120
+ /**
121
+ * Business record id
122
+ *
123
+ * Id of that business record.
124
+ * @type {TEXT}
125
+ */
126
+ BusinessRecordId?: string | null;
127
+ /**
128
+ * Description
129
+ *
130
+ * AI-written plain-English description of what the document is and contains. Capped at 1,500 characters by the writer.
131
+ * @type {TEXT_LONG}
132
+ */
133
+ Description?: string | null;
134
+ /**
135
+ * Contents
136
+ *
137
+ * One line per image or page. Capped at 400 characters by the writer.
138
+ * @type {TEXT_LONG}
139
+ */
140
+ ContentsSummary?: string | null;
141
+ /**
142
+ * Images
143
+ *
144
+ * Number of images in the document.
145
+ * @type {NUMBER}
146
+ */
147
+ ImageCount?: number | null;
148
+ /**
149
+ * Pages
150
+ *
151
+ * Number of pages, for PDFs and HTML.
152
+ * @type {NUMBER}
153
+ */
154
+ PageCount?: number | null;
155
+ /**
156
+ * Language
157
+ *
158
+ * Language of the document, ISO 639-1, e.g. en.
159
+ * @type {TEXT}
160
+ */
161
+ Language?: string | null;
162
+ /**
163
+ * Contains personal data
164
+ *
165
+ * True when the description or the document carries names, addresses or signatures.
166
+ * @type {BOOLEAN}
167
+ */
168
+ ContainsPii?: boolean | null;
169
+ /**
170
+ * Catalog status
171
+ *
172
+ * Where the document is in the catalog pipeline.
173
+ * @type {ENUM}
174
+ */
175
+ CatalogStatus?: string | null;
176
+ /**
177
+ * First seen
178
+ *
179
+ * When the catalog first saw the document.
180
+ * @type {DATE_TIME}
181
+ */
182
+ FirstSeenAt?: string | null;
183
+ /**
184
+ * Last processed
185
+ *
186
+ * When a pipeline last ran on the document.
187
+ * @type {DATE_TIME}
188
+ */
189
+ LastProcessedAt?: string | null;
190
+ /**
191
+ * Last processing id
192
+ *
193
+ * Id of the most recent DocumentProcessing row.
194
+ * @type {TEXT}
195
+ */
196
+ LastProcessingId?: string | null;
197
+ }
198
+ /**
199
+ * UpdateDocument
200
+ *
201
+ * @actionType UPDATE - Updates an existing Document record
202
+ * @module AiModule
203
+ * @entity Document
204
+ * @entityType DEFAULT (Default)
205
+ * @event k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument
206
+ * @permission schema.action.updatedocument.trigger
207
+ * @benchmark This action is tracked for performance benchmarks
208
+ */
209
+ export declare class UpdateDocumentDto extends OdinRecordUpdateDto<UpdateDocumentProperties> {
210
+ /** Used by SDK generators to identify action type */
211
+ static readonly ACTION_TYPE = "UPDATE";
212
+ static readonly ACTION_KEY = "UpdateDocument";
213
+ static readonly MODULE_NAME = "AiModule";
214
+ static readonly ENTITIES: string[];
215
+ static readonly ENTITY_TYPE = "DEFAULT";
216
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument";
217
+ static readonly PERMISSION = "schema.action.updatedocument.trigger";
218
+ /** Step metadata - entity this action targets */
219
+ static readonly STEP_ENTITY = "AiModule:Document";
220
+ static readonly STEP_SCHEMA_ID = "30392543-1504-49e4-97d8-922879d4c806";
221
+ static readonly STEP_SCHEMA_ACTION_ID = "99aeb340-1732-4223-9692-cd5da8f57246";
222
+ static readonly STEP_SCHEMA_TYPE_ID = "c1006652-b9b4-4441-9c90-1af1cca0a46d";
223
+ static readonly STEP_TYPE = "DEFAULT";
224
+ static readonly AUTO_LINK_PARENT = false;
225
+ readonly actionName: string;
226
+ readonly schemaActionId: string;
227
+ readonly entity: string;
228
+ constructor(record: OdinRecord<any> | {
229
+ id: string;
230
+ entity: string;
231
+ type?: string;
232
+ }, properties: UpdateDocumentProperties, options?: {
233
+ journeyId?: string;
234
+ stageKey?: string;
235
+ });
236
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * UpdateDocument Action DTO
4
+ *
5
+ * UpdateDocument
6
+ *
7
+ * @module AiModule
8
+ * @entity Document
9
+ * @entityType DEFAULT
10
+ * @actionKey UpdateDocument
11
+ * @event k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.UpdateDocumentDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * UpdateDocument
20
+ *
21
+ * @actionType UPDATE - Updates an existing Document record
22
+ * @module AiModule
23
+ * @entity Document
24
+ * @entityType DEFAULT (Default)
25
+ * @event k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument
26
+ * @permission schema.action.updatedocument.trigger
27
+ * @benchmark This action is tracked for performance benchmarks
28
+ */
29
+ class UpdateDocumentDto extends core_1.OdinRecordUpdateDto {
30
+ constructor(record, properties, options) {
31
+ super({
32
+ id: record.id,
33
+ entity: record.entity,
34
+ type: record.type,
35
+ properties,
36
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
37
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
38
+ });
39
+ this.actionName = 'UpdateDocument';
40
+ this.schemaActionId = '99aeb340-1732-4223-9692-cd5da8f57246';
41
+ this.entity = 'AiModule:Document';
42
+ }
43
+ }
44
+ exports.UpdateDocumentDto = UpdateDocumentDto;
45
+ /** Used by SDK generators to identify action type */
46
+ UpdateDocumentDto.ACTION_TYPE = 'UPDATE';
47
+ UpdateDocumentDto.ACTION_KEY = 'UpdateDocument';
48
+ UpdateDocumentDto.MODULE_NAME = 'AiModule';
49
+ UpdateDocumentDto.ENTITIES = ['Document'];
50
+ UpdateDocumentDto.ENTITY_TYPE = 'DEFAULT';
51
+ UpdateDocumentDto.EVENT_NAME = 'k1.t-hEOJjsDb.AiModule.Document.Update.UpdateDocument';
52
+ UpdateDocumentDto.PERMISSION = 'schema.action.updatedocument.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ UpdateDocumentDto.STEP_ENTITY = 'AiModule:Document';
55
+ UpdateDocumentDto.STEP_SCHEMA_ID = '30392543-1504-49e4-97d8-922879d4c806';
56
+ UpdateDocumentDto.STEP_SCHEMA_ACTION_ID = '99aeb340-1732-4223-9692-cd5da8f57246';
57
+ UpdateDocumentDto.STEP_SCHEMA_TYPE_ID = 'c1006652-b9b4-4441-9c90-1af1cca0a46d';
58
+ UpdateDocumentDto.STEP_TYPE = 'DEFAULT';
59
+ UpdateDocumentDto.AUTO_LINK_PARENT = false;
@@ -0,0 +1,72 @@
1
+ /**
2
+ * UpdateMessageReadByCustomer Action DTO
3
+ *
4
+ * Set whether the customer has read this message. Called by the chat gateway when the app reports which messages it has shown.
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Message
8
+ * @actionKey UpdateMessageReadByCustomer
9
+ * @event k1.t-hEOJjsDb.NotificationModule.Message.Update.UpdateMessageReadByCustomer
10
+ *
11
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
12
+ */
13
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
14
+ /**
15
+ * RabbitMQ message payload for UpdateMessageReadByCustomer updated events
16
+ *
17
+ * @event k1.t-hEOJjsDb.NotificationModule.Message.Update.UpdateMessageReadByCustomer
18
+ */
19
+ export interface UpdateMessageReadByCustomerMessage extends OdinRecordUpdatedEvent<UpdateMessageReadByCustomerDto, UpdateMessageReadByCustomerProperties> {
20
+ }
21
+ /**
22
+ * Properties for UpdateMessageReadByCustomer action
23
+ *
24
+ * @property Required fields: 0
25
+ * @property Optional fields: 1
26
+ */
27
+ export interface UpdateMessageReadByCustomerProperties {
28
+ /**
29
+ * Is Read By Customer
30
+ *
31
+ * Has the customer read this message in the app? Set to false when an agent or system message is written to an in-app chat, and to true when the app reports it read (PORTAPP-3306). Messages written before this column existed have no value, and no value counts as read — only an explicit false raises the unread badge.
32
+ * @type {BOOLEAN}
33
+ */
34
+ IsReadByCustomer?: boolean | null;
35
+ }
36
+ /**
37
+ * UpdateMessageReadByCustomer
38
+ *
39
+ * Set whether the customer has read this message. Called by the chat gateway when the app reports which messages it has shown.
40
+ *
41
+ * @actionType UPDATE - Updates an existing Message record
42
+ * @module NotificationModule
43
+ * @entity Message
44
+ * @event k1.t-hEOJjsDb.NotificationModule.Message.Update.UpdateMessageReadByCustomer
45
+ * @permission schema.action.updatemessagereadbycustomer.trigger
46
+ * @benchmark This action is tracked for performance benchmarks
47
+ */
48
+ export declare class UpdateMessageReadByCustomerDto extends OdinRecordUpdateDto<UpdateMessageReadByCustomerProperties> {
49
+ /** Used by SDK generators to identify action type */
50
+ static readonly ACTION_TYPE = "UPDATE";
51
+ static readonly ACTION_KEY = "UpdateMessageReadByCustomer";
52
+ static readonly MODULE_NAME = "NotificationModule";
53
+ static readonly ENTITIES: string[];
54
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Message.Update.UpdateMessageReadByCustomer";
55
+ static readonly PERMISSION = "schema.action.updatemessagereadbycustomer.trigger";
56
+ /** Step metadata - entity this action targets */
57
+ static readonly STEP_ENTITY = "NotificationModule:Message";
58
+ static readonly STEP_SCHEMA_ID = "f1c6db7a-eda8-405b-9d9e-536047a61b57";
59
+ static readonly STEP_SCHEMA_ACTION_ID = "e93486b9-74ef-4451-848b-ac949ed5caf9";
60
+ static readonly AUTO_LINK_PARENT = false;
61
+ readonly actionName: string;
62
+ readonly schemaActionId: string;
63
+ readonly entity: string;
64
+ constructor(record: OdinRecord<any> | {
65
+ id: string;
66
+ entity: string;
67
+ type?: string;
68
+ }, properties: UpdateMessageReadByCustomerProperties, options?: {
69
+ journeyId?: string;
70
+ stageKey?: string;
71
+ });
72
+ }