@d19n/youfibre-odin-sdk 2.0.342 → 2.0.343

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 (88) hide show
  1. package/README.md +25 -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/ContractBuyOutApi.d.ts +2 -0
  27. package/dist/api-sdk-v2/ContractBuyOutApi.js +6 -0
  28. package/dist/api-sdk-v2/DocumentApi.d.ts +52 -0
  29. package/dist/api-sdk-v2/DocumentApi.js +167 -0
  30. package/dist/api-sdk-v2/DocumentProcessingApi.d.ts +50 -0
  31. package/dist/api-sdk-v2/DocumentProcessingApi.js +161 -0
  32. package/dist/api-sdk-v2/EquipmentReturnApi.d.ts +45 -0
  33. package/dist/api-sdk-v2/EquipmentReturnApi.js +151 -0
  34. package/dist/api-sdk-v2/EquipmentReturnItemApi.d.ts +45 -0
  35. package/dist/api-sdk-v2/EquipmentReturnItemApi.js +151 -0
  36. package/dist/api-sdk-v2/FileApi.d.ts +4 -0
  37. package/dist/api-sdk-v2/FileApi.js +12 -0
  38. package/dist/db-accessors-v2/DocumentDbAccessor.d.ts +180 -0
  39. package/dist/db-accessors-v2/DocumentDbAccessor.js +265 -0
  40. package/dist/db-accessors-v2/DocumentProcessingDbAccessor.d.ts +180 -0
  41. package/dist/db-accessors-v2/DocumentProcessingDbAccessor.js +265 -0
  42. package/dist/db-accessors-v2/index.d.ts +2 -0
  43. package/dist/db-accessors-v2/index.js +7 -3
  44. package/dist/db-sdk-v2/ContractBuyOutDb.d.ts +2 -0
  45. package/dist/db-sdk-v2/ContractBuyOutDb.js +6 -0
  46. package/dist/db-sdk-v2/DocumentDb.d.ts +124 -0
  47. package/dist/db-sdk-v2/DocumentDb.js +216 -0
  48. package/dist/db-sdk-v2/DocumentProcessingDb.d.ts +122 -0
  49. package/dist/db-sdk-v2/DocumentProcessingDb.js +210 -0
  50. package/dist/db-sdk-v2/EquipmentReturnDb.d.ts +117 -0
  51. package/dist/db-sdk-v2/EquipmentReturnDb.js +200 -0
  52. package/dist/db-sdk-v2/EquipmentReturnItemDb.d.ts +117 -0
  53. package/dist/db-sdk-v2/EquipmentReturnItemDb.js +200 -0
  54. package/dist/db-sdk-v2/FileDb.d.ts +4 -0
  55. package/dist/db-sdk-v2/FileDb.js +12 -0
  56. package/dist/entities-v2/AiRouteRequest.d.ts +23 -11
  57. package/dist/entities-v2/AiRouteRequest.js +15 -3
  58. package/dist/entities-v2/ContractBuyOut.d.ts +7 -0
  59. package/dist/entities-v2/ContractBuyOut.js +5 -1
  60. package/dist/entities-v2/Document.d.ts +1145 -0
  61. package/dist/entities-v2/Document.js +220 -0
  62. package/dist/entities-v2/DocumentProcessing.d.ts +272 -0
  63. package/dist/entities-v2/DocumentProcessing.js +156 -0
  64. package/dist/entities-v2/EquipmentReturn.d.ts +66 -0
  65. package/dist/entities-v2/EquipmentReturn.js +64 -0
  66. package/dist/entities-v2/EquipmentReturnItem.d.ts +66 -0
  67. package/dist/entities-v2/EquipmentReturnItem.js +64 -0
  68. package/dist/entities-v2/File.d.ts +81 -1
  69. package/dist/entities-v2/File.js +9 -1
  70. package/dist/entities-v2/Message.d.ts +27 -1
  71. package/dist/entities-v2/Message.js +2 -0
  72. package/dist/entities-v2/Order.d.ts +8 -8
  73. package/dist/entities-v2/Order.js +2 -2
  74. package/dist/entities-v2/YfStockCount.d.ts +197 -1
  75. package/dist/entities-v2/YfStockCount.js +28 -0
  76. package/dist/records-v2/ContractBuyOutRecord.d.ts +20 -0
  77. package/dist/records-v2/ContractBuyOutRecord.js +33 -0
  78. package/dist/records-v2/DocumentProcessingRecord.d.ts +227 -0
  79. package/dist/records-v2/DocumentProcessingRecord.js +315 -0
  80. package/dist/records-v2/DocumentRecord.d.ts +355 -0
  81. package/dist/records-v2/DocumentRecord.js +468 -0
  82. package/dist/records-v2/FileRecord.d.ts +59 -3
  83. package/dist/records-v2/FileRecord.js +83 -1
  84. package/dist/records-v2/MessageRecord.d.ts +28 -0
  85. package/dist/records-v2/MessageRecord.js +37 -0
  86. package/dist/records-v2/index.d.ts +2 -0
  87. package/dist/records-v2/index.js +10 -4
  88. package/package.json +1 -1
