@d19n/youfibre-odin-sdk 2.0.305 → 2.0.307

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 (41) hide show
  1. package/README.md +10 -9
  2. package/dist/actions-v2/CollectCustomerDeviceRouterDto.d.ts +63 -0
  3. package/dist/actions-v2/CollectCustomerDeviceRouterDto.js +56 -0
  4. package/dist/actions-v2/CompleteServiceWorkOrderFlowDto.d.ts +135 -96
  5. package/dist/api-sdk-v2/PaymentMethodRefundApi.d.ts +2 -2
  6. package/dist/api-sdk-v2/PaymentMethodRefundApi.js +6 -6
  7. package/dist/api-sdk-v2/UserApi.d.ts +2 -0
  8. package/dist/api-sdk-v2/UserApi.js +6 -0
  9. package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.d.ts +2 -0
  10. package/dist/api-sdk-v2/YfFieldVisitOutcomeFormApi.js +6 -0
  11. package/dist/db-sdk-v2/PaymentMethodRefundDb.d.ts +2 -2
  12. package/dist/db-sdk-v2/PaymentMethodRefundDb.js +6 -6
  13. package/dist/db-sdk-v2/UserDb.d.ts +2 -0
  14. package/dist/db-sdk-v2/UserDb.js +6 -0
  15. package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.d.ts +2 -0
  16. package/dist/db-sdk-v2/YfFieldVisitOutcomeFormDb.js +6 -0
  17. package/dist/entities-v2/BillingAdjustment.d.ts +1 -3
  18. package/dist/entities-v2/BillingAdjustment.js +1 -3
  19. package/dist/entities-v2/Case.d.ts +2 -1
  20. package/dist/entities-v2/Case.js +2 -1
  21. package/dist/entities-v2/CreditNote.d.ts +1 -2
  22. package/dist/entities-v2/CreditNote.js +1 -2
  23. package/dist/entities-v2/PaymentMethodRefund.d.ts +3 -3
  24. package/dist/entities-v2/PgReportEvent.d.ts +5 -1
  25. package/dist/entities-v2/PgReportEvent.js +4 -0
  26. package/dist/entities-v2/User.d.ts +3 -0
  27. package/dist/entities-v2/VoiceConfiguration.d.ts +8 -0
  28. package/dist/entities-v2/VoiceConfiguration.js +2 -0
  29. package/dist/entities-v2/YfFieldVisitOutcomeForm.d.ts +149 -80
  30. package/dist/entities-v2/YfFieldVisitOutcomeForm.js +37 -31
  31. package/dist/records-v2/CustomerDeviceRouterRecord.d.ts +28 -0
  32. package/dist/records-v2/CustomerDeviceRouterRecord.js +37 -0
  33. package/dist/records-v2/PaymentMethodRefundRecord.d.ts +20 -20
  34. package/dist/records-v2/PaymentMethodRefundRecord.js +33 -33
  35. package/dist/records-v2/UserRecord.d.ts +20 -0
  36. package/dist/records-v2/UserRecord.js +33 -0
  37. package/dist/records-v2/YfFieldVisitOutcomeFormRecord.d.ts +22 -18
  38. package/dist/records-v2/YfFieldVisitOutcomeFormRecord.js +34 -17
  39. package/dist/records-v2/index.d.ts +1 -1
  40. package/dist/records-v2/index.js +5 -5
  41. package/package.json +1 -1
@@ -224,6 +224,12 @@ class UserDb extends db_provider_1.DbProvider {
224
224
  }
225
225
  return this._agentstatushistory;
226
226
  }
227
+ get yffieldvisitoutcomeform() {
228
+ if (!this._yffieldvisitoutcomeform) {
229
+ this._yffieldvisitoutcomeform = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'IdentityModule:User', 'FieldServiceModule:YfFieldVisitOutcomeForm', 'YfFieldVisitOutcomeForm__User');
230
+ }
231
+ return this._yffieldvisitoutcomeform;
232
+ }
227
233
  // ============================================
228
234
  // STANDARD METHODS
229
235
  // ============================================
