@d19n/youfibre-odin-sdk 2.0.18 → 2.0.19
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 +20 -1
- package/dist/EntityRegistry.d.ts +2 -0
- package/dist/EntityRegistry.js +2 -0
- package/dist/OdinApiClient.d.ts +4 -0
- package/dist/OdinApiClient.js +8 -0
- package/dist/OdinDbClient.d.ts +4 -0
- package/dist/OdinDbClient.js +8 -0
- package/dist/accessors-v2/BngProvisionAccessor.d.ts +111 -0
- package/dist/accessors-v2/BngProvisionAccessor.js +190 -0
- package/dist/accessors-v2/index.d.ts +1 -0
- package/dist/accessors-v2/index.js +5 -3
- package/dist/actions-v2/CreateBngProvisionDto.d.ts +116 -0
- package/dist/actions-v2/CreateBngProvisionDto.js +54 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromInProgressToPendingDto.d.ts +115 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromInProgressToPendingDto.js +80 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromPendingToInProgressDto.d.ts +115 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromPendingToInProgressDto.js +80 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromRemediationToInProgressDto.d.ts +115 -0
- package/dist/actions-v2/MoveInstallWorkOrderFromRemediationToInProgressDto.js +80 -0
- package/dist/actions-v2/MoveInstallWorkOrderToCancelledDto.d.ts +115 -0
- package/dist/actions-v2/MoveInstallWorkOrderToCancelledDto.js +80 -0
- package/dist/actions-v2/UpdateCaseCsatDto.d.ts +135 -0
- package/dist/actions-v2/UpdateCaseCsatDto.js +56 -0
- package/dist/db-accessors-v2/BngProvisionDbAccessor.d.ts +149 -0
- package/dist/db-accessors-v2/BngProvisionDbAccessor.js +227 -0
- package/dist/db-accessors-v2/index.d.ts +1 -0
- package/dist/db-accessors-v2/index.js +5 -3
- package/dist/entities-v2/Config.d.ts +8 -8
- package/dist/entities-v2/Config.js +4 -4
- package/dist/entities-v2/Contact.d.ts +7 -0
- package/dist/entities-v2/Contact.js +2 -0
- package/dist/entities-v2/CustomerDeviceOnt.d.ts +2 -0
- package/dist/entities-v2/CustomerDeviceOnt.js +2 -0
- package/dist/records-v2/BngProvisionRecord.d.ts +205 -0
- package/dist/records-v2/BngProvisionRecord.js +280 -0
- package/dist/records-v2/CaseRecord.d.ts +28 -0
- package/dist/records-v2/CaseRecord.js +37 -0
- package/dist/records-v2/OrderItemRecord.d.ts +20 -0
- package/dist/records-v2/OrderItemRecord.js +33 -0
- package/dist/records-v2/WorkOrderRecord.d.ts +100 -0
- package/dist/records-v2/WorkOrderRecord.js +116 -0
- package/dist/records-v2/index.d.ts +1 -0
- package/dist/records-v2/index.js +7 -4
- package/package.json +1 -1
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* BngProvision DB Accessor
|
|
4
|
+
*
|
|
5
|
+
* Provides typed access to BngProvision 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 BngProvisionDbAccessor(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.BngProvisionDbAccessor = 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 BngProvisionRecord_1 = require("../records-v2/BngProvisionRecord");
|
|
55
|
+
class BngProvisionDbAccessor {
|
|
56
|
+
/**
|
|
57
|
+
* Create a new BngProvisionDbAccessor
|
|
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 = 'ServiceModule';
|
|
64
|
+
this._entityName = 'BngProvision';
|
|
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 BngProvision 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 BngProvisionRecord_1.BngProvisionRecord(null, this._provider, id);
|
|
99
|
+
}
|
|
100
|
+
// ============================================
|
|
101
|
+
// RECORD RETRIEVAL
|
|
102
|
+
// ============================================
|
|
103
|
+
/**
|
|
104
|
+
* Get a single BngProvision 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 BngProvisionRecord_1.BngProvisionRecord(record, this._provider);
|
|
129
|
+
});
|
|
130
|
+
}
|
|
131
|
+
/**
|
|
132
|
+
* Get multiple BngProvision 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 BngProvisionRecord_1.BngProvisionRecord(r, this._provider));
|
|
144
|
+
});
|
|
145
|
+
}
|
|
146
|
+
// ============================================
|
|
147
|
+
// SEARCH OPERATIONS
|
|
148
|
+
// ============================================
|
|
149
|
+
/**
|
|
150
|
+
* Search BngProvision records
|
|
151
|
+
*
|
|
152
|
+
* @param params - Search parameters
|
|
153
|
+
* @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
|
|
154
|
+
*/
|
|
155
|
+
search(params, providerOptions) {
|
|
156
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
157
|
+
const result = yield this._provider._searchRecords(this._moduleName, this._entityName, params, providerOptions);
|
|
158
|
+
return {
|
|
159
|
+
records: result.records.map((r) => new BngProvisionRecord_1.BngProvisionRecord(r, this._provider)),
|
|
160
|
+
totalRecords: result.totalRecords,
|
|
161
|
+
hasMore: result.hasMore,
|
|
162
|
+
};
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Search all BngProvision records with automatic pagination
|
|
167
|
+
*
|
|
168
|
+
* @param params - Search parameters
|
|
169
|
+
* @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
|
|
170
|
+
*/
|
|
171
|
+
searchAll(params, providerOptions) {
|
|
172
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
173
|
+
const result = yield this._provider._searchAllRecordsAndPaginate(this._moduleName, this._entityName, params, 0, providerOptions);
|
|
174
|
+
return result.records.map((r) => new BngProvisionRecord_1.BngProvisionRecord(r, this._provider));
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
/**
|
|
178
|
+
* Async generator for paginating through all matching records.
|
|
179
|
+
* Yields batches of wrapped records.
|
|
180
|
+
*
|
|
181
|
+
* @param params - Search parameters
|
|
182
|
+
* @param providerOptions - Provider options (HOW to fetch: omitPermissionsCheck)
|
|
183
|
+
*/
|
|
184
|
+
paginate(params, providerOptions) {
|
|
185
|
+
var _a;
|
|
186
|
+
return __asyncGenerator(this, arguments, function* paginate_1() {
|
|
187
|
+
let hasMore = true;
|
|
188
|
+
let searchAfter;
|
|
189
|
+
const query = Object.assign(Object.assign({}, params.query), { pageSize: ((_a = params.query) === null || _a === void 0 ? void 0 : _a.pageSize) || 500 });
|
|
190
|
+
while (hasMore) {
|
|
191
|
+
const result = yield __await(this._provider._searchRecords(this._moduleName, this._entityName, Object.assign(Object.assign({}, params), { query: Object.assign(Object.assign({}, query), { searchAfter }) }), providerOptions));
|
|
192
|
+
if (result.records.length > 0) {
|
|
193
|
+
yield yield __await(result.records.map((r) => new BngProvisionRecord_1.BngProvisionRecord(r, this._provider)));
|
|
194
|
+
const lastRecord = result.records[result.records.length - 1];
|
|
195
|
+
searchAfter = lastRecord === null || lastRecord === void 0 ? void 0 : lastRecord.sort;
|
|
196
|
+
}
|
|
197
|
+
hasMore = result.hasMore && result.records.length >= query.pageSize;
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
}
|
|
201
|
+
// ============================================
|
|
202
|
+
// QUERY BUILDER
|
|
203
|
+
// ============================================
|
|
204
|
+
/**
|
|
205
|
+
* Create a fluent query builder for BngProvision records
|
|
206
|
+
*
|
|
207
|
+
* @example
|
|
208
|
+
* ```typescript
|
|
209
|
+
* const results = await accessor
|
|
210
|
+
* .query()
|
|
211
|
+
* .where('Status', 'in', ['Active', 'Pending'])
|
|
212
|
+
* .where('CreatedAt', 'gte', '2025-01-01')
|
|
213
|
+
* .select('id', 'title', 'properties.*')
|
|
214
|
+
* .sortBy('createdAt', 'desc')
|
|
215
|
+
* .limit(100)
|
|
216
|
+
* .execute();
|
|
217
|
+
* ```
|
|
218
|
+
*/
|
|
219
|
+
query() {
|
|
220
|
+
return (0, query_builder_1.createQueryBuilder)(this);
|
|
221
|
+
}
|
|
222
|
+
/** Access the underlying DbProvider */
|
|
223
|
+
get provider() {
|
|
224
|
+
return this._provider;
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
exports.BngProvisionDbAccessor = BngProvisionDbAccessor;
|
|
@@ -17,6 +17,7 @@ export { AppointmentDbAccessor, AppointmentDbSearchResponse } from './Appointmen
|
|
|
17
17
|
export { BillingAdjustmentDbAccessor, BillingAdjustmentDbSearchResponse } from './BillingAdjustmentDbAccessor';
|
|
18
18
|
export { BillingRequestDbAccessor, BillingRequestDbSearchResponse } from './BillingRequestDbAccessor';
|
|
19
19
|
export { BlockageA55DbAccessor, BlockageA55DbSearchResponse } from './BlockageA55DbAccessor';
|
|
20
|
+
export { BngProvisionDbAccessor, BngProvisionDbSearchResponse } from './BngProvisionDbAccessor';
|
|
20
21
|
export { BrskEntityMigrationErrorDbAccessor, BrskEntityMigrationErrorDbSearchResponse } from './BrskEntityMigrationErrorDbAccessor';
|
|
21
22
|
export { CallEventDbAccessor, CallEventDbSearchResponse } from './CallEventDbAccessor';
|
|
22
23
|
export { CallLegDbAccessor, CallLegDbSearchResponse } from './CallLegDbAccessor';
|
|
@@ -9,9 +9,9 @@
|
|
|
9
9
|
* AUTO-GENERATED - DO NOT EDIT DIRECTLY
|
|
10
10
|
*/
|
|
11
11
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
-
exports.
|
|
13
|
-
exports.
|
|
14
|
-
exports.YfStockAuditDbAccessor = exports.YfFieldServiceVisitDbAccessor = exports.WorkOrderStatusUpdateDbAccessor = exports.WorkOrderDbAccessor = exports.WayleaveAuditDbAccessor = exports.VoiceConfigurationDbAccessor = exports.VisitDbAccessor = exports.UserDbAccessor = exports.UgRetroAuditDbAccessor = exports.UgInstallationAuditDbAccessor = exports.UgInProgressAuditDbAccessor = exports.UgExternalAuditDbAccessor = exports.UgAuditOfInstallationDbAccessor = void 0;
|
|
12
|
+
exports.OhExternalAuditDbAccessor = exports.OhAuditOfInstallationDbAccessor = exports.OfferDbAccessor = exports.NoteDbAccessor = exports.NetworkDeviceDbAccessor = exports.MessageDbAccessor = exports.LeadDbAccessor = exports.KnowledgeArticleDbAccessor = exports.InvoiceDbAccessor = exports.InvoiceItemDbAccessor = exports.InternalInstallAuditDbAccessor = exports.ImpersonationTrackerDbAccessor = exports.FileDbAccessor = exports.FieldServiceProductDbAccessor = exports.FieldServiceDispatchedProductDbAccessor = exports.EmailTemplateDbAccessor = exports.EmailSenderDbAccessor = exports.EmailDbAccessor = exports.DiscountDbAccessor = exports.CustomerPhonePortingDbAccessor = exports.CustomerDeviceRouterDbAccessor = exports.CustomerDeviceOntDbAccessor = exports.CustomerDeviceConfigurationDbAccessor = exports.CustomerDeviceAtaDbAccessor = exports.CrmDatasetDbAccessor = exports.CreditNoteDbAccessor = exports.ConversationDbAccessor = exports.ContractBuyOutDbAccessor = exports.ContactDbAccessor = exports.ConfigDbAccessor = exports.ChurnRequestDbAccessor = exports.ChangeReasonDbAccessor = exports.CaseDbAccessor = exports.CampaignDbAccessor = exports.CallTransferDbAccessor = exports.CallDbAccessor = exports.CallLegDbAccessor = exports.CallEventDbAccessor = exports.BrskEntityMigrationErrorDbAccessor = exports.BngProvisionDbAccessor = exports.BlockageA55DbAccessor = exports.BillingRequestDbAccessor = exports.BillingAdjustmentDbAccessor = exports.AppointmentDbAccessor = exports.AffiliateCodeDbAccessor = exports.AddressDbAccessor = exports.ActivityDbAccessor = exports.ActivityLogDbAccessor = exports.AccountDbAccessor = exports.AccountCreditDbAccessor = void 0;
|
|
13
|
+
exports.TransactionDbAccessor = exports.TimeSlotDbAccessor = exports.TestEntityForVisualBuilderDbAccessor = exports.TeamDbAccessor = exports.SweeperMaintenanceAuditDbAccessor = exports.SmsMessageDbAccessor = exports.SiteSpecificRiskAssessmentOutcomeFormDbAccessor = exports.ServiceVisitAuditDbAccessor = exports.ServiceDbAccessor = exports.ServiceAppointmentDbAccessor = exports.ServiceAppointmentConfigDbAccessor = exports.ScheduleSlotDbAccessor = exports.SalesTerritoryDbAccessor = exports.RewardDbAccessor = exports.ReturnsDbAccessor = exports.RemediationRequiredReasonDbAccessor = exports.RemediationOutcomeFormDbAccessor = exports.ReferralDbAccessor = exports.PushNotificationDbAccessor = exports.ProductDbAccessor = exports.PriceBookDbAccessor = exports.PICRequestDbAccessor = exports.PhoneNumberDbAccessor = exports.PgWebhookDbAccessor = exports.PgWebhookAttemptDbAccessor = exports.PgVocalinkDbAccessor = exports.PgTransactionDbAccessor = exports.PgSortCodeSubstitutionDbAccessor = exports.PgPaymentMethodDbAccessor = exports.PgLogDbAccessor = exports.PgFileAllocationDbAccessor = exports.PgDisputeDbAccessor = exports.PgDirectDebitFileDbAccessor = exports.PgContactDbAccessor = exports.PgAccountValidationDbAccessor = exports.PermissionToFailDbAccessor = exports.PaymentDbAccessor = exports.PaymentMethodRefundDbAccessor = exports.PaymentMethodDbAccessor = exports.OverlayRealA55DbAccessor = exports.OutageDbAccessor = exports.OrderDbAccessor = exports.OrderKciDbAccessor = exports.OrderItemDbAccessor = exports.OrderCheckDbAccessor = exports.OntReplacementApprovalDbAccessor = exports.OneTouchSwitchDbAccessor = exports.OhRetroAuditDbAccessor = exports.OhInstallationAuditDbAccessor = exports.OhInProgressAuditDbAccessor = void 0;
|
|
14
|
+
exports.YfStockAuditDbAccessor = exports.YfFieldServiceVisitDbAccessor = exports.WorkOrderStatusUpdateDbAccessor = exports.WorkOrderDbAccessor = exports.WayleaveAuditDbAccessor = exports.VoiceConfigurationDbAccessor = exports.VisitDbAccessor = exports.UserDbAccessor = exports.UgRetroAuditDbAccessor = exports.UgInstallationAuditDbAccessor = exports.UgInProgressAuditDbAccessor = exports.UgExternalAuditDbAccessor = exports.UgAuditOfInstallationDbAccessor = exports.TwilioUserUpdateDbAccessor = 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");
|
|
@@ -32,6 +32,8 @@ var BillingRequestDbAccessor_1 = require("./BillingRequestDbAccessor");
|
|
|
32
32
|
Object.defineProperty(exports, "BillingRequestDbAccessor", { enumerable: true, get: function () { return BillingRequestDbAccessor_1.BillingRequestDbAccessor; } });
|
|
33
33
|
var BlockageA55DbAccessor_1 = require("./BlockageA55DbAccessor");
|
|
34
34
|
Object.defineProperty(exports, "BlockageA55DbAccessor", { enumerable: true, get: function () { return BlockageA55DbAccessor_1.BlockageA55DbAccessor; } });
|
|
35
|
+
var BngProvisionDbAccessor_1 = require("./BngProvisionDbAccessor");
|
|
36
|
+
Object.defineProperty(exports, "BngProvisionDbAccessor", { enumerable: true, get: function () { return BngProvisionDbAccessor_1.BngProvisionDbAccessor; } });
|
|
35
37
|
var BrskEntityMigrationErrorDbAccessor_1 = require("./BrskEntityMigrationErrorDbAccessor");
|
|
36
38
|
Object.defineProperty(exports, "BrskEntityMigrationErrorDbAccessor", { enumerable: true, get: function () { return BrskEntityMigrationErrorDbAccessor_1.BrskEntityMigrationErrorDbAccessor; } });
|
|
37
39
|
var CallEventDbAccessor_1 = require("./CallEventDbAccessor");
|
|
@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
|
|
|
23
23
|
* Use these constants instead of string literals for type safety
|
|
24
24
|
*/
|
|
25
25
|
export declare enum ConfigPropertyKeys {
|
|
26
|
-
/**
|
|
27
|
-
|
|
26
|
+
/** Data field for Config records. Used by Platform team. */
|
|
27
|
+
Test = "Test",
|
|
28
28
|
/** object of { key: value } mappings (Platform - Config) */
|
|
29
29
|
Mappings = "Mappings",
|
|
30
|
-
/**
|
|
31
|
-
|
|
30
|
+
/** the name of the app this config relates to (Platform - Config) */
|
|
31
|
+
AppName = "AppName"
|
|
32
32
|
}
|
|
33
33
|
/**
|
|
34
34
|
* Properties for Config records
|
|
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
|
|
|
36
36
|
* @see SchemaModule:Config
|
|
37
37
|
*/
|
|
38
38
|
export interface ConfigProperties {
|
|
39
|
-
/**
|
|
39
|
+
/** Data field for Config records. Used by Platform team.
|
|
40
40
|
*
|
|
41
41
|
* @type {TEXT}
|
|
42
42
|
*/
|
|
43
|
-
|
|
43
|
+
Test: string;
|
|
44
44
|
/** object of { key: value } mappings (Platform - Config)
|
|
45
45
|
*
|
|
46
46
|
* @type {JSON}
|
|
47
47
|
*/
|
|
48
48
|
Mappings: string;
|
|
49
|
-
/**
|
|
49
|
+
/** the name of the app this config relates to (Platform - Config)
|
|
50
50
|
*
|
|
51
51
|
* @type {TEXT}
|
|
52
52
|
*/
|
|
53
|
-
|
|
53
|
+
AppName: string;
|
|
54
54
|
}
|
|
55
55
|
/**
|
|
56
56
|
* Config entity from SchemaModule
|
|
@@ -28,12 +28,12 @@ var ConfigEntityTypes;
|
|
|
28
28
|
*/
|
|
29
29
|
var ConfigPropertyKeys;
|
|
30
30
|
(function (ConfigPropertyKeys) {
|
|
31
|
-
/** the name of the app this config relates to (Platform - Config) */
|
|
32
|
-
ConfigPropertyKeys["AppName"] = "AppName";
|
|
33
|
-
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
-
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
31
|
/** Data field for Config records. Used by Platform team. */
|
|
36
32
|
ConfigPropertyKeys["Test"] = "Test";
|
|
33
|
+
/** object of { key: value } mappings (Platform - Config) */
|
|
34
|
+
ConfigPropertyKeys["Mappings"] = "Mappings";
|
|
35
|
+
/** the name of the app this config relates to (Platform - Config) */
|
|
36
|
+
ConfigPropertyKeys["AppName"] = "AppName";
|
|
37
37
|
})(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
|
|
38
38
|
/**
|
|
39
39
|
* Config entity from SchemaModule
|
|
@@ -361,6 +361,8 @@ export declare enum ContactPropertyKeys {
|
|
|
361
361
|
ActivationDate = "ActivationDate",
|
|
362
362
|
/** Is the customer medically dependant on their broadband (Sales - Contact) */
|
|
363
363
|
MedicallyDependant = "MedicallyDependant",
|
|
364
|
+
/** vulnerable customer */
|
|
365
|
+
VulnerableCustomer = "VulnerableCustomer",
|
|
364
366
|
/** Name */
|
|
365
367
|
Name = "Name",
|
|
366
368
|
/** External Reference */
|
|
@@ -683,6 +685,11 @@ export interface ContactProperties {
|
|
|
683
685
|
* @default FALSE
|
|
684
686
|
*/
|
|
685
687
|
MedicallyDependant: boolean;
|
|
688
|
+
/** vulnerable customer
|
|
689
|
+
*
|
|
690
|
+
* @type {BOOLEAN}
|
|
691
|
+
*/
|
|
692
|
+
VulnerableCustomer: boolean;
|
|
686
693
|
/** Name
|
|
687
694
|
*
|
|
688
695
|
* @type {TEXT}
|
|
@@ -344,6 +344,8 @@ var ContactPropertyKeys;
|
|
|
344
344
|
ContactPropertyKeys["ActivationDate"] = "ActivationDate";
|
|
345
345
|
/** Is the customer medically dependant on their broadband (Sales - Contact) */
|
|
346
346
|
ContactPropertyKeys["MedicallyDependant"] = "MedicallyDependant";
|
|
347
|
+
/** vulnerable customer */
|
|
348
|
+
ContactPropertyKeys["VulnerableCustomer"] = "VulnerableCustomer";
|
|
347
349
|
/** Name */
|
|
348
350
|
ContactPropertyKeys["Name"] = "Name";
|
|
349
351
|
/** External Reference */
|
|
@@ -38,8 +38,10 @@ export declare enum CustomerDeviceOntEntityTypes {
|
|
|
38
38
|
* - `621_X` - 621X
|
|
39
39
|
* - `622_V` - 622v
|
|
40
40
|
* - `631_Q` - 631q
|
|
41
|
+
* - `BRSK_OTHER`
|
|
41
42
|
*/
|
|
42
43
|
export declare enum CustomerDeviceOntModel {
|
|
44
|
+
BRSK_OTHER = "BRSK_OTHER"
|
|
43
45
|
}
|
|
44
46
|
/**
|
|
45
47
|
* Valid values for CustomerDeviceOnt.OltName
|
|
@@ -32,9 +32,11 @@ var CustomerDeviceOntEntityTypes;
|
|
|
32
32
|
* - `621_X` - 621X
|
|
33
33
|
* - `622_V` - 622v
|
|
34
34
|
* - `631_Q` - 631q
|
|
35
|
+
* - `BRSK_OTHER`
|
|
35
36
|
*/
|
|
36
37
|
var CustomerDeviceOntModel;
|
|
37
38
|
(function (CustomerDeviceOntModel) {
|
|
39
|
+
CustomerDeviceOntModel["BRSK_OTHER"] = "BRSK_OTHER";
|
|
38
40
|
})(CustomerDeviceOntModel = exports.CustomerDeviceOntModel || (exports.CustomerDeviceOntModel = {}));
|
|
39
41
|
/**
|
|
40
42
|
* Valid values for CustomerDeviceOnt.OltName
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* BngProvision 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.bngProvisions.new();
|
|
13
|
+
* await record.createBngProvision({ ... }).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 { BngProvisionProperties } from '../entities-v2/BngProvision';
|
|
26
|
+
import { CreateBngProvisionProperties } from '../actions-v2/CreateBngProvisionDto';
|
|
27
|
+
import { OrderItemRecord } from './OrderItemRecord';
|
|
28
|
+
/** Valid entity types for BngProvision */
|
|
29
|
+
export declare type BngProvisionType = '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 BngProvisionRecord<TProps = BngProvisionProperties> {
|
|
89
|
+
private _record;
|
|
90
|
+
private _provider;
|
|
91
|
+
private _pendingLinks;
|
|
92
|
+
private _preGeneratedId;
|
|
93
|
+
private _orderItems?;
|
|
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(): BngProvisionType | 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
|
+
/** Access the underlying OdinRecord (null for new records) */
|
|
118
|
+
get record(): OdinRecord<TProps> | null;
|
|
119
|
+
/**
|
|
120
|
+
* Type guard: check if this record is of type DEFAULT
|
|
121
|
+
*
|
|
122
|
+
* When this returns true, TypeScript automatically narrows the type,
|
|
123
|
+
* giving you access to DEFAULT-specific properties.
|
|
124
|
+
*
|
|
125
|
+
* @example
|
|
126
|
+
* ```typescript
|
|
127
|
+
* if (record.isDefault()) {
|
|
128
|
+
* // TypeScript knows record.properties is BngProvisionProperties
|
|
129
|
+
* console.log(record.properties.SomeTypeSpecificField);
|
|
130
|
+
* }
|
|
131
|
+
* ```
|
|
132
|
+
* @remarks This is the default record type
|
|
133
|
+
*/
|
|
134
|
+
isDefault(): this is BngProvisionRecord<BngProvisionProperties>;
|
|
135
|
+
/** Valid labels for OrderItem associations */
|
|
136
|
+
static readonly orderItemsLabels: readonly ["OrderItem__BngProvision"];
|
|
137
|
+
/**
|
|
138
|
+
* Access linked OrderItem records
|
|
139
|
+
* @remarks Available labels: OrderItem__BngProvision
|
|
140
|
+
* @throws Error if called on a new (unsaved) record
|
|
141
|
+
*
|
|
142
|
+
* @example
|
|
143
|
+
* ```typescript
|
|
144
|
+
* // Get all linked OrderItem records
|
|
145
|
+
* const items = await record.orderItems.list();
|
|
146
|
+
* const first = await record.orderItems.first();
|
|
147
|
+
*
|
|
148
|
+
* // Filter by label
|
|
149
|
+
* const specific = await record.orderItems.first({ label: 'OrderItem__BngProvision' });
|
|
150
|
+
* ```
|
|
151
|
+
*/
|
|
152
|
+
get orderItems(): RecordLinkManager<OrderItemRecord, typeof BngProvisionRecord['orderItemsLabels'][number]>;
|
|
153
|
+
/**
|
|
154
|
+
* Queue a link to be created with the next action.
|
|
155
|
+
* Works for both create and update actions.
|
|
156
|
+
* @returns this (for chaining)
|
|
157
|
+
*/
|
|
158
|
+
link(target: OdinRecord<any> | {
|
|
159
|
+
id: string;
|
|
160
|
+
entity: string;
|
|
161
|
+
}): this;
|
|
162
|
+
/** Get the currently queued links */
|
|
163
|
+
get pendingLinks(): OdinRecordLinkDto[];
|
|
164
|
+
/** Clear pending links without executing an action */
|
|
165
|
+
clearPendingLinks(): this;
|
|
166
|
+
/**
|
|
167
|
+
* Immediately unlink a record (API call).
|
|
168
|
+
* Unlike link(), this executes immediately.
|
|
169
|
+
* @throws Error if called on a new (unsaved) record
|
|
170
|
+
*/
|
|
171
|
+
unlink(target: OdinRecord<any> | {
|
|
172
|
+
id: string;
|
|
173
|
+
} | string): Promise<void>;
|
|
174
|
+
/**
|
|
175
|
+
* CreateBngProvision
|
|
176
|
+
*
|
|
177
|
+
* Creates a new BngProvision record with the specified properties.
|
|
178
|
+
* Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
|
|
179
|
+
*
|
|
180
|
+
* @param properties - The properties for the new record
|
|
181
|
+
* @param options - Optional settings
|
|
182
|
+
* @param options.type - Override the record type
|
|
183
|
+
* @param options.journeyId - Associate with a journey
|
|
184
|
+
* @param options.stageKey - Set initial pipeline stage
|
|
185
|
+
* @returns ActionBuilder - call .execute() to create or .dryRun() for payload
|
|
186
|
+
*
|
|
187
|
+
* @example
|
|
188
|
+
* ```typescript
|
|
189
|
+
* // Create with properties
|
|
190
|
+
* const record = odinClient.bngProvisions.new();
|
|
191
|
+
* await record.createBngProvision({ ... }).execute();
|
|
192
|
+
*
|
|
193
|
+
* // Dry run (for debugging)
|
|
194
|
+
* const payload = record.createBngProvision({ ... }).dryRun();
|
|
195
|
+
* ```
|
|
196
|
+
*/
|
|
197
|
+
createBngProvision(properties?: CreateBngProvisionProperties, options?: {
|
|
198
|
+
type?: string;
|
|
199
|
+
journeyId?: string;
|
|
200
|
+
stageKey?: string;
|
|
201
|
+
}): ActionBuilder;
|
|
202
|
+
}
|
|
203
|
+
/** Type guard to check if an object is a BngProvisionRecord */
|
|
204
|
+
export declare function isBngProvisionRecord(obj: any): obj is BngProvisionRecord;
|
|
205
|
+
export {};
|