@@ -0,0 +1,265 @@
1
+ "use strict";
2
+ /**
3
+ * DocumentProcessing DB Accessor
4
+ *
5
+ * Provides typed access to DocumentProcessing records via direct database access.
6
+ * For use in backend services with principal + dbService.
7
+ * Returns wrapped records with typed action methods.
8
+ *
9
+ * @example
10
+ * ```typescript
11
+ * // Simple get
12
+ * const record = await accessor.get(id);
13
+ *
14
+ * // With related entities
15
+ * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
16
+ *
17
+ * // With permissions bypass (separate options)
18
+ * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
19
+ *
20
+ * // Silent write (no RabbitMQ events)
21
+ * const result = await accessor.upsert([dto], { omitWriteEvents: true });
22
+ *
23
+ * // Constructor-level default (applies to all calls)
24
+ * const accessor = new DocumentProcessingDbAccessor(principal, dbService, { omitPermissionsCheck: true });
25
+ * ```
26
+ *
27
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
28
+ */
29
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
30
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
31
+ return new (P || (P = Promise))(function (resolve, reject) {
32
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
33
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
34
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
35
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
36
+ });
37
+ };
38
+ var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
39
+ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
40
+ if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
41
+ var g = generator.apply(thisArg, _arguments || []), i, q = [];
42
+ return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
43
+ function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
44
+ function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
45
+ function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
46
+ function fulfill(value) { resume("next", value); }
47
+ function reject(value) { resume("throw", value); }
48
+ function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
49
+ };
50
+ Object.defineProperty(exports, "__esModule", { value: true });
51
+ exports.DocumentProcessingDbAccessor = void 0;
52
+ const db_provider_1 = require("@d19n/odin-sdk-generator/dist/db.provider");
53
+ const query_builder_1 = require("@d19n/odin-sdk-generator/dist/query-builder");
54
+ const DocumentProcessingRecord_1 = require("../records-v2/DocumentProcessingRecord");
55
+ class DocumentProcessingDbAccessor {
56
+ /**
57
+ * Create a new DocumentProcessingDbAccessor
58
+ * @param principal - The authenticated principal
59
+ * @param dbService - The database service instance
60
+ * @param defaultOptions - Default provider options applied to all operations
61
+ */
62
+ constructor(principal, dbService, defaultOptions) {
63
+ this._moduleName = 'AiModule';
64
+ this._entityName = 'DocumentProcessing';
65
+ this._provider = new db_provider_1.DbProvider(principal, dbService, defaultOptions);
66
+ this._defaultOptions = defaultOptions;
67
+ }
68
+ get moduleName() { return this._moduleName; }
69
+ get entityName() { return this._entityName; }
70
+ // ============================================
71
+ // RECORD CREATION
72
+ // ============================================
73
+ /**
74
+ * Create a new empty DocumentProcessing record instance for create operations.
75
+ * Pre-generates an ID that can be referenced before the record is saved.
76
+ *
77
+ * @param id - Optional ID to use (auto-generated UUID if not provided)
78
+ * @returns A new record wrapper with pre-generated ID
79
+ *
80
+ * @example
81
+ * ```typescript
82
+ * // Auto-generated ID
83
+ * const note = odinDb.notes.new();
84
+ * console.log(note.id); // UUID available immediately
85
+ *
86
+ * // Custom ID
87
+ * const order = odinDb.orders.new("custom-id-123");
88
+ *
89
+ * // Reference ID before save
90
+ * const account = odinDb.accounts.new();
91
+ * const contact = odinDb.contacts.new();
92
+ * await contact
93
+ * .link({ id: account.id, entity: "CrmModule:Account" })
94
+ * .createContact({ FirstName: "John" });
95
+ * ```
96
+ */
97
+ new(id) {
98
+ return new DocumentProcessingRecord_1.DocumentProcessingRecord(null, this._provider, id);
99
+ }
100
+ // ============================================
101
+ // RECORD RETRIEVAL
102
+ // ============================================
103
+ /**
104
+ * Get a single DocumentProcessing record by ID
105
+ *
106
+ * @param id - The record ID
107
+ * @param queryOptions - Query options (WHAT to fetch: entities to include)
108
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
109
+ *
110
+ * @example
111
+ * ```typescript
112
+ * // Simple get
113
+ * const record = await accessor.get(id);
114
+ *
115
+ * // With related entities
116
+ * const record = await accessor.get(id, { entities: ["Contact", "Address"] });
117
+ *
118
+ * // With permissions bypass
119
+ * const record = await accessor.get(id, {}, { omitPermissionsCheck: true });
120
+ *
121
+ * // Both options
122
+ * const record = await accessor.get(id, { entities: ["Invoice"] }, { omitPermissionsCheck: true });
123
+ * ```
124
+ */
125
+ get(id, queryOptions, providerOptions) {
126
+ return __awaiter(this, void 0, void 0, function* () {
127
+ const record = yield this._provider._getByPrimaryKey(this._moduleName, this._entityName, id, queryOptions, providerOptions);
128
+ return new DocumentProcessingRecord_1.DocumentProcessingRecord(record, this._provider);
129
+ });
130
+ }
131
+ /**
132
+ * Get multiple DocumentProcessing records by IDs
133
+ *
134
+ * @param ids - Array of record IDs
135
+ * @param queryOptions - Query options (WHAT to fetch: entities to include)
136
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
137
+ */
138
+ getMany(ids, queryOptions, providerOptions) {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ if (ids.length === 0)
141
+ return [];
142
+ const records = yield this._provider._getManyByPrimaryKey(this._moduleName, this._entityName, ids, queryOptions, providerOptions);
143
+ return records.map((r) => new DocumentProcessingRecord_1.DocumentProcessingRecord(r, this._provider));
144
+ });
145
+ }
146
+ /**
147
+ * Get DocumentProcessing records by the RECORD-LEVEL external id.
148
+ *
149
+ * Resolved server-side in Postgres against `record.external_id` - not a property
150
+ * search, and not reachable through `query()` (`externalId` is not a queryable
151
+ * column). Use this when an external system hands back its own identifier.
152
+ *
153
+ * Platform limits: max 5000 ids per call, each at most 36 characters. An unknown
154
+ * `type` is rejected with 400 `invalid type`.
155
+ *
156
+ * @param externalIds - The external ids to match (plural - the platform takes an array)
157
+ * @param queryOptions - Query options (WHAT to fetch: narrow by record type)
158
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck, withLinks)
159
+ *
160
+ * @example
161
+ * ```typescript
162
+ * // Correlate a provider webhook back to the record it wrote
163
+ * const [message] = await accessor.getManyByExternalId([body.SmsSid]);
164
+ *
165
+ * // Narrowed by record type
166
+ * const closures = await accessor.getManyByExternalId(refs, { type: 'CLOSURE' });
167
+ *
168
+ * // Background job, no link hydration
169
+ * const records = await accessor.getManyByExternalId(refs, undefined, {
170
+ * omitPermissionsCheck: true,
171
+ * withLinks: false,
172
+ * });
173
+ * ```
174
+ */
175
+ getManyByExternalId(externalIds, queryOptions, providerOptions) {
176
+ return __awaiter(this, void 0, void 0, function* () {
177
+ if (externalIds.length === 0)
178
+ return [];
179
+ const records = yield this._provider._getManyByExternalId(this._moduleName, this._entityName, externalIds, queryOptions, providerOptions);
180
+ return records.map((r) => new DocumentProcessingRecord_1.DocumentProcessingRecord(r, this._provider));
181
+ });
182
+ }
183
+ // ============================================
184
+ // SEARCH OPERATIONS
185
+ // ============================================
186
+ /**
187
+ * Search DocumentProcessing records
188
+ *
189
+ * @param params - Search parameters
190
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
191
+ */
192
+ search(params, providerOptions) {
193
+ return __awaiter(this, void 0, void 0, function* () {
194
+ const result = yield this._provider._searchRecords(this._moduleName, this._entityName, params, providerOptions);
195
+ return {
196
+ records: result.records.map((r) => new DocumentProcessingRecord_1.DocumentProcessingRecord(r, this._provider)),
197
+ totalRecords: result.totalRecords,
198
+ hasMore: result.hasMore,
199
+ aggregations: result.aggregations,
200
+ };
201
+ });
202
+ }
203
+ /**
204
+ * Search all DocumentProcessing records with automatic pagination
205
+ *
206
+ * @param params - Search parameters
207
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
208
+ */
209
+ searchAll(params, providerOptions) {
210
+ return __awaiter(this, void 0, void 0, function* () {
211
+ const result = yield this._provider._searchAllRecordsAndPaginate(this._moduleName, this._entityName, params, 0, providerOptions);
212
+ return result.records.map((r) => new DocumentProcessingRecord_1.DocumentProcessingRecord(r, this._provider));
213
+ });
214
+ }
215
+ /**
216
+ * Async generator for paginating through all matching records.
217
+ * Yields batches of wrapped records.
218
+ *
219
+ * @param params - Search parameters
220
+ * @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
221
+ */
222
+ paginate(params, providerOptions) {
223
+ var _a;
224
+ return __asyncGenerator(this, arguments, function* paginate_1() {
225
+ let hasMore = true;
226
+ let searchAfter;
227
+ const query = Object.assign(Object.assign({}, params.query), { pageSize: ((_a = params.query) === null || _a === void 0 ? void 0 : _a.pageSize) || 500 });
228
+ while (hasMore) {
229
+ const result = yield __await(this._provider._searchRecords(this._moduleName, this._entityName, Object.assign(Object.assign({}, params), { query: Object.assign(Object.assign({}, query), { searchAfter }) }), providerOptions));
230
+ if (result.records.length > 0) {
231
+ yield yield __await(result.records.map((r) => new DocumentProcessingRecord_1.DocumentProcessingRecord(r, this._provider)));
232
+ const lastRecord = result.records[result.records.length - 1];
233
+ searchAfter = lastRecord === null || lastRecord === void 0 ? void 0 : lastRecord.sort;
234
+ }
235
+ hasMore = result.hasMore && result.records.length >= query.pageSize;
236
+ }
237
+ });
238
+ }
239
+ // ============================================
240
+ // QUERY BUILDER
241
+ // ============================================
242
+ /**
243
+ * Create a fluent query builder for DocumentProcessing records
244
+ *
245
+ * @example
246
+ * ```typescript
247
+ * const results = await accessor
248
+ * .query()
249
+ * .where('Status', 'in', ['Active', 'Pending'])
250
+ * .where('CreatedAt', 'gte', '2025-01-01')
251
+ * .select('id', 'title', 'properties.*')
252
+ * .sortBy('createdAt', 'desc')
253
+ * .limit(100)
254
+ * .execute();
255
+ * ```
256
+ */
257
+ query() {
258
+ return (0, query_builder_1.createQueryBuilder)(this);
259
+ }
260
+ /** Access the underlying DbProvider */
261
+ get provider() {
262
+ return this._provider;
263
+ }
264
+ }
265
+ exports.DocumentProcessingDbAccessor = DocumentProcessingDbAccessor;
@@ -43,6 +43,8 @@ export { CustomerDeviceRouterDbAccessor, CustomerDeviceRouterDbSearchResponse }
43
43
  export { CustomerPhonePortingDbAccessor, CustomerPhonePortingDbSearchResponse } from './CustomerPhonePortingDbAccessor';
