@d19n/youfibre-odin-sdk 2.0.374 → 2.0.376

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 (30) hide show
  1. package/README.md +4 -2
  2. package/dist/actions-v2/OrderBuilderCreateContactDto.d.ts +76 -9
  3. package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +9 -16
  4. package/dist/actions-v2/SetContactYouFibreTvInterestDto.d.ts +72 -0
  5. package/dist/actions-v2/SetContactYouFibreTvInterestDto.js +56 -0
  6. package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.d.ts +54 -4
  7. package/dist/actions-v2/UpdateWorkOrderWithdrawEquipmentChargeDto.js +2 -2
  8. package/dist/api-sdk-v2/QaBatchApi.d.ts +2 -0
  9. package/dist/api-sdk-v2/QaBatchApi.js +6 -0
  10. package/dist/api-sdk-v2/QaBatchSummaryApi.d.ts +48 -0
  11. package/dist/api-sdk-v2/QaBatchSummaryApi.js +155 -0
  12. package/dist/db-sdk-v2/QaBatchDb.d.ts +2 -0
  13. package/dist/db-sdk-v2/QaBatchDb.js +6 -0
  14. package/dist/db-sdk-v2/QaBatchSummaryDb.d.ts +120 -0
  15. package/dist/db-sdk-v2/QaBatchSummaryDb.js +204 -0
  16. package/dist/entities-v2/Contact.d.ts +9 -1
  17. package/dist/entities-v2/Contact.js +2 -0
  18. package/dist/entities-v2/Document.d.ts +2 -0
  19. package/dist/entities-v2/Document.js +2 -0
  20. package/dist/entities-v2/QaBatch.d.ts +46 -1
  21. package/dist/entities-v2/QaBatch.js +25 -1
  22. package/dist/entities-v2/QaBatchSummary.d.ts +219 -0
  23. package/dist/entities-v2/QaBatchSummary.js +124 -0
  24. package/dist/entities-v2/VoiceConfiguration.d.ts +130 -130
  25. package/dist/entities-v2/VoiceConfiguration.js +46 -46
  26. package/dist/entities-v2/WorkOrder.d.ts +99 -1
  27. package/dist/entities-v2/WorkOrder.js +2 -0
  28. package/dist/records-v2/ContactRecord.d.ts +28 -0
  29. package/dist/records-v2/ContactRecord.js +37 -0
  30. package/package.json +1 -1
@@ -1701,7 +1701,9 @@ export declare enum WorkOrderPropertyKeys {
1701
1701
  /** The missing devices behind InspectionCharge, counted by kind, same shape as EquipmentChargeBreakdown: {"MESH":1}. {} when everything came back. Kinds that cost nothing (ATA) are left out. */
1702
1702
  InspectionChargeBreakdown = "InspectionChargeBreakdown",
1703
1703
  /** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
1704
- FollowOnOfWorkOrderId = "FollowOnOfWorkOrderId"
1704
+ FollowOnOfWorkOrderId = "FollowOnOfWorkOrderId",
1705
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005). */
1706
+ SendAnotherBag = "SendAnotherBag"
1705
1707
  }
1706
1708
  /**
1707
1709
  * Properties for WorkOrder records
@@ -2532,6 +2534,12 @@ export interface WorkOrderProperties {
2532
2534
  * @default
2533
2535
  */
2534
2536
  FollowOnOfWorkOrderId: string;
2537
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
2538
+ *
2539
+ * @type {BOOLEAN}
2540
+ * @default
2541
+ */
2542
+ SendAnotherBag: boolean;
2535
2543
  }
2536
2544
  /**
2537
2545
  * Properties for COLLECTION WorkOrder records
@@ -3362,6 +3370,12 @@ export interface CollectionWorkOrderProperties {
3362
3370
  * @default
3363
3371
  */
3364
3372
  FollowOnOfWorkOrderId: string;
3373
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
3374
+ *
3375
+ * @type {BOOLEAN}
3376
+ * @default
3377
+ */
3378
+ SendAnotherBag: boolean;
3365
3379
  }
