@d19n/youfibre-odin-sdk 2.0.366 → 2.0.367
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.
- package/README.md +6 -26
- package/dist/EntityRegistry.d.ts +0 -8
- package/dist/EntityRegistry.js +0 -8
- package/dist/OdinApiClient.d.ts +0 -16
- package/dist/OdinApiClient.js +0 -32
- package/dist/OdinDbClient.d.ts +0 -16
- package/dist/OdinDbClient.js +0 -32
- package/dist/accessors-v2/index.d.ts +0 -4
- package/dist/accessors-v2/index.js +2 -10
- package/dist/actions-v2/CancelOrderForEtfPaidDto.d.ts +67 -0
- package/dist/actions-v2/CancelOrderForEtfPaidDto.js +59 -0
- package/dist/actions-v2/CreateOutboundDialCampaignDto.d.ts +8 -1
- package/dist/actions-v2/CreateOutboundDialSessionDto.d.ts +15 -1
- package/dist/actions-v2/UpdateOutboundDialSessionDto.d.ts +15 -1
- package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
- package/dist/api-sdk-v2/QaReportAmendmentApi.d.ts +48 -0
- package/dist/api-sdk-v2/QaReportAmendmentApi.js +155 -0
- package/dist/api-sdk-v2/QaReportApi.d.ts +2 -0
- package/dist/api-sdk-v2/QaReportApi.js +6 -0
- package/dist/db-accessors-v2/index.d.ts +0 -4
- package/dist/db-accessors-v2/index.js +2 -10
- package/dist/db-sdk-v2/CrmDatasetDb.d.ts +2 -2
- package/dist/db-sdk-v2/CrmDatasetDb.js +4 -4
- package/dist/db-sdk-v2/QaReportAmendmentDb.d.ts +120 -0
- package/dist/db-sdk-v2/QaReportAmendmentDb.js +204 -0
- package/dist/db-sdk-v2/QaReportDb.d.ts +2 -0
- package/dist/db-sdk-v2/QaReportDb.js +6 -0
- package/dist/entities-v2/HomeMove.d.ts +23 -1
- package/dist/entities-v2/HomeMove.js +17 -1
- package/dist/entities-v2/OrderItem.d.ts +2 -0
- package/dist/entities-v2/OrderItem.js +2 -0
- package/dist/entities-v2/OutboundDialCampaign.d.ts +9 -1
- package/dist/entities-v2/OutboundDialCampaign.js +2 -0
- package/dist/entities-v2/OutboundDialSession.d.ts +17 -1
- package/dist/entities-v2/OutboundDialSession.js +4 -0
- package/dist/entities-v2/QaReport.d.ts +70 -1
- package/dist/entities-v2/QaReport.js +31 -1
- package/dist/entities-v2/QaReportAmendment.d.ts +209 -0
- package/dist/entities-v2/QaReportAmendment.js +120 -0
- package/dist/records-v2/OrderRecord.d.ts +25 -0
- package/dist/records-v2/OrderRecord.js +29 -0
- package/dist/records-v2/index.d.ts +0 -4
- package/dist/records-v2/index.js +2 -14
- package/package.json +1 -1
- package/dist/accessors-v2/QaAutoFailAccessor.d.ts +0 -112
- package/dist/accessors-v2/QaAutoFailAccessor.js +0 -191
- package/dist/accessors-v2/QaRubricAccessor.d.ts +0 -112
- package/dist/accessors-v2/QaRubricAccessor.js +0 -191
- package/dist/accessors-v2/QaRubricItemAccessor.d.ts +0 -112
- package/dist/accessors-v2/QaRubricItemAccessor.js +0 -191
- package/dist/accessors-v2/QaRubricSectionAccessor.d.ts +0 -112
- package/dist/accessors-v2/QaRubricSectionAccessor.js +0 -191
- package/dist/actions-v2/UpdateQaAutoFailDto.d.ts +0 -102
- package/dist/actions-v2/UpdateQaAutoFailDto.js +0 -56
- package/dist/actions-v2/UpdateQaRubricDto.d.ts +0 -103
- package/dist/actions-v2/UpdateQaRubricDto.js +0 -56
- package/dist/actions-v2/UpdateQaRubricItemDto.d.ts +0 -157
- package/dist/actions-v2/UpdateQaRubricItemDto.js +0 -56
- package/dist/actions-v2/UpdateQaRubricSectionDto.d.ts +0 -87
- package/dist/actions-v2/UpdateQaRubricSectionDto.js +0 -56
- package/dist/db-accessors-v2/QaAutoFailDbAccessor.d.ts +0 -180
- package/dist/db-accessors-v2/QaAutoFailDbAccessor.js +0 -265
- package/dist/db-accessors-v2/QaRubricDbAccessor.d.ts +0 -180
- package/dist/db-accessors-v2/QaRubricDbAccessor.js +0 -265
- package/dist/db-accessors-v2/QaRubricItemDbAccessor.d.ts +0 -180
- package/dist/db-accessors-v2/QaRubricItemDbAccessor.js +0 -265
- package/dist/db-accessors-v2/QaRubricSectionDbAccessor.d.ts +0 -180
- package/dist/db-accessors-v2/QaRubricSectionDbAccessor.js +0 -265
- package/dist/records-v2/QaAutoFailRecord.d.ts +0 -205
- package/dist/records-v2/QaAutoFailRecord.js +0 -275
- package/dist/records-v2/QaRubricItemRecord.d.ts +0 -205
- package/dist/records-v2/QaRubricItemRecord.js +0 -275
- package/dist/records-v2/QaRubricRecord.d.ts +0 -225
- package/dist/records-v2/QaRubricRecord.js +0 -308
- package/dist/records-v2/QaRubricSectionRecord.d.ts +0 -225
- package/dist/records-v2/QaRubricSectionRecord.js +0 -308
|
@@ -1,275 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
/**
|
|
3
|
-
* QaAutoFail Record Wrapper
|
|
4
|
-
*
|
|
5
|
-
* Provides typed action methods and link management.
|
|
6
|
-
* Works with both ApiProvider and DbProvider.
|
|
7
|
-
*
|
|
8
|
-
* All action methods return an ActionBuilder or FlowBuilder.
|
|
9
|
-
* Call .execute() to run or .dryRun() to get the payload for debugging.
|
|
10
|
-
*
|
|
11
|
-
* Can be instantiated with null record for create operations:
|
|
12
|
-
* ```typescript
|
|
13
|
-
* const record = odinClient.qaAutoFails.new();
|
|
14
|
-
* await record.createQaAutoFail({ ... }).execute();
|
|
15
|
-
* ```
|
|
16
|
-
*
|
|
17
|
-
* Entity Types: DEFAULT
|
|
18
|
-
*
|
|
19
|
-
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
20
|
-
*/
|
|
21
|
-
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
22
|
-
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
23
|
-
return new (P || (P = Promise))(function (resolve, reject) {
|
|
24
|
-
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
25
|
-
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
26
|
-
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
27
|
-
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
28
|
-
});
|
|
29
|
-
};
|
|
30
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
31
|
-
exports.isQaAutoFailRecord = exports.QaAutoFailRecord = void 0;
|
|
32
|
-
const uuid_1 = require("uuid");
|
|
33
|
-
const core_1 = require("@d19n/odin-types/dist/core");
|
|
34
|
-
const record_link_manager_1 = require("@d19n/odin-sdk-generator/dist/record-link-manager");
|
|
35
|
-
const QaRubricRecord_1 = require("./QaRubricRecord");
|
|
36
|
-
/**
|
|
37
|
-
* Builder for action execution with dryRun support
|
|
38
|
-
*
|
|
39
|
-
* Provides a consistent API across all action types:
|
|
40
|
-
* - `.execute()` - Execute the action and return results
|
|
41
|
-
* - `.dryRun()` - Return the payload without executing (for debugging)
|
|
42
|
-
*/
|
|
43
|
-
class ActionBuilder {
|
|
44
|
-
constructor(provider, moduleName, entityName, payload, clearPendingLinks) {
|
|
45
|
-
this._provider = provider;
|
|
46
|
-
this._moduleName = moduleName;
|
|
47
|
-
this._entityName = entityName;
|
|
48
|
-
this._payload = payload;
|
|
49
|
-
this._clearPendingLinks = clearPendingLinks;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* Set an external system identifier for this record.
|
|
53
|
-
* Links the record to a corresponding entry in an external application.
|
|
54
|
-
*
|
|
55
|
-
* @param externalId - The ID in the external system
|
|
56
|
-
* @param externalAppId - The external application identifier
|
|
57
|
-
* @returns this (for chaining)
|
|
58
|
-
*
|
|
59
|
-
* @example
|
|
60
|
-
* ```typescript
|
|
61
|
-
* await record.createOrder({ ... }).withExternalId('SF-123', 'salesforce').execute();
|
|
62
|
-
* ```
|
|
63
|
-
*/
|
|
64
|
-
withExternalId(externalId, externalAppId) {
|
|
65
|
-
this._payload.externalId = externalId;
|
|
66
|
-
this._payload.externalAppId = externalAppId;
|
|
67
|
-
return this;
|
|
68
|
-
}
|
|
69
|
-
/**
|
|
70
|
-
* Set security/access groups for this record.
|
|
71
|
-
* Controls which user groups can access the record.
|
|
72
|
-
*
|
|
73
|
-
* @param groups - Array of group names
|
|
74
|
-
* @returns this (for chaining)
|
|
75
|
-
*
|
|
76
|
-
* @example
|
|
77
|
-
* ```typescript
|
|
78
|
-
* await record.createOrder({ ... }).withGroups(['TenantA', 'BillingTeam']).execute();
|
|
79
|
-
* ```
|
|
80
|
-
*/
|
|
81
|
-
withGroups(groups) {
|
|
82
|
-
this._payload.groups = groups;
|
|
83
|
-
return this;
|
|
84
|
-
}
|
|
85
|
-
/**
|
|
86
|
-
* Execute the action
|
|
87
|
-
* @returns The result from the API
|
|
88
|
-
*/
|
|
89
|
-
execute() {
|
|
90
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
91
|
-
const result = yield this._provider._applyAction(this._moduleName, this._entityName, this._payload);
|
|
92
|
-
this._clearPendingLinks();
|
|
93
|
-
return result;
|
|
94
|
-
});
|
|
95
|
-
}
|
|
96
|
-
/**
|
|
97
|
-
* Returns the request payload without executing (for debugging)
|
|
98
|
-
* @returns The request payload that would be sent to the API
|
|
99
|
-
*/
|
|
100
|
-
dryRun() {
|
|
101
|
-
return this._payload;
|
|
102
|
-
}
|
|
103
|
-
/**
|
|
104
|
-
* Prevents accidental `await actionBuilder` without .execute()
|
|
105
|
-
* Forces developers to explicitly call .execute()
|
|
106
|
-
* @throws Error always - use .execute() or .dryRun() instead
|
|
107
|
-
*/
|
|
108
|
-
then() {
|
|
109
|
-
throw new Error('ActionBuilder cannot be awaited directly. Call .execute() to run the action or .dryRun() to get the payload.');
|
|
110
|
-
}
|
|
111
|
-
}
|
|
112
|
-
class QaAutoFailRecord {
|
|
113
|
-
/**
|
|
114
|
-
* Create a record wrapper.
|
|
115
|
-
* @param record - The underlying record, or null for create operations
|
|
116
|
-
* @param provider - The API or DB provider
|
|
117
|
-
* @param preGeneratedId - Optional pre-generated ID for new records (auto-generated if not provided)
|
|
118
|
-
*/
|
|
119
|
-
constructor(record, provider, preGeneratedId) {
|
|
120
|
-
this._pendingLinks = [];
|
|
121
|
-
this._record = record;
|
|
122
|
-
this._provider = provider;
|
|
123
|
-
this._preGeneratedId = preGeneratedId !== null && preGeneratedId !== void 0 ? preGeneratedId : (0, uuid_1.v4)();
|
|
124
|
-
}
|
|
125
|
-
// ============================================
|
|
126
|
-
// CORE PROPERTIES
|
|
127
|
-
// ============================================
|
|
128
|
-
/** Returns true if this is a new (unsaved) record */
|
|
129
|
-
get isNew() { var _a; return !((_a = this._record) === null || _a === void 0 ? void 0 : _a.id); }
|
|
130
|
-
/** Record ID - always available (pre-generated for new records) */
|
|
131
|
-
get id() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.id) !== null && _b !== void 0 ? _b : this._preGeneratedId; }
|
|
132
|
-
get entity() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.entity) !== null && _b !== void 0 ? _b : 'SupportModule:QaAutoFail'; }
|
|
133
|
-
get type() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.type; }
|
|
134
|
-
/** Record properties - empty object for new (unsaved) records */
|
|
135
|
-
get properties() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.properties) || {}; }
|
|
136
|
-
get title() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.title; }
|
|
137
|
-
get recordNumber() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.recordNumber; }
|
|
138
|
-
get stage() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.stage; }
|
|
139
|
-
get createdAt() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.createdAt; }
|
|
140
|
-
get updatedAt() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.updatedAt; }
|
|
141
|
-
get externalId() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.externalId; }
|
|
142
|
-
get externalAppId() { var _a; return (_a = this._record) === null || _a === void 0 ? void 0 : _a.externalAppId; }
|
|
143
|
-
get groups() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.groups) || []; }
|
|
144
|
-
/** Link metadata - populated only when the read passed withLinks (empty otherwise) */
|
|
145
|
-
get links() { var _a, _b; return (_b = (_a = this._record) === null || _a === void 0 ? void 0 : _a.links) !== null && _b !== void 0 ? _b : []; }
|
|
146
|
-
/** Access the underlying OdinRecord (null for new records) */
|
|
147
|
-
get record() { return this._record; }
|
|
148
|
-
// ============================================
|
|
149
|
-
// TYPE GUARDS (with TypeScript type predicates)
|
|
150
|
-
// ============================================
|
|
151
|
-
/**
|
|
152
|
-
* Type guard: check if this record is of type DEFAULT
|
|
153
|
-
*
|
|
154
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
155
|
-
* giving you access to DEFAULT-specific properties.
|
|
156
|
-
*
|
|
157
|
-
* @example
|
|
158
|
-
* ```typescript
|
|
159
|
-
* if (record.isDefault()) {
|
|
160
|
-
* // TypeScript knows record.properties is QaAutoFailProperties
|
|
161
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
162
|
-
* }
|
|
163
|
-
* ```
|
|
164
|
-
* @remarks This is the default record type
|
|
165
|
-
*/
|
|
166
|
-
isDefault() { var _a; return ((_a = this._record) === null || _a === void 0 ? void 0 : _a.type) === 'DEFAULT'; }
|
|
167
|
-
/**
|
|
168
|
-
* Access linked QaRubric records
|
|
169
|
-
* @remarks Available labels: Rubric__AutoFail
|
|
170
|
-
* @throws Error if called on a new (unsaved) record
|
|
171
|
-
*
|
|
172
|
-
* @example
|
|
173
|
-
* ```typescript
|
|
174
|
-
* // Get all linked QaRubric records
|
|
175
|
-
* const items = await record.qaRubrics.list();
|
|
176
|
-
* const first = await record.qaRubrics.first();
|
|
177
|
-
*
|
|
178
|
-
* // Filter by label
|
|
179
|
-
* const specific = await record.qaRubrics.first({ label: 'Rubric__AutoFail' });
|
|
180
|
-
* ```
|
|
181
|
-
*/
|
|
182
|
-
get qaRubrics() {
|
|
183
|
-
var _a;
|
|
184
|
-
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
185
|
-
throw new Error('Cannot access links on a new (unsaved) record');
|
|
186
|
-
if (!this._qaRubrics) {
|
|
187
|
-
this._qaRubrics = new record_link_manager_1.RecordLinkManager(this._provider, this._record, {
|
|
188
|
-
sourceEntity: 'SupportModule:QaAutoFail',
|
|
189
|
-
targetEntity: 'SupportModule:QaRubric',
|
|
190
|
-
targetModuleName: 'SupportModule',
|
|
191
|
-
targetEntityName: 'QaRubric',
|
|
192
|
-
labels: ['Rubric__AutoFail'],
|
|
193
|
-
}, QaRubricRecord_1.QaRubricRecord);
|
|
194
|
-
}
|
|
195
|
-
return this._qaRubrics;
|
|
196
|
-
}
|
|
197
|
-
// ============================================
|
|
198
|
-
// LINK MANAGEMENT
|
|
199
|
-
// ============================================
|
|
200
|
-
/**
|
|
201
|
-
* Queue a link to be created with the next action.
|
|
202
|
-
* Works for both create and update actions.
|
|
203
|
-
* @returns this (for chaining)
|
|
204
|
-
*/
|
|
205
|
-
link(target) {
|
|
206
|
-
this._pendingLinks.push(new core_1.OdinRecordLinkDto({ id: target.id, entity: target.entity }));
|
|
207
|
-
return this;
|
|
208
|
-
}
|
|
209
|
-
/** Get the currently queued links */
|
|
210
|
-
get pendingLinks() {
|
|
211
|
-
return [...this._pendingLinks];
|
|
212
|
-
}
|
|
213
|
-
/** Clear pending links without executing an action */
|
|
214
|
-
clearPendingLinks() {
|
|
215
|
-
this._pendingLinks = [];
|
|
216
|
-
return this;
|
|
217
|
-
}
|
|
218
|
-
/**
|
|
219
|
-
* Immediately unlink a record (API call).
|
|
220
|
-
* Unlike link(), this executes immediately.
|
|
221
|
-
* @throws Error if called on a new (unsaved) record
|
|
222
|
-
*/
|
|
223
|
-
unlink(target) {
|
|
224
|
-
var _a;
|
|
225
|
-
return __awaiter(this, void 0, void 0, function* () {
|
|
226
|
-
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
227
|
-
throw new Error('Cannot unlink from a new (unsaved) record');
|
|
228
|
-
const targetId = typeof target === 'string' ? target : target.id;
|
|
229
|
-
yield this._provider._deleteLinks('SupportModule', 'QaAutoFail', this._record.id, targetId);
|
|
230
|
-
});
|
|
231
|
-
}
|
|
232
|
-
// ============================================
|
|
233
|
-
// UPDATE ACTIONS (require existing record)
|
|
234
|
-
// ============================================
|
|
235
|
-
/**
|
|
236
|
-
* UpdateQaAutoFail
|
|
237
|
-
*
|
|
238
|
-
* Updates this QaAutoFail record with the specified properties.
|
|
239
|
-
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
240
|
-
*
|
|
241
|
-
* @param properties - Required properties for this action
|
|
242
|
-
* @param options - Optional settings
|
|
243
|
-
* @param options.journeyId - Associate with a journey
|
|
244
|
-
* @param options.stageKey - Transition to pipeline stage
|
|
245
|
-
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
246
|
-
* @throws Error if called on a new (unsaved) record
|
|
247
|
-
*
|
|
248
|
-
* @example
|
|
249
|
-
* ```typescript
|
|
250
|
-
* const record = await odinClient.qaAutoFails.get(id);
|
|
251
|
-
* await record.updateQaAutoFail({ ... }).execute();
|
|
252
|
-
*
|
|
253
|
-
* // Dry run (for debugging)
|
|
254
|
-
* const payload = record.updateQaAutoFail({ ... }).dryRun();
|
|
255
|
-
* ```
|
|
256
|
-
*/
|
|
257
|
-
updateQaAutoFail(properties, options) {
|
|
258
|
-
var _a;
|
|
259
|
-
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
260
|
-
throw new Error('updateQaAutoFail requires an existing record. Use accessor.get() first.');
|
|
261
|
-
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateQaAutoFail', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
262
|
-
return new ActionBuilder(this._provider, 'SupportModule', 'QaAutoFail', payload, () => { this._pendingLinks = []; });
|
|
263
|
-
}
|
|
264
|
-
}
|
|
265
|
-
exports.QaAutoFailRecord = QaAutoFailRecord;
|
|
266
|
-
// ============================================
|
|
267
|
-
// TYPED LINK ACCESSORS
|
|
268
|
-
// ============================================
|
|
269
|
-
/** Valid labels for QaRubric associations */
|
|
270
|
-
QaAutoFailRecord.qaRubricsLabels = ['Rubric__AutoFail'];
|
|
271
|
-
/** Type guard to check if an object is a QaAutoFailRecord */
|
|
272
|
-
function isQaAutoFailRecord(obj) {
|
|
273
|
-
return obj instanceof QaAutoFailRecord;
|
|
274
|
-
}
|
|
275
|
-
exports.isQaAutoFailRecord = isQaAutoFailRecord;
|
|
@@ -1,205 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* QaRubricItem Record Wrapper
|
|
3
|
-
*
|
|
4
|
-
* Provides typed action methods and link management.
|
|
5
|
-
* Works with both ApiProvider and DbProvider.
|
|
6
|
-
*
|
|
7
|
-
* All action methods return an ActionBuilder or FlowBuilder.
|
|
8
|
-
* Call .execute() to run or .dryRun() to get the payload for debugging.
|
|
9
|
-
*
|
|
10
|
-
* Can be instantiated with null record for create operations:
|
|
11
|
-
* ```typescript
|
|
12
|
-
* const record = odinClient.qaRubricItems.new();
|
|
13
|
-
* await record.createQaRubricItem({ ... }).execute();
|
|
14
|
-
* ```
|
|
15
|
-
*
|
|
16
|
-
* Entity Types: DEFAULT
|
|
17
|
-
*
|
|
18
|
-
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
19
|
-
*/
|
|
20
|
-
import { OdinRecord, OdinRecordLinkDto } from '@d19n/odin-types/dist/core';
|
|
21
|
-
import { PipelineStageEntity } from '@d19n/odin-types/dist/core';
|
|
22
|
-
import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/v1.db.interfaces';
|
|
23
|
-
import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
|
|
24
|
-
import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
|
|
25
|
-
import { QaRubricItemProperties } from '../entities-v2/QaRubricItem';
|
|
26
|
-
import { UpdateQaRubricItemProperties } from '../actions-v2/UpdateQaRubricItemDto';
|
|
27
|
-
import { QaRubricSectionRecord } from './QaRubricSectionRecord';
|
|
28
|
-
/** Valid entity types for QaRubricItem */
|
|
29
|
-
export declare type QaRubricItemType = 'DEFAULT';
|
|
30
|
-
/**
|
|
31
|
-
* Builder for action execution with dryRun support
|
|
32
|
-
*
|
|
33
|
-
* Provides a consistent API across all action types:
|
|
34
|
-
* - `.execute()` - Execute the action and return results
|
|
35
|
-
* - `.dryRun()` - Return the payload without executing (for debugging)
|
|
36
|
-
*/
|
|
37
|
-
declare class ActionBuilder<T = IDbRecordCreateUpdateRes[]> {
|
|
38
|
-
private _provider;
|
|
39
|
-
private _moduleName;
|
|
40
|
-
private _entityName;
|
|
41
|
-
private _payload;
|
|
42
|
-
private _clearPendingLinks;
|
|
43
|
-
constructor(provider: IOdinProvider, moduleName: string, entityName: string, payload: Record<string, any>, clearPendingLinks: () => void);
|
|
44
|
-
/**
|
|
45
|
-
* Set an external system identifier for this record.
|
|
46
|
-
* Links the record to a corresponding entry in an external application.
|
|
47
|
-
*
|
|
48
|
-
* @param externalId - The ID in the external system
|
|
49
|
-
* @param externalAppId - The external application identifier
|
|
50
|
-
* @returns this (for chaining)
|
|
51
|
-
*
|
|
52
|
-
* @example
|
|
53
|
-
* ```typescript
|
|
54
|
-
* await record.createOrder({ ... }).withExternalId('SF-123', 'salesforce').execute();
|
|
55
|
-
* ```
|
|
56
|
-
*/
|
|
57
|
-
withExternalId(externalId: string, externalAppId: string): this;
|
|
58
|
-
/**
|
|
59
|
-
* Set security/access groups for this record.
|
|
60
|
-
* Controls which user groups can access the record.
|
|
61
|
-
*
|
|
62
|
-
* @param groups - Array of group names
|
|
63
|
-
* @returns this (for chaining)
|
|
64
|
-
*
|
|
65
|
-
* @example
|
|
66
|
-
* ```typescript
|
|
67
|
-
* await record.createOrder({ ... }).withGroups(['TenantA', 'BillingTeam']).execute();
|
|
68
|
-
* ```
|
|
69
|
-
*/
|
|
70
|
-
withGroups(groups: string[]): this;
|
|
71
|
-
/**
|
|
72
|
-
* Execute the action
|
|
73
|
-
* @returns The result from the API
|
|
74
|
-
*/
|
|
75
|
-
execute(): Promise<T>;
|
|
76
|
-
/**
|
|
77
|
-
* Returns the request payload without executing (for debugging)
|
|
78
|
-
* @returns The request payload that would be sent to the API
|
|
79
|
-
*/
|
|
80
|
-
dryRun(): Record<string, any>;
|
|
81
|
-
/**
|
|
82
|
-
* Prevents accidental `await actionBuilder` without .execute()
|
|
83
|
-
* Forces developers to explicitly call .execute()
|
|
84
|
-
* @throws Error always - use .execute() or .dryRun() instead
|
|
85
|
-
*/
|
|
86
|
-
then(): never;
|
|
87
|
-
}
|
|
88
|
-
export declare class QaRubricItemRecord<TProps = QaRubricItemProperties> {
|
|
89
|
-
private _record;
|
|
90
|
-
private _provider;
|
|
91
|
-
private _pendingLinks;
|
|
92
|
-
private _preGeneratedId;
|
|
93
|
-
private _qaRubricSections?;
|
|
94
|
-
/**
|
|
95
|
-
* Create a record wrapper.
|
|
96
|
-
* @param record - The underlying record, or null for create operations
|
|
97
|
-
* @param provider - The API or DB provider
|
|
98
|
-
* @param preGeneratedId - Optional pre-generated ID for new records (auto-generated if not provided)
|
|
99
|
-
*/
|
|
100
|
-
constructor(record: OdinRecord<TProps> | null, provider: IOdinProvider, preGeneratedId?: string);
|
|
101
|
-
/** Returns true if this is a new (unsaved) record */
|
|
102
|
-
get isNew(): boolean;
|
|
103
|
-
/** Record ID - always available (pre-generated for new records) */
|
|
104
|
-
get id(): string;
|
|
105
|
-
get entity(): string;
|
|
106
|
-
get type(): QaRubricItemType | undefined;
|
|
107
|
-
/** Record properties - empty object for new (unsaved) records */
|
|
108
|
-
get properties(): TProps;
|
|
109
|
-
get title(): string | undefined;
|
|
110
|
-
get recordNumber(): string | undefined;
|
|
111
|
-
get stage(): PipelineStageEntity | undefined;
|
|
112
|
-
get createdAt(): string | undefined;
|
|
113
|
-
get updatedAt(): string | undefined;
|
|
114
|
-
get externalId(): string | undefined;
|
|
115
|
-
get externalAppId(): string | undefined;
|
|
116
|
-
get groups(): string[];
|
|
117
|
-
/** Link metadata - populated only when the read passed withLinks (empty otherwise) */
|
|
118
|
-
get links(): OdinRecord<TProps>['links'];
|
|
119
|
-
/** Access the underlying OdinRecord (null for new records) */
|
|
120
|
-
get record(): OdinRecord<TProps> | null;
|
|
121
|
-
/**
|
|
122
|
-
* Type guard: check if this record is of type DEFAULT
|
|
123
|
-
*
|
|
124
|
-
* When this returns true, TypeScript automatically narrows the type,
|
|
125
|
-
* giving you access to DEFAULT-specific properties.
|
|
126
|
-
*
|
|
127
|
-
* @example
|
|
128
|
-
* ```typescript
|
|
129
|
-
* if (record.isDefault()) {
|
|
130
|
-
* // TypeScript knows record.properties is QaRubricItemProperties
|
|
131
|
-
* console.log(record.properties.SomeTypeSpecificField);
|
|
132
|
-
* }
|
|
133
|
-
* ```
|
|
134
|
-
* @remarks This is the default record type
|
|
135
|
-
*/
|
|
136
|
-
isDefault(): this is QaRubricItemRecord<QaRubricItemProperties>;
|
|
137
|
-
/** Valid labels for QaRubricSection associations */
|
|
138
|
-
static readonly qaRubricSectionsLabels: readonly ["Section__Item"];
|
|
139
|
-
/**
|
|
140
|
-
* Access linked QaRubricSection records
|
|
141
|
-
* @remarks Available labels: Section__Item
|
|
142
|
-
* @throws Error if called on a new (unsaved) record
|
|
143
|
-
*
|
|
144
|
-
* @example
|
|
145
|
-
* ```typescript
|
|
146
|
-
* // Get all linked QaRubricSection records
|
|
147
|
-
* const items = await record.qaRubricSections.list();
|
|
148
|
-
* const first = await record.qaRubricSections.first();
|
|
149
|
-
*
|
|
150
|
-
* // Filter by label
|
|
151
|
-
* const specific = await record.qaRubricSections.first({ label: 'Section__Item' });
|
|
152
|
-
* ```
|
|
153
|
-
*/
|
|
154
|
-
get qaRubricSections(): RecordLinkManager<QaRubricSectionRecord, typeof QaRubricItemRecord['qaRubricSectionsLabels'][number]>;
|
|
155
|
-
/**
|
|
156
|
-
* Queue a link to be created with the next action.
|
|
157
|
-
* Works for both create and update actions.
|
|
158
|
-
* @returns this (for chaining)
|
|
159
|
-
*/
|
|
160
|
-
link(target: OdinRecord<any> | {
|
|
161
|
-
id: string;
|
|
162
|
-
entity: string;
|
|
163
|
-
}): this;
|
|
164
|
-
/** Get the currently queued links */
|
|
165
|
-
get pendingLinks(): OdinRecordLinkDto[];
|
|
166
|
-
/** Clear pending links without executing an action */
|
|
167
|
-
clearPendingLinks(): this;
|
|
168
|
-
/**
|
|
169
|
-
* Immediately unlink a record (API call).
|
|
170
|
-
* Unlike link(), this executes immediately.
|
|
171
|
-
* @throws Error if called on a new (unsaved) record
|
|
172
|
-
*/
|
|
173
|
-
unlink(target: OdinRecord<any> | {
|
|
174
|
-
id: string;
|
|
175
|
-
} | string): Promise<void>;
|
|
176
|
-
/**
|
|
177
|
-
* UpdateQaRubricItem
|
|
178
|
-
*
|
|
179
|
-
* Updates this QaRubricItem record with the specified properties.
|
|
180
|
-
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
181
|
-
*
|
|
182
|
-
* @param properties - Required properties for this action
|
|
183
|
-
* @param options - Optional settings
|
|
184
|
-
* @param options.journeyId - Associate with a journey
|
|
185
|
-
* @param options.stageKey - Transition to pipeline stage
|
|
186
|
-
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
187
|
-
* @throws Error if called on a new (unsaved) record
|
|
188
|
-
*
|
|
189
|
-
* @example
|
|
190
|
-
* ```typescript
|
|
191
|
-
* const record = await odinClient.qaRubricItems.get(id);
|
|
192
|
-
* await record.updateQaRubricItem({ ... }).execute();
|
|
193
|
-
*
|
|
194
|
-
* // Dry run (for debugging)
|
|
195
|
-
* const payload = record.updateQaRubricItem({ ... }).dryRun();
|
|
196
|
-
* ```
|
|
197
|
-
*/
|
|
198
|
-
updateQaRubricItem(properties: UpdateQaRubricItemProperties, options?: {
|
|
199
|
-
journeyId?: string;
|
|
200
|
-
stageKey?: string;
|
|
201
|
-
}): ActionBuilder;
|
|
202
|
-
}
|
|
203
|
-
/** Type guard to check if an object is a QaRubricItemRecord */
|
|
204
|
-
export declare function isQaRubricItemRecord(obj: any): obj is QaRubricItemRecord;
|
|
205
|
-
export {};
|