44
44
  export { DataIssueDbAccessor, DataIssueDbSearchResponse } from './DataIssueDbAccessor';
45
45
  export { DiscountDbAccessor, DiscountDbSearchResponse } from './DiscountDbAccessor';
46
+ export { DocumentProcessingDbAccessor, DocumentProcessingDbSearchResponse } from './DocumentProcessingDbAccessor';
47
+ export { DocumentDbAccessor, DocumentDbSearchResponse } from './DocumentDbAccessor';
46
48
  export { EmailDbAccessor, EmailDbSearchResponse } from './EmailDbAccessor';
47
49
  export { EmailSenderDbAccessor, EmailSenderDbSearchResponse } from './EmailSenderDbAccessor';
48
50
  export { EmailTemplateDbAccessor, EmailTemplateDbSearchResponse } from './EmailTemplateDbAccessor';
@@ -9,9 +9,9 @@
9
9
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
10
10
  */
11
11
  Object.defineProperty(exports, "__esModule", { value: true });
12
- exports.ModifyServiceRequestDbAccessor = exports.MessageDbAccessor = exports.LeadDbAccessor = exports.KnowledgeArticleDbAccessor = exports.InvoiceDbAccessor = exports.InvoiceItemDbAccessor = exports.ImpersonationTrackerDbAccessor = exports.FileDbAccessor = exports.FieldServiceProductDbAccessor = exports.FieldServiceDispatchedProductDbAccessor = exports.ExchangeDbAccessor = exports.EmailTemplateDbAccessor = exports.EmailSenderDbAccessor = exports.EmailDbAccessor = exports.DiscountDbAccessor = exports.DataIssueDbAccessor = exports.CustomerPhonePortingDbAccessor = exports.CustomerDeviceRouterDbAccessor = exports.CustomerDeviceDbAccessor = exports.CustomerDeviceOntDbAccessor = exports.CustomerDeviceConfigurationDbAccessor = exports.CustomerDeviceAtaDbAccessor = exports.CrmDatasetDbAccessor = exports.CreditNoteDbAccessor = exports.ConversationSummaryFeedbackDbAccessor = exports.ConversationDbAccessor = exports.ContractBuyOutDbAccessor = exports.ContactDbAccessor = exports.ContactIdentityDbAccessor = exports.ConfigDbAccessor = exports.ChurnRequestDbAccessor = exports.ChangeReasonDbAccessor = exports.CaseDbAccessor = exports.CampaignDbAccessor = exports.CallDbAccessor = exports.CallLegDbAccessor = exports.BrskEntityMigrationErrorDbAccessor = exports.BngProvisionDbAccessor = exports.BillingRequestDbAccessor = exports.BillingAdjustmentDbAccessor = exports.AppointmentDbAccessor = exports.AiRouteRequestDbAccessor = exports.AgentStatusDbAccessor = exports.AffiliateCodeDbAccessor = exports.AddressDbAccessor = exports.AddressInteractionDbAccessor = exports.ActivityDbAccessor = exports.ActivityLogDbAccessor = exports.AccountDbAccessor = exports.AccountCreditDbAccessor = void 0;
13
- exports.RewardDbAccessor = exports.ReturnsDbAccessor = exports.RemediationRequiredReasonDbAccessor = exports.RemediationOutcomeFormDbAccessor = exports.RegionDbAccessor = exports.ReferralDbAccessor = exports.RecontractDbAccessor = exports.QaRubricSectionDbAccessor = exports.QaRubricDbAccessor = exports.QaRubricItemDbAccessor = exports.QaReportDbAccessor = exports.QaAutoFailDbAccessor = exports.PushNotificationDbAccessor = exports.ProductDbAccessor = exports.PriceBookDbAccessor = exports.PgWebhookDbAccessor = exports.PgWebhookAttemptDbAccessor = exports.PgVocalinkDbAccessor = exports.PgTransactionDbAccessor = exports.PgSortCodeSubstitutionDbAccessor = exports.PgReportEventDbAccessor = exports.PgPaymentMethodDbAccessor = exports.PgLogDbAccessor = exports.PgFileAllocationDbAccessor = exports.PgDisputeDbAccessor = exports.PgDirectDebitFileDbAccessor = exports.PgContactDbAccessor = exports.PgAccountValidationDbAccessor = exports.PermissionToFailDbAccessor = exports.PaymentDbAccessor = exports.PaymentMethodRefundDbAccessor = exports.PaymentMethodDbAccessor = exports.PICRequestDbAccessor = exports.OverlayRealA55DbAccessor = exports.OutboundDialSessionDbAccessor = exports.OutboundDialCampaignDbAccessor = exports.OutboundDialCampaignCaseDbAccessor = exports.OutageDbAccessor = exports.OrderDbAccessor = exports.OrderKciDbAccessor = exports.OrderItemDbAccessor = exports.OrderCheckDbAccessor = exports.OntReplacementApprovalDbAccessor = exports.OneTouchSwitchDbAccessor = exports.OhExternalAuditDbAccessor = exports.OfferTemplateDbAccessor = exports.OfferDbAccessor = exports.NotificationTemplateDbAccessor = exports.NoteDbAccessor = exports.NetworkDeviceDbAccessor = void 0;
14
- exports.YfWifiSurveyDbAccessor = exports.YfFieldVisitOutcomeFormDbAccessor = exports.YfAgentLocationDbAccessor = exports.WorkOrderStatusUpdateDbAccessor = exports.WorkOrderDbAccessor = exports.WayleaveAuditDbAccessor = exports.VoiceConfigurationDbAccessor = exports.VisitDbAccessor = exports.UserDbAccessor = exports.UgExternalAuditDbAccessor = exports.TwilioWorkerDbAccessor = exports.TwilioUserUpdateDbAccessor = exports.TwilioTaskQueueDbAccessor = exports.TwilioCallEventDbAccessor = exports.TwilioActivityDbAccessor = exports.TransactionDbAccessor = exports.TimeSlotDbAccessor = exports.TeamDbAccessor = exports.SmsTemplateDbAccessor = exports.SmsMessageDbAccessor = exports.SiteSpecificRiskAssessmentOutcomeFormDbAccessor = exports.ServiceDbAccessor = exports.ServiceAppointmentDbAccessor = exports.ServiceAppointmentConfigDbAccessor = exports.ScheduleSlotDbAccessor = exports.SalesTerritoryDbAccessor = void 0;
12
+ exports.LeadDbAccessor = exports.KnowledgeArticleDbAccessor = exports.InvoiceDbAccessor = exports.InvoiceItemDbAccessor = exports.ImpersonationTrackerDbAccessor = exports.FileDbAccessor = exports.FieldServiceProductDbAccessor = exports.FieldServiceDispatchedProductDbAccessor = exports.ExchangeDbAccessor = exports.EmailTemplateDbAccessor = exports.EmailSenderDbAccessor = exports.EmailDbAccessor = exports.DocumentDbAccessor = exports.DocumentProcessingDbAccessor = exports.DiscountDbAccessor = exports.DataIssueDbAccessor = exports.CustomerPhonePortingDbAccessor = exports.CustomerDeviceRouterDbAccessor = exports.CustomerDeviceDbAccessor = exports.CustomerDeviceOntDbAccessor = exports.CustomerDeviceConfigurationDbAccessor = exports.CustomerDeviceAtaDbAccessor = exports.CrmDatasetDbAccessor = exports.CreditNoteDbAccessor = exports.ConversationSummaryFeedbackDbAccessor = exports.ConversationDbAccessor = exports.ContractBuyOutDbAccessor = exports.ContactDbAccessor = exports.ContactIdentityDbAccessor = exports.ConfigDbAccessor = exports.ChurnRequestDbAccessor = exports.ChangeReasonDbAccessor = exports.CaseDbAccessor = exports.CampaignDbAccessor = exports.CallDbAccessor = exports.CallLegDbAccessor = exports.BrskEntityMigrationErrorDbAccessor = exports.BngProvisionDbAccessor = exports.BillingRequestDbAccessor = exports.BillingAdjustmentDbAccessor = exports.AppointmentDbAccessor = exports.AiRouteRequestDbAccessor = exports.AgentStatusDbAccessor = exports.AffiliateCodeDbAccessor = exports.AddressDbAccessor = exports.AddressInteractionDbAccessor = exports.ActivityDbAccessor = exports.ActivityLogDbAccessor = exports.AccountDbAccessor = exports.AccountCreditDbAccessor = void 0;
13
+ exports.RemediationRequiredReasonDbAccessor = exports.RemediationOutcomeFormDbAccessor = exports.RegionDbAccessor = exports.ReferralDbAccessor = exports.RecontractDbAccessor = exports.QaRubricSectionDbAccessor = exports.QaRubricDbAccessor = exports.QaRubricItemDbAccessor = exports.QaReportDbAccessor = exports.QaAutoFailDbAccessor = exports.PushNotificationDbAccessor = exports.ProductDbAccessor = exports.PriceBookDbAccessor = exports.PgWebhookDbAccessor = exports.PgWebhookAttemptDbAccessor = exports.PgVocalinkDbAccessor = exports.PgTransactionDbAccessor = exports.PgSortCodeSubstitutionDbAccessor = exports.PgReportEventDbAccessor = exports.PgPaymentMethodDbAccessor = exports.PgLogDbAccessor = exports.PgFileAllocationDbAccessor = exports.PgDisputeDbAccessor = exports.PgDirectDebitFileDbAccessor = exports.PgContactDbAccessor = exports.PgAccountValidationDbAccessor = exports.PermissionToFailDbAccessor = exports.PaymentDbAccessor = exports.PaymentMethodRefundDbAccessor = exports.PaymentMethodDbAccessor = exports.PICRequestDbAccessor = exports.OverlayRealA55DbAccessor = exports.OutboundDialSessionDbAccessor = exports.OutboundDialCampaignDbAccessor = exports.OutboundDialCampaignCaseDbAccessor = exports.OutageDbAccessor = exports.OrderDbAccessor = exports.OrderKciDbAccessor = exports.OrderItemDbAccessor = exports.OrderCheckDbAccessor = exports.OntReplacementApprovalDbAccessor = exports.OneTouchSwitchDbAccessor = exports.OhExternalAuditDbAccessor = exports.OfferTemplateDbAccessor = exports.OfferDbAccessor = exports.NotificationTemplateDbAccessor = exports.NoteDbAccessor = exports.NetworkDeviceDbAccessor = exports.ModifyServiceRequestDbAccessor = exports.MessageDbAccessor = void 0;
14
+ exports.YfWifiSurveyDbAccessor = exports.YfFieldVisitOutcomeFormDbAccessor = exports.YfAgentLocationDbAccessor = exports.WorkOrderStatusUpdateDbAccessor = exports.WorkOrderDbAccessor = exports.WayleaveAuditDbAccessor = exports.VoiceConfigurationDbAccessor = exports.VisitDbAccessor = exports.UserDbAccessor = exports.UgExternalAuditDbAccessor = exports.TwilioWorkerDbAccessor = exports.TwilioUserUpdateDbAccessor = exports.TwilioTaskQueueDbAccessor = exports.TwilioCallEventDbAccessor = exports.TwilioActivityDbAccessor = exports.TransactionDbAccessor = exports.TimeSlotDbAccessor = exports.TeamDbAccessor = exports.SmsTemplateDbAccessor = exports.SmsMessageDbAccessor = exports.SiteSpecificRiskAssessmentOutcomeFormDbAccessor = exports.ServiceDbAccessor = exports.ServiceAppointmentDbAccessor = exports.ServiceAppointmentConfigDbAccessor = exports.ScheduleSlotDbAccessor = exports.SalesTerritoryDbAccessor = exports.RewardDbAccessor = exports.ReturnsDbAccessor = void 0;
15
15
  var AccountCreditDbAccessor_1 = require("./AccountCreditDbAccessor");