3366
3380
  /**
3367
3381
  * Properties for COLLECTION_AMCO WorkOrder records
@@ -4192,6 +4206,12 @@ export interface CollectionAmcoWorkOrderProperties {
4192
4206
  * @default
4193
4207
  */
4194
4208
  FollowOnOfWorkOrderId: string;
4209
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
4210
+ *
4211
+ * @type {BOOLEAN}
4212
+ * @default
4213
+ */
4214
+ SendAnotherBag: boolean;
4195
4215
  }
4196
4216
  /**
4197
4217
  * Properties for DISPATCH_AMCO WorkOrder records
@@ -5022,6 +5042,12 @@ export interface DispatchAmcoWorkOrderProperties {
5022
5042
  * @default
5023
5043
  */
5024
5044
  FollowOnOfWorkOrderId: string;
5045
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
5046
+ *
5047
+ * @type {BOOLEAN}
5048
+ * @default
5049
+ */
5050
+ SendAnotherBag: boolean;
5025
5051
  }
5026
5052
  /**
5027
5053
  * Properties for FINANCE WorkOrder records
@@ -5852,6 +5878,12 @@ export interface FinanceWorkOrderProperties {
5852
5878
  * @default
5853
5879
  */
5854
5880
  FollowOnOfWorkOrderId: string;
5881
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
5882
+ *
5883
+ * @type {BOOLEAN}
5884
+ * @default
5885
+ */
5886
+ SendAnotherBag: boolean;
5855
5887
  }
5856
5888
  /**
5857
5889
  * Properties for INSPECTION WorkOrder records
@@ -6682,6 +6714,12 @@ export interface InspectionWorkOrderProperties {
6682
6714
  * @default
6683
6715
  */
6684
6716
  FollowOnOfWorkOrderId: string;
6717
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
6718
+ *
6719
+ * @type {BOOLEAN}
6720
+ * @default
6721
+ */
6722
+ SendAnotherBag: boolean;
6685
6723
  }
6686
6724
  /**
6687
6725
  * Properties for INSTALL WorkOrder records
@@ -7512,6 +7550,12 @@ export interface InstallWorkOrderProperties {
7512
7550
  * @default
7513
7551
  */
7514
7552
  FollowOnOfWorkOrderId: string;
7553
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
7554
+ *
7555
+ * @type {BOOLEAN}
7556
+ * @default
7557
+ */
7558
+ SendAnotherBag: boolean;
7515
7559
  }
7516
7560
  /**
7517
7561
  * Properties for INSTALL_BUSINESS WorkOrder records
@@ -8342,6 +8386,12 @@ export interface InstallBusinessWorkOrderProperties {
8342
8386
  * @default
8343
8387
  */
8344
8388
  FollowOnOfWorkOrderId: string;
8389
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
8390
+ *
8391
+ * @type {BOOLEAN}
8392
+ * @default
8393
+ */
8394
+ SendAnotherBag: boolean;
8345
8395
  }
8346
8396
  /**
8347
8397
  * Properties for INSTALL_SERVICE WorkOrder records
@@ -9172,6 +9222,12 @@ export interface InstallServiceWorkOrderProperties {
9172
9222
  * @default
9173
9223
  */
9174
9224
  FollowOnOfWorkOrderId: string;
9225
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
9226
+ *
9227
+ * @type {BOOLEAN}
9228
+ * @default
9229
+ */
9230
+ SendAnotherBag: boolean;
9175
9231
  }
9176
9232
  /**
9177
9233
  * Properties for NETWORK_ADJUSTMENT WorkOrder records
@@ -10002,6 +10058,12 @@ export interface NetworkAdjustmentWorkOrderProperties {
10002
10058
  * @default
10003
10059
  */
10004
10060
  FollowOnOfWorkOrderId: string;
10061
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
10062
+ *
10063
+ * @type {BOOLEAN}
10064
+ * @default
10065
+ */
10066
+ SendAnotherBag: boolean;
10005
10067
  }
10006
10068
  /**
10007
10069
  * Properties for PLANNING WorkOrder records
@@ -10832,6 +10894,12 @@ export interface PlanningWorkOrderProperties {
10832
10894
  * @default
10833
10895
  */