@@ -25,11 +25,13 @@ export declare class YfFieldVisitOutcomeFormDb extends DbProvider {
25
25
  private _address?;
26
26
  private _note?;
27
27
  private _file?;
28
+ private _user?;
28
29
  constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
29
30
  get workorder(): DbRecordLinkManager;
30
31
  get address(): DbRecordLinkManager;
31
32
  get note(): DbRecordLinkManager;
32
33
  get file(): DbRecordLinkManager;
34
+ get user(): DbRecordLinkManager;
33
35
  setRecord(sourceRecord: any): void;
34
36
  /**
35
37
  * Search records with manual pagination control
@@ -62,6 +62,12 @@ class YfFieldVisitOutcomeFormDb extends db_provider_1.DbProvider {
62
62
  }
63
63
  return this._file;
64
64
  }
65
+ get user() {
66
+ if (!this._user) {
67
+ this._user = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'FieldServiceModule:YfFieldVisitOutcomeForm', 'IdentityModule:User', 'YfFieldVisitOutcomeForm__User');
68
+ }
69
+ return this._user;
70
+ }
65
71
  // ============================================
66
72
  // STANDARD METHODS
67
73
  // ============================================
@@ -63,13 +63,12 @@ export declare enum BillingAdjustmentProrationType {
63
63
  * - `GOODWILL_GESTURE` - Goodwill Gesture
64
64
  * - `OUTAGE_COMPENSATION` - Outage Compensation
65
65
  * - `PAYMENT_ARRANGEMENT` - Payment Arrangement
66
- * - `PAYMENT_PLAN` - Payment Plan
67
66
  * - `PRICE_MATCH_ADJUSTMENT` - Price Match Adjustment
68
67
  * - `PRICE_MATCH_DEAL` - Price Match Deal
69
68
  * - `RECONTRACTING_ADJUSTMENT` - Recontracting Adjustment
70
69
  * - `REFERRAL` - Referral
71
70
  * - `RETENTION_DEAL` - Retention Deal
72
- * - ... and 1 more
71
+ * - `SALES_MISSELLING_ADJUSTMENT` - Sales Misselling Adjustment
73
72
  */
74
73
  export declare enum BillingAdjustmentReason {
75
74
  BILLING_DATE_CHANGE = "BILLING_DATE_CHANGE",
@@ -81,7 +80,6 @@ export declare enum BillingAdjustmentReason {
81
80
  GOODWILL_GESTURE = "GOODWILL_GESTURE",
82
81
  OUTAGE_COMPENSATION = "OUTAGE_COMPENSATION",
83
82
  PAYMENT_ARRANGEMENT = "PAYMENT_ARRANGEMENT",
84
- PAYMENT_PLAN = "PAYMENT_PLAN",
85
83
  PRICE_MATCH_ADJUSTMENT = "PRICE_MATCH_ADJUSTMENT",
86
84
  PRICE_MATCH_DEAL = "PRICE_MATCH_DEAL",
87
85
  RECONTRACTING_ADJUSTMENT = "RECONTRACTING_ADJUSTMENT",
@@ -65,13 +65,12 @@ var BillingAdjustmentProrationType;
65
65
  * - `GOODWILL_GESTURE` - Goodwill Gesture
66
66
  * - `OUTAGE_COMPENSATION` - Outage Compensation
67
67
  * - `PAYMENT_ARRANGEMENT` - Payment Arrangement
68
- * - `PAYMENT_PLAN` - Payment Plan
69
68
  * - `PRICE_MATCH_ADJUSTMENT` - Price Match Adjustment
70
69
  * - `PRICE_MATCH_DEAL` - Price Match Deal
71
70
  * - `RECONTRACTING_ADJUSTMENT` - Recontracting Adjustment
72
71
  * - `REFERRAL` - Referral
73
72
  * - `RETENTION_DEAL` - Retention Deal
74
- * - ... and 1 more
73
+ * - `SALES_MISSELLING_ADJUSTMENT` - Sales Misselling Adjustment
75
74
  */
76
75
  var BillingAdjustmentReason;
77
76
  (function (BillingAdjustmentReason) {
@@ -84,7 +83,6 @@ var BillingAdjustmentReason;
84
83
  BillingAdjustmentReason["GOODWILL_GESTURE"] = "GOODWILL_GESTURE";
85
84
  BillingAdjustmentReason["OUTAGE_COMPENSATION"] = "OUTAGE_COMPENSATION";
86
85
  BillingAdjustmentReason["PAYMENT_ARRANGEMENT"] = "PAYMENT_ARRANGEMENT";
87
- BillingAdjustmentReason["PAYMENT_PLAN"] = "PAYMENT_PLAN";
88
86
  BillingAdjustmentReason["PRICE_MATCH_ADJUSTMENT"] = "PRICE_MATCH_ADJUSTMENT";
89
87
  BillingAdjustmentReason["PRICE_MATCH_DEAL"] = "PRICE_MATCH_DEAL";
90
88
  BillingAdjustmentReason["RECONTRACTING_ADJUSTMENT"] = "RECONTRACTING_ADJUSTMENT";
@@ -428,7 +428,7 @@ export declare enum CaseCategory {
428
428
  * - `COPY_OF_INVOICE` - Copy of Invoice
429
429
  * - `CUSTOMER_DEVICE_ISSUE` - Customer Device Issue
430
430
  * - `DATA_SUBJECT_ACCESS_REQUEST` - Data Subject Access Request
431
- * - ... and 40 more
431
+ * - ... and 41 more
432
432
  */
433
433
  export declare enum CaseSubCategory {
434
434
  AMEND_BILLING_DATE = "AMEND_BILLING_DATE",
@@ -476,6 +476,7 @@ export declare enum CaseSubCategory {
476
476
  POSITIVE_REVIEWS = "POSITIVE_REVIEWS",
477
477
  PRE_LIVE_ORDER_QUERY = "PRE_LIVE_ORDER_QUERY",
478
478
  PRICE_MATCH = "PRICE_MATCH",
479
+ RECONTRACT_ROUTER_DISPATCH = "RECONTRACT_ROUTER_DISPATCH",
479
480
  RECONTRACT_UPGRADE = "RECONTRACT_UPGRADE",
480
481
  REFERRAL = "REFERRAL",
481
482
  SERVICE_VISIT = "SERVICE_VISIT",
@@ -425,7 +425,7 @@ var CaseCategory;
425
425
  * - `COPY_OF_INVOICE` - Copy of Invoice
426
426
  * - `CUSTOMER_DEVICE_ISSUE` - Customer Device Issue
427
427
  * - `DATA_SUBJECT_ACCESS_REQUEST` - Data Subject Access Request
428
- * - ... and 40 more
428
+ * - ... and 41 more
429
429
  */
430
430
  var CaseSubCategory;
431
431
  (function (CaseSubCategory) {
@@ -474,6 +474,7 @@ var CaseSubCategory;
474
474
  CaseSubCategory["POSITIVE_REVIEWS"] = "POSITIVE_REVIEWS";
475
475
  CaseSubCategory["PRE_LIVE_ORDER_QUERY"] = "PRE_LIVE_ORDER_QUERY";
476
476
  CaseSubCategory["PRICE_MATCH"] = "PRICE_MATCH";
477
+ CaseSubCategory["RECONTRACT_ROUTER_DISPATCH"] = "RECONTRACT_ROUTER_DISPATCH";
477
478
  CaseSubCategory["RECONTRACT_UPGRADE"] = "RECONTRACT_UPGRADE";
478
479
  CaseSubCategory["REFERRAL"] = "REFERRAL";
479
480
  CaseSubCategory["SERVICE_VISIT"] = "SERVICE_VISIT";
@@ -43,7 +43,7 @@ export declare enum CreditNoteEntityTypes {
43
43
  * - `OTS_ORDER_CANCELLATION` - OTS Order Cancellation
44
44
  * - `PAYMENT_ARRANGEMENT` - Payment Arrangement
45
45
  * - `PAYMENT_ERROR` - Payment Error
46
- * - ... and 6 more
46
+ * - ... and 5 more
47
47
  */
48
48
  export declare enum CreditNoteReason {
49
49
  BAD_DEBT_WRITE_OFF = "BAD_DEBT_WRITE_OFF",
@@ -61,7 +61,6 @@ export declare enum CreditNoteReason {
61
61
  OTS_ORDER_CANCELLATION = "OTS_ORDER_CANCELLATION",
62
62
  PAYMENT_ARRANGEMENT = "PAYMENT_ARRANGEMENT",
63
63
  PAYMENT_ERROR = "PAYMENT_ERROR",
64
- PAYMENT_PLAN = "PAYMENT_PLAN",
65
64
  REFERRAL_REWARD = "REFERRAL_REWARD",
66
65
  RETENTION = "RETENTION",
67
66
  SALES_MIS_SOLD = "SALES_MISSOLD",
@@ -43,7 +43,7 @@ var CreditNoteEntityTypes;
43
43
  * - `OTS_ORDER_CANCELLATION` - OTS Order Cancellation
44
44
  * - `PAYMENT_ARRANGEMENT` - Payment Arrangement
45
45
  * - `PAYMENT_ERROR` - Payment Error
46
- * - ... and 6 more
46
+ * - ... and 5 more
47
47
  */
48
48
  var CreditNoteReason;
49
49
  (function (CreditNoteReason) {
@@ -62,7 +62,6 @@ var CreditNoteReason;
62
62
  CreditNoteReason["OTS_ORDER_CANCELLATION"] = "OTS_ORDER_CANCELLATION";
63
63
  CreditNoteReason["PAYMENT_ARRANGEMENT"] = "PAYMENT_ARRANGEMENT";
64
64
  CreditNoteReason["PAYMENT_ERROR"] = "PAYMENT_ERROR";
65
- CreditNoteReason["PAYMENT_PLAN"] = "PAYMENT_PLAN";
66
65
  CreditNoteReason["REFERRAL_REWARD"] = "REFERRAL_REWARD";
67
66
  CreditNoteReason["RETENTION"] = "RETENTION";
68
67
  CreditNoteReason["SALES_MIS_SOLD"] = "SALES_MISSOLD";
@@ -20,8 +20,8 @@ import { ContactProperties } from './Contact';
20
20
  import { WorkOrderProperties } from './WorkOrder';
21
21
  import { InvoiceProperties } from './Invoice';
22
22
  import { ActivityProperties } from './Activity';
23
- import { TransactionProperties } from './Transaction';
24
23
  import { ContractBuyOutProperties } from './ContractBuyOut';
24
+ import { TransactionProperties } from './Transaction';
25
25
  /**
26
26
  * Available types for PaymentMethodRefund records
27
27
  */
@@ -221,10 +221,10 @@ export declare class PaymentMethodRefund extends OdinRecord<PaymentMethodRefundP
221
221
  Invoice: OdinLink<LinkedOdinRecord<InvoiceProperties>>;
222
222
  /** Linked Activity records (PaymentMethodRefund__Activity) */
223
223
  Activity: OdinLink<LinkedOdinRecord<ActivityProperties>>;
224
- /** Linked Transaction records (PaymentMethodRefund__Transaction) */
225
- Transaction: OdinLink<LinkedOdinRecord<TransactionProperties>>;
226
224
  /** Linked ContractBuyOut records (ContractBuyOut__PaymentMethodRefund) */
227
225
  ContractBuyOut: OdinLink<LinkedOdinRecord<ContractBuyOutProperties>>;
226
+ /** Linked Transaction records (PaymentMethodRefund__Transaction) */
227
+ Transaction: OdinLink<LinkedOdinRecord<TransactionProperties>>;
228
228
  }
229
229
  /**
230
230
  * RabbitMQ routing keys for PaymentMethodRefund events
@@ -57,17 +57,21 @@ export declare enum DefaultPgReportEventStageKeys {
57
57
  *
58
58
  * @remarks Available options:
59
59
  * - `ADDACS`
60
+ * - `ARUCS`
60
61
  * - `ARUDD`
61
62
  * - `AUDDIS_ADVICE` - AUDDIS Advice Report
62
63
  * - `AUDDIS_ACCEPTANCE` - AUDDIS File Acceptance Report
63
64
  * - `AUDDIS_INPUT` - AUDDIS Input Report
65
+ * - `INPUT` - PE Input Report
64
66
  */
65
67
  export declare enum PgReportEventReportType {
66
68
  ADDACS = "ADDACS",
69
+ ARUCS = "ARUCS",
67
70
  ARUDD = "ARUDD",
68
71
  AUDDIS_ADVICE_REPORT = "AUDDIS_ADVICE",
69
72
  AUDDIS_FILE_ACCEPTANCE_REPORT = "AUDDIS_ACCEPTANCE",
70
- AUDDIS_INPUT_REPORT = "AUDDIS_INPUT"
73
+ AUDDIS_INPUT_REPORT = "AUDDIS_INPUT",
74
+ PE_INPUT_REPORT = "INPUT"
71
75
  }
72
76
  /**
73
77
  * Property keys for PgReportEvent
@@ -60,18 +60,22 @@ var DefaultPgReportEventStageKeys;
60
60
  *
61
61
  * @remarks Available options:
62
62
  * - `ADDACS`
63
+ * - `ARUCS`
63
64
  * - `ARUDD`
64
65
  * - `AUDDIS_ADVICE` - AUDDIS Advice Report
65
66
  * - `AUDDIS_ACCEPTANCE` - AUDDIS File Acceptance Report
66
67
  * - `AUDDIS_INPUT` - AUDDIS Input Report
68
+ * - `INPUT` - PE Input Report
67
69
  */
68
70
  var PgReportEventReportType;
69
71
  (function (PgReportEventReportType) {
70
72
  PgReportEventReportType["ADDACS"] = "ADDACS";
73
+ PgReportEventReportType["ARUCS"] = "ARUCS";
71
74
  PgReportEventReportType["ARUDD"] = "ARUDD";
72
75
  PgReportEventReportType["AUDDIS_ADVICE_REPORT"] = "AUDDIS_ADVICE";
73
76
  PgReportEventReportType["AUDDIS_FILE_ACCEPTANCE_REPORT"] = "AUDDIS_ACCEPTANCE";
74
77
  PgReportEventReportType["AUDDIS_INPUT_REPORT"] = "AUDDIS_INPUT";
78
+ PgReportEventReportType["PE_INPUT_REPORT"] = "INPUT";
75
79
  })(PgReportEventReportType = exports.PgReportEventReportType || (exports.PgReportEventReportType = {}));
76
80
  /**
77
81
  * Property keys for PgReportEvent
@@ -36,6 +36,7 @@ import { OutboundDialCampaignProperties } from './OutboundDialCampaign';
36
36
  import { OutboundDialSessionProperties } from './OutboundDialSession';
37
37
  import { AgentStatusProperties } from './AgentStatus';
38
38
  import { AgentStatusHistoryProperties } from './AgentStatusHistory';
39
+ import { YfFieldVisitOutcomeFormProperties } from './YfFieldVisitOutcomeForm';
39
40
  /**
40
41
  * Available types for User records
41
42
  */
@@ -285,6 +286,8 @@ export declare class User extends OdinRecord<UserProperties> {
285
286
  AgentStatus: OdinLink<LinkedOdinRecord<AgentStatusProperties>>;
286
287
  /** Linked AgentStatusHistory records (AgentStatusHistory__User) */
287
288
  AgentStatusHistory: OdinLink<LinkedOdinRecord<AgentStatusHistoryProperties>>;
289
+ /** Linked YfFieldVisitOutcomeForm records (YfFieldVisitOutcomeForm__User) */
290
+ YfFieldVisitOutcomeForm: OdinLink<LinkedOdinRecord<YfFieldVisitOutcomeFormProperties>>;
288
291
  }
289
292
  /**
290
293
  * RabbitMQ routing keys for User events
@@ -130,6 +130,8 @@ export declare enum VoiceConfigurationPortFromProvider {
130
130
  * Use these constants instead of string literals for type safety
131
131
  */
132
132
  export declare enum VoiceConfigurationPropertyKeys {
133
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
134
+ PortingUpdateEmailSentAt = "PortingUpdateEmailSentAt",
133
135
  /** ExternalReference */
134
136
  ExternalReference = "ExternalReference",
135
137
  /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */
@@ -193,6 +195,12 @@ export declare enum VoiceConfigurationPropertyKeys {
193
195
  * @see ServiceModule:VoiceConfiguration
194
196
  */
195
197
  export interface VoiceConfigurationProperties {
198
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends.
199
+ *
200
+ * @type {DATE_TIME}
201
+ * @default
202
+ */
203
+ PortingUpdateEmailSentAt: string;
196
204
  /** ExternalReference
197
205
  *
198
206
  * @type {TEXT}
@@ -135,6 +135,8 @@ var VoiceConfigurationPortFromProvider;
135
135
  */
136
136
  var VoiceConfigurationPropertyKeys;
137
137
  (function (VoiceConfigurationPropertyKeys) {
138
+ /** When the Magrathea "port accepted" customer email was sent for this port. Checked before sending and stamped after -- the redelivery-dedup guard for an at-least-once RabbitMQ consumer whose only prior guard (prevStatus !== nextStatus) was built from message-carried fields and so could not survive a redelivery. Scoped per port (this VoiceConfiguration record), not per contact, so a genuine second port for the same customer still sends. */
139
+ VoiceConfigurationPropertyKeys["PortingUpdateEmailSentAt"] = "PortingUpdateEmailSentAt";
138
140
  /** ExternalReference */
139
141
  VoiceConfigurationPropertyKeys["ExternalReference"] = "ExternalReference";
140
142
  /** MagratheaOrderLastUpdate (Network Operations - VoiceConfiguration) */