16
16
  Object.defineProperty(exports, "AccountCreditDbAccessor", { enumerable: true, get: function () { return AccountCreditDbAccessor_1.AccountCreditDbAccessor; } });
17
17
  var AccountDbAccessor_1 = require("./AccountDbAccessor");
@@ -84,6 +84,10 @@ var DataIssueDbAccessor_1 = require("./DataIssueDbAccessor");
84
84
  Object.defineProperty(exports, "DataIssueDbAccessor", { enumerable: true, get: function () { return DataIssueDbAccessor_1.DataIssueDbAccessor; } });
85
85
  var DiscountDbAccessor_1 = require("./DiscountDbAccessor");
86
86
  Object.defineProperty(exports, "DiscountDbAccessor", { enumerable: true, get: function () { return DiscountDbAccessor_1.DiscountDbAccessor; } });
87
+ var DocumentProcessingDbAccessor_1 = require("./DocumentProcessingDbAccessor");
88
+ Object.defineProperty(exports, "DocumentProcessingDbAccessor", { enumerable: true, get: function () { return DocumentProcessingDbAccessor_1.DocumentProcessingDbAccessor; } });
89
+ var DocumentDbAccessor_1 = require("./DocumentDbAccessor");
90
+ Object.defineProperty(exports, "DocumentDbAccessor", { enumerable: true, get: function () { return DocumentDbAccessor_1.DocumentDbAccessor; } });
87
91
  var EmailDbAccessor_1 = require("./EmailDbAccessor");