10834
10896
  FollowOnOfWorkOrderId: string;
10897
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
10898
+ *
10899
+ * @type {BOOLEAN}
10900
+ * @default
10901
+ */
10902
+ SendAnotherBag: boolean;
10835
10903
  }
10836
10904
  /**
10837
10905
  * Properties for PRE_PULL WorkOrder records
@@ -11662,6 +11730,12 @@ export interface PrePullWorkOrderProperties {
11662
11730
  * @default
11663
11731
  */
11664
11732
  FollowOnOfWorkOrderId: string;
11733
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
11734
+ *
11735
+ * @type {BOOLEAN}
11736
+ * @default
11737
+ */
11738
+ SendAnotherBag: boolean;
11665
11739
  }
11666
11740
  /**
11667
11741
  * Properties for REMEDIATION WorkOrder records
@@ -12492,6 +12566,12 @@ export interface RemediationWorkOrderProperties {
12492
12566
  * @default
12493
12567
  */
12494
12568
  FollowOnOfWorkOrderId: string;
12569
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
12570
+ *
12571
+ * @type {BOOLEAN}
12572
+ * @default
12573
+ */
12574
+ SendAnotherBag: boolean;
12495
12575
  }
12496
12576
  /**
12497
12577
  * Properties for REPLACEMENT_AMCO WorkOrder records
@@ -13322,6 +13402,12 @@ export interface ReplacementAmcoWorkOrderProperties {
13322
13402
  * @default
13323
13403
  */
13324
13404
  FollowOnOfWorkOrderId: string;
13405
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
13406
+ *
13407
+ * @type {BOOLEAN}
13408
+ * @default
13409
+ */
13410
+ SendAnotherBag: boolean;
13325
13411
  }
13326
13412
  /**
13327
13413
  * Properties for SERVICE WorkOrder records
@@ -14152,6 +14238,12 @@ export interface ServiceWorkOrderProperties {
14152
14238
  * @default
14153
14239
  */
14154
14240
  FollowOnOfWorkOrderId: string;
14241
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
14242
+ *
14243
+ * @type {BOOLEAN}
14244
+ * @default
14245
+ */
14246
+ SendAnotherBag: boolean;
14155
14247
  }
14156
14248
  /**
14157
14249
  * Properties for WAYLEAVE WorkOrder records
@@ -14982,6 +15074,12 @@ export interface WayleaveWorkOrderProperties {
14982
15074
  * @default
14983
15075
  */
14984
15076
  FollowOnOfWorkOrderId: string;
15077
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005).
15078
+ *
15079
+ * @type {BOOLEAN}
15080
+ * @default
15081
+ */
15082
+ SendAnotherBag: boolean;
14985
15083
  }
14986
15084
  /**
14987
15085
  * WorkOrder entity from FieldServiceModule
@@ -1702,6 +1702,8 @@ var WorkOrderPropertyKeys;
1702
1702
  WorkOrderPropertyKeys["InspectionChargeBreakdown"] = "InspectionChargeBreakdown";
1703
1703
  /** On a follow-on COLLECTION_AMCO (a second bag for a partial return): the id of the collection whose missing devices it collects. Set from that collection by CreateCollectionAmcoFollowOnWorkOrder. Null on every other work order */
1704
1704
  WorkOrderPropertyKeys["FollowOnOfWorkOrderId"] = "FollowOnOfWorkOrderId";