88
92
  Object.defineProperty(exports, "EmailDbAccessor", { enumerable: true, get: function () { return EmailDbAccessor_1.EmailDbAccessor; } });
89
93
  var EmailSenderDbAccessor_1 = require("./EmailSenderDbAccessor");
@@ -29,6 +29,7 @@ export declare class ContractBuyOutDb extends DbProvider {
29
29
  private _user?;
30
30
  private _paymentmethodrefund?;
31
31
  private _contact?;
32
+ private _document?;
32
33
  constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
33
34
  get note(): DbRecordLinkManager;
34
35
  get paymentmethod(): DbRecordLinkManager;
@@ -38,6 +39,7 @@ export declare class ContractBuyOutDb extends DbProvider {
38
39
  get user(): DbRecordLinkManager;
39
40
  get paymentmethodrefund(): DbRecordLinkManager;
40
41
  get contact(): DbRecordLinkManager;
42
+ get document(): DbRecordLinkManager;
41
43
  setRecord(sourceRecord: any): void;
42
44
  /**
43
45
  * Search records with manual pagination control
@@ -86,6 +86,12 @@ class ContractBuyOutDb extends db_provider_1.DbProvider {
86
86
  }
87
87
  return this._contact;
88
88
  }
89
+ get document() {
90
+ if (!this._document) {
91
+ this._document = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'OrderModule:ContractBuyOut', 'AiModule:Document', 'ContractBuyOut__Document');
92
+ }
93
+ return this._document;
94
+ }
89
95
  // ============================================
90
96
  // STANDARD METHODS
91
97
  // ============================================
@@ -0,0 +1,124 @@
1
+ import { DbProvider, DbProviderOptions, DbGetQueryOptions } from '@d19n/odin-sdk-generator/dist/db.provider';
2
+ import { OdinSearchV2, OdinRecordCreateDto, OdinRecordUpdateDto } from '@d19n/odin-types/dist/core';
3
+ import { DbRecordLinkManager } from '@d19n/odin-sdk-generator/dist/db.record.link.manager';
4
+ import { DocumentProperties } from '../entities-v2/Document';
5
+ /**
6
+ * @deprecated Use OdinDbClient.
7
+ *
8
+ * Migration:
9
+ * - Old: new DocumentApi(authParams).get(id)
10
+ * - New: new odin.document.get(id)
11
+ *
12
+ * The new OdinDbClient returns typed record wrappers with action methods.
13
+ *
14
+ * Supports separate query options and provider options:
15
+ * - Constructor level: new DocumentDb(principal, dbService, { omitPermissionsCheck: true })
16
+ * - Method level: await db.getByPrimaryKey(id, { entities: [] }, { omitPermissionsCheck: true })
17
+ */
18
+ export declare class DocumentDb extends DbProvider {
19
+ protected readonly principal: any;
20
+ protected readonly dbService: any;
21
+ private readonly moduleName;
22
+ private readonly entityName;
23
+ private sourceRecord;
24
+ private _file?;
25
+ private _documentprocessing?;
26
+ private _contractbuyout?;
27
+ constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
28
+ get file(): DbRecordLinkManager;
29
+ get documentprocessing(): DbRecordLinkManager;
30
+ get contractbuyout(): DbRecordLinkManager;
31
+ setRecord(sourceRecord: any): void;
32
+ /**
33
+ * Search records with manual pagination control
34
+ * @param params - Search parameters
35
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
36
+ */
37
+ searchRecords(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<DocumentProperties>>>;
38
+ /**
39
+ * Search all records with automatic pagination
40
+ * @param params - Search parameters
41
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
42
+ */
43
+ searchAllRecordsAndPaginate(params: Partial<OdinSearchV2>, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core/interfaces/v2.db.interfaces").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<DocumentProperties>>>;
44
+ /**
45
+ * Get a single record by primary key
46
+ * @param documentId - Record ID
47
+ * @param queryOptions - Query options (WHAT: entities to include)
48
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
49
+ *
50
+ * @example
51
+ * // Simple get
52
+ * const record = await db.getByPrimaryKey(id);
53
+ *
54
+ * // With related entities
55
+ * const record = await db.getByPrimaryKey(id, { entities: ['InvoiceItem', 'Transaction'] });
56
+ *
57
+ * // With permissions bypass
58
+ * const record = await db.getByPrimaryKey(id, {}, { omitPermissionsCheck: true });
59
+ *
60
+ * // Both options
61
+ * const record = await db.getByPrimaryKey(id, { entities: ['Invoice'] }, { omitPermissionsCheck: true });
62
+ */
63
+ getByPrimaryKey(documentId: string, queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<DocumentProperties>>;
64
+ /**
65
+ * Get multiple records by primary keys
66
+ * @param documentIds - Array of record IDs
67
+ * @param queryOptions - Query options (WHAT: entities to include)
68
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
69
+ */
70
+ getManyByPrimaryKey(documentIds: string[], queryOptions?: DbGetQueryOptions, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").OdinRecord<DocumentProperties>[]>;
71
+ /**
72
+ * Upsert a single record
73
+ * @param upsertDto - Record to upsert
74
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
75
+ */
76
+ upsert(upsertDto: OdinRecordCreateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
77
+ /**
78
+ * Upsert multiple records
79
+ * @param upsertDtos - Records to upsert
80
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
81
+ */
82
+ upsertMany(upsertDtos: OdinRecordCreateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
83
+ /**
84
+ * Update a single record
85
+ * @param updateDto - Record to update
86
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
87
+ */
88
+ update(updateDto: OdinRecordUpdateDto, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes>;
89
+ /**
90
+ * Update multiple records
91
+ * @param updateDtos - Records to update
92
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
93
+ */
94
+ updateMany(updateDtos: OdinRecordUpdateDto[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
95
+ /**
96
+ * Delete one or many records
97
+ * @param documentIds - Record IDs to delete
98
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
99
+ */
100
+ delete(documentIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordDeleted[]>;
101
+ /**
102
+ * Restore one or many deleted records
103
+ * @param documentIds - Record IDs to restore
104
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
105
+ */
106
+ restore(documentIds: string[], providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-sdk-generator").DbRecordRestored[]>;
107
+ /**
108
+ * Apply an action to a record
109
+ * @param actionName - The action key
110
+ * @param dto - The action DTO
111
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
112
+ */
113
+ applyAction(actionName: string, dto: any, providerOptions?: DbProviderOptions): Promise<import("@d19n/odin-types/dist/core").IDbRecordCreateUpdateRes[]>;
114
+ /**
115
+ * Get version history for the current source record
116
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
117
+ */
118
+ getVersions(providerOptions?: DbProviderOptions): Promise<any>;
119
+ /**
120
+ * Get revision timeline for the current source record
121
+ * @param providerOptions - Provider options (HOW: omitPermissionsCheck)
122
+ */
123
+ getRevisionTimeline(providerOptions?: DbProviderOptions): Promise<any>;
124
+ }