1705
+ /** Set by the "Withdraw equipment charge" form. When the collection is cancelled, field-service raises a new collection, to the alternative address when one is given (BILL-1005). */
1706
+ WorkOrderPropertyKeys["SendAnotherBag"] = "SendAnotherBag";
1705
1707
  })(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
1706
1708
  /**
1707
1709
  * WorkOrder entity from FieldServiceModule
@@ -26,6 +26,7 @@ import { CreateContactProperties } from '../actions-v2/CreateContactDto';
26
26
  import { CreateContactSalesAppProperties } from '../actions-v2/CreateContactSalesAppDto';
27
27
  import { OrderBuilderCreateContactProperties } from '../actions-v2/OrderBuilderCreateContactDto';
28
28
  import { OrderBuilderUpdateContactProperties } from '../actions-v2/OrderBuilderUpdateContactDto';
29
+ import { SetContactYouFibreTvInterestProperties } from '../actions-v2/SetContactYouFibreTvInterestDto';
29
30
  import { UpdateAdditionalCareProperties } from '../actions-v2/UpdateAdditionalCareDto';
30
31
  import { UpdateContactAppPreferencesProperties } from '../actions-v2/UpdateContactAppPreferencesDto';
31
32
  import { UpdateContactProperties } from '../actions-v2/UpdateContactDto';
@@ -895,6 +896,33 @@ export declare class ContactRecord<TProps = ContactProperties> {
895
896
  journeyId?: string;
896
897
  stageKey?: string;
897
898
  }): ActionBuilder;
899
+ /**
900
+ * SetContactYouFibreTvInterest
901
+ *
902
+ * Updates this Contact record.
903
+ * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
904
+ *
905
+ * @param propertiesOrOptions - Properties to update, or options object
906
+ * @param options - Optional settings (journeyId, stageKey)
907
+ * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
908
+ * @throws Error if called on a new (unsaved) record
909
+ *
910
+ * @example
911
+ * ```typescript
912
+ * const record = await odinClient.contacts.get(id);
913
+ * await record.setContactYouFibreTvInterest({ ... }).execute();
914
+ *
915
+ * // Dry run (for debugging)
916
+ * const payload = record.setContactYouFibreTvInterest({ ... }).dryRun();
917
+ * ```
918
+ */
919
+ setContactYouFibreTvInterest(propertiesOrOptions?: SetContactYouFibreTvInterestProperties | {
920
+ journeyId?: string;
921
+ stageKey?: string;
922
+ }, options?: {
923
+ journeyId?: string;
924
+ stageKey?: string;
925
+ }): ActionBuilder;
898
926
  /**
899
927
  * UpdateAdditionalCare
900
928
  *
@@ -1313,6 +1313,43 @@ class ContactRecord {
1313
1313
  const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'OrderBuilderUpdateContact', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
1314
1314
  return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
1315
1315
  }
1316
+ /**
1317
+ * SetContactYouFibreTvInterest
1318
+ *
1319
+ * Updates this Contact record.
1320
+ * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
1321
+ *
1322
+ * @param propertiesOrOptions - Properties to update, or options object
1323
+ * @param options - Optional settings (journeyId, stageKey)
1324
+ * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
1325
+ * @throws Error if called on a new (unsaved) record
1326
+ *
1327
+ * @example
1328
+ * ```typescript
1329
+ * const record = await odinClient.contacts.get(id);
1330
+ * await record.setContactYouFibreTvInterest({ ... }).execute();
1331
+ *
1332
+ * // Dry run (for debugging)
1333
+ * const payload = record.setContactYouFibreTvInterest({ ... }).dryRun();
1334
+ * ```
1335
+ */
1336
+ setContactYouFibreTvInterest(propertiesOrOptions, options) {
1337
+ var _a;
1338
+ if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
1339
+ throw new Error('setContactYouFibreTvInterest requires an existing record. Use accessor.get() first.');
1340
+ let properties = {};
1341
+ let opts = options;
1342
+ if (propertiesOrOptions) {
1343
+ if ('journeyId' in propertiesOrOptions || 'stageKey' in propertiesOrOptions) {
1344
+ opts = propertiesOrOptions;
1345
+ }
1346
+ else {
1347
+ properties = propertiesOrOptions;
1348
+ }
1349
+ }
1350
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'SetContactYouFibreTvInterest', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, opts);
1351
+ return new ActionBuilder(this._provider, 'CrmModule', 'Contact', payload, () => { this._pendingLinks = []; });
1352
+ }
1316
1353
  /**
1317
1354
  * UpdateAdditionalCare
1318
1355
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.374",
3
+ "version": "2.0.376",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",