@d19n/youfibre-odin-sdk 2.0.370 → 2.0.372

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 (54) hide show
  1. package/README.md +7 -3
  2. package/dist/actions-v2/CreateNoteForCaseSalesAppDto.d.ts +73 -0
  3. package/dist/actions-v2/CreateNoteForCaseSalesAppDto.js +59 -0
  4. package/dist/actions-v2/CreateOutboundDialCampaignDto.d.ts +8 -1
  5. package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.d.ts +171 -0
  6. package/dist/actions-v2/MoveCaseToSolvedWithNoteSalesAppDto.js +124 -0
  7. package/dist/actions-v2/OrderBuilderUpdateContactDto.d.ts +182 -0
  8. package/dist/actions-v2/OrderBuilderUpdateContactDto.js +56 -0
  9. package/dist/actions-v2/UpdateOutboundDialCampaignCaseDto.d.ts +15 -1
  10. package/dist/actions-v2/UpdateOutboundDialCampaignCaseOnDialEndDto.d.ts +15 -1
  11. package/dist/actions-v2/UpdateoutbounddialcampaignDto.d.ts +8 -1
  12. package/dist/api-sdk-v2/QaBatchApi.d.ts +48 -0
  13. package/dist/api-sdk-v2/QaBatchApi.js +155 -0
  14. package/dist/api-sdk-v2/QaReportApi.d.ts +2 -0
  15. package/dist/api-sdk-v2/QaReportApi.js +6 -0
  16. package/dist/db-sdk-v2/QaBatchDb.d.ts +120 -0
  17. package/dist/db-sdk-v2/QaBatchDb.js +204 -0
  18. package/dist/db-sdk-v2/QaReportDb.d.ts +2 -0
  19. package/dist/db-sdk-v2/QaReportDb.js +6 -0
  20. package/dist/entities-v2/AiRouteRequest.d.ts +2 -0
  21. package/dist/entities-v2/AiRouteRequest.js +2 -0
  22. package/dist/entities-v2/Document.d.ts +821 -12
  23. package/dist/entities-v2/Document.js +63 -1
  24. package/dist/entities-v2/DocumentProcessing.d.ts +7 -1
  25. package/dist/entities-v2/DocumentProcessing.js +6 -0
  26. package/dist/entities-v2/EquipmentReturnItem.d.ts +6 -6
  27. package/dist/entities-v2/EquipmentReturnItem.js +6 -6
  28. package/dist/entities-v2/HomeMove.d.ts +23 -1
  29. package/dist/entities-v2/HomeMove.js +17 -1
  30. package/dist/entities-v2/Note.d.ts +9 -9
  31. package/dist/entities-v2/Note.js +2 -2
  32. package/dist/entities-v2/Order.d.ts +9 -1
  33. package/dist/entities-v2/Order.js +2 -0
  34. package/dist/entities-v2/OutboundDialCampaign.d.ts +9 -1
  35. package/dist/entities-v2/OutboundDialCampaign.js +2 -0
  36. package/dist/entities-v2/OutboundDialCampaignCase.d.ts +17 -1
  37. package/dist/entities-v2/OutboundDialCampaignCase.js +4 -0
  38. package/dist/entities-v2/QaBatch.d.ts +235 -0
  39. package/dist/entities-v2/QaBatch.js +122 -0
  40. package/dist/entities-v2/QaReport.d.ts +12 -1
  41. package/dist/entities-v2/QaReport.js +2 -0
  42. package/dist/entities-v2/Recontract.d.ts +17 -1
  43. package/dist/entities-v2/Recontract.js +4 -0
  44. package/dist/entities-v2/Returns.d.ts +30 -30
  45. package/dist/entities-v2/Returns.js +30 -30
  46. package/dist/records-v2/CaseRecord.d.ts +87 -0
  47. package/dist/records-v2/CaseRecord.js +133 -1
  48. package/dist/records-v2/ContactRecord.d.ts +27 -0
  49. package/dist/records-v2/ContactRecord.js +29 -0
  50. package/dist/records-v2/DocumentRecord.d.ts +35 -3
  51. package/dist/records-v2/DocumentRecord.js +33 -1
  52. package/dist/records-v2/NoteRecord.d.ts +29 -0
  53. package/dist/records-v2/NoteRecord.js +36 -0
  54. package/package.json +1 -1
@@ -12,15 +12,19 @@
12
12
  * Generated from Odin schema definition
13
13
  */
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_CREATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_UPDATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_DOCUMENT_OTHER_DELETED = exports.ROUTING_KEY_DOCUMENT_OTHER_UPDATED = exports.ROUTING_KEY_DOCUMENT_OTHER_CREATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_DELETED = exports.ROUTING_KEY_DOCUMENT_INVOICE_UPDATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_CREATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = exports.ROUTING_KEY_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CREATED = exports.Document = exports.DocumentPropertyKeys = exports.DocumentCatalogStatus = exports.DocumentSubmittedVia = exports.DocumentFormat = exports.DocumentEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_DOCUMENT_PROCESSING_CREATED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_DELETED = exports.ROUTING_KEY_LINK_DOCUMENT_FILE_CREATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_DELETED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_UPDATED = exports.ROUTING_KEY_DOCUMENT_OUTCOME_FORM_CREATED = exports.ROUTING_KEY_DOCUMENT_OTHER_DELETED = exports.ROUTING_KEY_DOCUMENT_OTHER_UPDATED = exports.ROUTING_KEY_DOCUMENT_OTHER_CREATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_DELETED = exports.ROUTING_KEY_DOCUMENT_INVOICE_UPDATED = exports.ROUTING_KEY_DOCUMENT_INVOICE_CREATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_EMAIL_ATTACHMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_DELETED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_UPDATED = exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CONTRACT_CREATED = exports.ROUTING_KEY_DOCUMENT_DELETED = exports.ROUTING_KEY_DOCUMENT_UPDATED = exports.ROUTING_KEY_DOCUMENT_CREATED = exports.Document = exports.DocumentPropertyKeys = exports.DocumentFieldsReviewState = exports.DocumentCatalogStatus = exports.DocumentSubmittedVia = exports.DocumentFormat = exports.DocumentEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for Document records
19
19
  */
20
20
  var DocumentEntityTypes;
21
21
  (function (DocumentEntityTypes) {
22
+ /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. */
23
+ DocumentEntityTypes["CONTRACT"] = "CONTRACT";
22
24
  /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). */
23
25
  DocumentEntityTypes["CONTRACT_BUYOUT"] = "CONTRACT_BUYOUT";
26
+ /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. */
27
+ DocumentEntityTypes["CORPORATE_DOCUMENT"] = "CORPORATE_DOCUMENT";
24
28
  /** This is the default record type */
25
29
  DocumentEntityTypes["DEFAULT"] = "DEFAULT";
26
30
  /** A file attached to an inbound or outbound email. */
@@ -81,17 +85,45 @@ var DocumentSubmittedVia;
81
85
  *
82
86
  * @remarks Available options:
83
87
  * - `CATALOGUED` - Catalogued
88
+ * - `DELETED` - Deleted
84
89
  * - `DESCRIBED` - Described
85
90
  * - `DESCRIBE_FAILED` - Describe failed
86
91
  * - `DESCRIBE_PENDING` - Describe pending
92
+ * - `EMBEDDED` - Embedded
93
+ * - `EMBED_FAILED` - Embed failed
94
+ * - `READ` - Read
95
+ * - `READ_FAILED` - Read failed
96
+ * - `READY` - Ready
87
97
  */
88
98
  var DocumentCatalogStatus;
89
99
  (function (DocumentCatalogStatus) {
90
100
  DocumentCatalogStatus["CATALOGUED"] = "CATALOGUED";
101
+ DocumentCatalogStatus["DELETED"] = "DELETED";
91
102
  DocumentCatalogStatus["DESCRIBED"] = "DESCRIBED";
92
103
  DocumentCatalogStatus["DESCRIBE_FAILED"] = "DESCRIBE_FAILED";
93
104
  DocumentCatalogStatus["DESCRIBE_PENDING"] = "DESCRIBE_PENDING";
105
+ DocumentCatalogStatus["EMBEDDED"] = "EMBEDDED";
106
+ DocumentCatalogStatus["EMBED_FAILED"] = "EMBED_FAILED";
107
+ DocumentCatalogStatus["READ"] = "READ";
108
+ DocumentCatalogStatus["READ_FAILED"] = "READ_FAILED";
109
+ DocumentCatalogStatus["READY"] = "READY";
94
110
  })(DocumentCatalogStatus = exports.DocumentCatalogStatus || (exports.DocumentCatalogStatus = {}));
111
+ /**
112
+ * Valid values for Document.FieldsReviewState
113
+ *
114
+ * Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed.
115
+ *
116
+ * @remarks Available options:
117
+ * - `CONFIRMED` - Confirmed
118
+ * - `NEEDS_REVIEW` - Needs review
119
+ * - `NOT_EXTRACTED` - Not extracted
120
+ */
121
+ var DocumentFieldsReviewState;
122
+ (function (DocumentFieldsReviewState) {
123
+ DocumentFieldsReviewState["CONFIRMED"] = "CONFIRMED";
124
+ DocumentFieldsReviewState["NEEDS_REVIEW"] = "NEEDS_REVIEW";
125
+ DocumentFieldsReviewState["NOT_EXTRACTED"] = "NOT_EXTRACTED";
126
+ })(DocumentFieldsReviewState = exports.DocumentFieldsReviewState || (exports.DocumentFieldsReviewState = {}));
95
127
  /**
96
128
  * Property keys for Document
97
129
  * Use these constants instead of string literals for type safety
@@ -146,6 +178,24 @@ var DocumentPropertyKeys;
146
178
  DocumentPropertyKeys["LastProcessedAt"] = "LastProcessedAt";
147
179
  /** Id of the most recent DocumentProcessing row. */
148
180
  DocumentPropertyKeys["LastProcessingId"] = "LastProcessingId";
181
+ /** True for an unfilled template, false for a signed or filled copy. Chosen by the uploader; drives the blanks report. */
182
+ DocumentPropertyKeys["IsTemplate"] = "IsTemplate";
183
+ /** The parties as the document names them, separated by " and ". A blank in a template is left blank. */
184
+ DocumentPropertyKeys["Parties"] = "Parties";
185
+ /** The party that is not us. Blank in a template. */
186
+ DocumentPropertyKeys["Counterparty"] = "Counterparty";
187
+ /** The date the document is dated or was adopted. Blank in a template. */
188
+ DocumentPropertyKeys["DocumentDate"] = "DocumentDate";
189
+ /** The term or confidentiality period in months, when the document states one. */
190
+ DocumentPropertyKeys["TermMonths"] = "TermMonths";
191
+ /** The governing law as the document names it, e.g. England and Wales. */
192
+ DocumentPropertyKeys["GoverningLaw"] = "GoverningLaw";
193
+ /** Where the extracted key terms stand: not extracted yet, some still need a person, or all confirmed. */
194
+ DocumentPropertyKeys["FieldsReviewState"] = "FieldsReviewState";
195
+ /** The document's folder in the org files bucket (document-intelligence/<documentId>/), holding sections, fields, vectors and chat history. */
196
+ DocumentPropertyKeys["FolderKey"] = "FolderKey";
197
+ /** How many sections the read step produced; equals the number of vectors. */
198
+ DocumentPropertyKeys["SectionCount"] = "SectionCount";
149
199
  })(DocumentPropertyKeys = exports.DocumentPropertyKeys || (exports.DocumentPropertyKeys = {}));
150
200
  /**
151
201
  * Document entity from AiModule
@@ -174,12 +224,24 @@ exports.ROUTING_KEY_DOCUMENT_DELETED = 'AiModule.Document.SubDbRecordDeleted';
174
224
  * Type-specific routing keys for Document events
175
225
  * Subscribe to these for events on specific entity types only
176
226
  */
227
+ /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. created */
228
+ exports.ROUTING_KEY_DOCUMENT_CONTRACT_CREATED = 'AiModule.Document.CONTRACT.SubDbRecordCreated';
229
+ /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. updated */
230
+ exports.ROUTING_KEY_DOCUMENT_CONTRACT_UPDATED = 'AiModule.Document.CONTRACT.SubDbRecordUpdated';
231
+ /** An agreement between parties: an NDA, a supply agreement, a lease. Template or signed; SubType says which kind. deleted */
232
+ exports.ROUTING_KEY_DOCUMENT_CONTRACT_DELETED = 'AiModule.Document.CONTRACT.SubDbRecordDeleted';
177
233
  /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). created */
178
234
  exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_CREATED = 'AiModule.Document.CONTRACT_BUYOUT.SubDbRecordCreated';
179
235
  /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). updated */
180
236
  exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_UPDATED = 'AiModule.Document.CONTRACT_BUYOUT.SubDbRecordUpdated';
181
237
  /** A customer's previous-provider final bill sent for a contract buyout (YouFibre orders). deleted */
182
238
  exports.ROUTING_KEY_DOCUMENT_CONTRACT_BUYOUT_DELETED = 'AiModule.Document.CONTRACT_BUYOUT.SubDbRecordDeleted';
239
+ /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. created */
240
+ exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_CREATED = 'AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordCreated';
241
+ /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. updated */
242
+ exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_UPDATED = 'AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordUpdated';
243
+ /** A document about the company itself: articles of association, resolutions, filings. SubType says which kind. deleted */
244
+ exports.ROUTING_KEY_DOCUMENT_CORPORATE_DOCUMENT_DELETED = 'AiModule.Document.CORPORATE_DOCUMENT.SubDbRecordDeleted';
183
245
  /** This is the default record type created */
184
246
  exports.ROUTING_KEY_DOCUMENT_DEFAULT_CREATED = 'AiModule.Document.DEFAULT.SubDbRecordCreated';
185
247
  /** This is the default record type updated */
@@ -27,17 +27,23 @@ export declare enum DocumentProcessingEntityTypes {
27
27
  *
28
28
  * @remarks Available options:
29
29
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
30
+ * - `CHAT` - Chat
30
31
  * - `DESCRIBE` - Describe
31
32
  * - `EMBED` - Embed
33
+ * - `EXTRACT_FIELDS` - Extract fields
32
34
  * - `EXTRACT` - Extract text
33
35
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
36
+ * - `TEMPLATE_REPORT` - Template report
34
37
  */
35
38
  export declare enum DocumentProcessingUseCase {
36
39
  CBO_FINAL_BILL_CHECK = "CBO_FINAL_BILL_CHECK",
40
+ CHAT = "CHAT",
37
41
  DESCRIBE = "DESCRIBE",
38
42
  EMBED = "EMBED",
43
+ EXTRACT_FIELDS = "EXTRACT_FIELDS",
39
44
  EXTRACT_TEXT = "EXTRACT",
40
- OUTCOME_FORM_REVIEW = "OUTCOME_FORM_REVIEW"
45
+ OUTCOME_FORM_REVIEW = "OUTCOME_FORM_REVIEW",
46
+ TEMPLATE_REPORT = "TEMPLATE_REPORT"
41
47
  }
42
48
  /**
43
49
  * Valid values for DocumentProcessing.Provider
@@ -29,18 +29,24 @@ var DocumentProcessingEntityTypes;
29
29
  *
30
30
  * @remarks Available options:
31
31
  * - `CBO_FINAL_BILL_CHECK` - CBO final bill check
32
+ * - `CHAT` - Chat
32
33
  * - `DESCRIBE` - Describe
33
34
  * - `EMBED` - Embed
35
+ * - `EXTRACT_FIELDS` - Extract fields
34
36
  * - `EXTRACT` - Extract text
35
37
  * - `OUTCOME_FORM_REVIEW` - Outcome form review
38
+ * - `TEMPLATE_REPORT` - Template report
36
39
  */
37
40
  var DocumentProcessingUseCase;
38
41
  (function (DocumentProcessingUseCase) {
39
42
  DocumentProcessingUseCase["CBO_FINAL_BILL_CHECK"] = "CBO_FINAL_BILL_CHECK";
43
+ DocumentProcessingUseCase["CHAT"] = "CHAT";
40
44
  DocumentProcessingUseCase["DESCRIBE"] = "DESCRIBE";
41
45
  DocumentProcessingUseCase["EMBED"] = "EMBED";
46
+ DocumentProcessingUseCase["EXTRACT_FIELDS"] = "EXTRACT_FIELDS";
42
47
  DocumentProcessingUseCase["EXTRACT_TEXT"] = "EXTRACT";
43
48
  DocumentProcessingUseCase["OUTCOME_FORM_REVIEW"] = "OUTCOME_FORM_REVIEW";
49
+ DocumentProcessingUseCase["TEMPLATE_REPORT"] = "TEMPLATE_REPORT";
44
50
  })(DocumentProcessingUseCase = exports.DocumentProcessingUseCase || (exports.DocumentProcessingUseCase = {}));
45
51
  /**
46
52
  * Valid values for DocumentProcessing.Provider
@@ -71,14 +71,14 @@ export declare enum EquipmentReturnItemDeviceEntity {
71
71
  * Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true
72
72
  *
73
73
  * @remarks Available options:
74
- * - `A`
75
- * - `B`
76
- * - `C`
74
+ * - `B` - Fail - Cosmetic
75
+ * - `C` - Fail - Technical
76
+ * - `A` - Pass
77
77
  */
78
78
  export declare enum EquipmentReturnItemGrade {
79
- 'A' = "A",
80
- 'B' = "B",
81
- 'C' = "C"
79
+ FAIL_COSMETIC = "B",
80
+ FAIL_TECHNICAL = "C",
81
+ PASS = "A"
82
82
  }
83
83
  /**
84
84
  * Property keys for EquipmentReturnItem
@@ -74,15 +74,15 @@ var EquipmentReturnItemDeviceEntity;
74
74
  * Condition as inspected. Same option set as Returns.Cpe{n}Grade. Only meaningful when Returned is true
75
75
  *
76
76
  * @remarks Available options:
77
- * - `A`
78
- * - `B`
79
- * - `C`
77
+ * - `B` - Fail - Cosmetic
78
+ * - `C` - Fail - Technical
79
+ * - `A` - Pass
80
80
  */
81
81
  var EquipmentReturnItemGrade;
82
82
  (function (EquipmentReturnItemGrade) {
83
- EquipmentReturnItemGrade["A"] = "A";
84
- EquipmentReturnItemGrade["B"] = "B";
85
- EquipmentReturnItemGrade["C"] = "C";
83
+ EquipmentReturnItemGrade["FAIL_COSMETIC"] = "B";
84
+ EquipmentReturnItemGrade["FAIL_TECHNICAL"] = "C";
85
+ EquipmentReturnItemGrade["PASS"] = "A";
86
86
  })(EquipmentReturnItemGrade = exports.EquipmentReturnItemGrade || (exports.EquipmentReturnItemGrade = {}));
87
87
  /**
88
88
  * Property keys for EquipmentReturnItem
@@ -130,6 +130,19 @@ export declare enum HomeMoveNewOrderInstallTimeBlock {
130
130
  AM = "AM",
131
131
  PM = "PM"
132
132
  }
133
+ /**
134
+ * Valid values for HomeMove.NewOrderPrice
135
+ *
136
+ * The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
137
+ *
138
+ * @remarks Available options:
139
+ * - `CURRENT` - Current price
140
+ * - `WEBSITE` - Website price (re-quoted)
141
+ */
142
+ export declare enum HomeMoveNewOrderPrice {
143
+ CURRENT_PRICE = "CURRENT",
144
+ WEBSITE_PRICE_RE_QUOTED = "WEBSITE"
145
+ }
133
146
  /**
134
147
  * Property keys for HomeMove
135
148
  * Use these constants instead of string literals for type safety
@@ -168,7 +181,9 @@ export declare enum HomeMovePropertyKeys {
168
181
  /** Which network can serve the new address. Set by the serviceability check at Created. Netomnia and Brsk are one company, so both move now; OPENREACH is a later phase. */
169
182
  ServiceableVia = "ServiceableVia",
170
183
  /** AM or PM engineer slot for a New Provide move, chosen with NewOrderInstallOrActivationDate from the install calendar. Empty on a Start Order. */
171
- NewOrderInstallTimeBlock = "NewOrderInstallTimeBlock"
184
+ NewOrderInstallTimeBlock = "NewOrderInstallTimeBlock",
185
+ /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current. */
186
+ NewOrderPrice = "NewOrderPrice"
172
187
  }
173
188
  /**
174
189
  * Properties for HomeMove records
@@ -282,6 +297,13 @@ export interface HomeMoveProperties {
282
297
  * @enum {HomeMoveNewOrderInstallTimeBlock}
283
298
  */
284
299
  NewOrderInstallTimeBlock: HomeMoveNewOrderInstallTimeBlock;
300
+ /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
301
+ *
302
+ * @type {ENUM}
303
+ * @default
304
+ * @enum {HomeMoveNewOrderPrice}
305
+ */
306
+ NewOrderPrice: HomeMoveNewOrderPrice;
285
307
  }
286
308
  /**
287
309
  * HomeMove entity from OrderModule
@@ -12,7 +12,7 @@
12
12
  * Generated from Odin schema definition
13
13
  */
14
14
  Object.defineProperty(exports, "__esModule", { value: true });
15
- exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveServiceableVia = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NOTE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_WORK_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CASE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_NEW_ADDRESS_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_OLD_ORDER_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_FILE_CREATED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_DELETED = exports.ROUTING_KEY_LINK_HOME_MOVE_CONTACT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_DELETED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_UPDATED = exports.ROUTING_KEY_HOME_MOVE_DEFAULT_CREATED = exports.ROUTING_KEY_HOME_MOVE_DELETED = exports.ROUTING_KEY_HOME_MOVE_UPDATED = exports.ROUTING_KEY_HOME_MOVE_CREATED = exports.HomeMove = exports.HomeMovePropertyKeys = exports.HomeMoveNewOrderPrice = exports.HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveServiceableVia = exports.HomeMoveCollectionKitAddress = exports.HomeMoveRouterDeliveryAddress = exports.DefaultHomeMoveStageKeys = exports.DefaultHomeMoveStageNames = exports.HomeMoveEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for HomeMove records
@@ -133,6 +133,20 @@ var HomeMoveNewOrderInstallTimeBlock;
133
133
  HomeMoveNewOrderInstallTimeBlock["AM"] = "AM";
134
134
  HomeMoveNewOrderInstallTimeBlock["PM"] = "PM";
135
135
  })(HomeMoveNewOrderInstallTimeBlock = exports.HomeMoveNewOrderInstallTimeBlock || (exports.HomeMoveNewOrderInstallTimeBlock = {}));
136
+ /**
137
+ * Valid values for HomeMove.NewOrderPrice
138
+ *
139
+ * The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current.
140
+ *
141
+ * @remarks Available options:
142
+ * - `CURRENT` - Current price
143
+ * - `WEBSITE` - Website price (re-quoted)
144
+ */
145
+ var HomeMoveNewOrderPrice;
146
+ (function (HomeMoveNewOrderPrice) {
147
+ HomeMoveNewOrderPrice["CURRENT_PRICE"] = "CURRENT";
148
+ HomeMoveNewOrderPrice["WEBSITE_PRICE_RE_QUOTED"] = "WEBSITE";
149
+ })(HomeMoveNewOrderPrice = exports.HomeMoveNewOrderPrice || (exports.HomeMoveNewOrderPrice = {}));
136
150
  /**
137
151
  * Property keys for HomeMove
138
152
  * Use these constants instead of string literals for type safety
@@ -173,6 +187,8 @@ var HomeMovePropertyKeys;
173
187
  HomeMovePropertyKeys["ServiceableVia"] = "ServiceableVia";
174
188
  /** AM or PM engineer slot for a New Provide move, chosen with NewOrderInstallOrActivationDate from the install calendar. Empty on a Start Order. */
175
189
  HomeMovePropertyKeys["NewOrderInstallTimeBlock"] = "NewOrderInstallTimeBlock";
190
+ /** The price the new order is placed at. Set when the contract summary is sent; locked once the move is confirmed. Empty = Current. */
191
+ HomeMovePropertyKeys["NewOrderPrice"] = "NewOrderPrice";
176
192
  })(HomeMovePropertyKeys = exports.HomeMovePropertyKeys || (exports.HomeMovePropertyKeys = {}));
177
193
  /**
178
194
  * HomeMove entity from OrderModule
@@ -97,8 +97,6 @@ export declare enum NoteEntityTypes {
97
97
  * Use these constants instead of string literals for type safety
98
98
  */
99
99
  export declare enum NotePropertyKeys {
100
- /** body of the note (Customer Service - Note) */
101
- Body = "Body",
102
100
  /** Data field for Note records. Used by Customer Service team. */
103
101
  MetaData = "MetaData",
104
102
  /** JSONContent (Customer Service - Note) */
@@ -116,7 +114,9 @@ export declare enum NotePropertyKeys {
116
114
  /** Data field for Note records. Used by Customer Service team. */
117
115
  Case = "Case",
118
116
  /** True makes the desktop case conversation feed show only the first line of this note, with Show more to open it. Empty or false shows the whole note. Set by Edgar AI on the notes it writes. */
119
- Collapsed = "Collapsed"
117
+ Collapsed = "Collapsed",
118
+ /** body of the note (Customer Service - Note) */
119
+ Body = "Body"
120
120
  }
121
121
  /**
122
122
  * Properties for Note records
@@ -124,12 +124,6 @@ export declare enum NotePropertyKeys {
124
124
  * @see SupportModule:Note
125
125
  */
126
126
  export interface NoteProperties {
127
- /** body of the note (Customer Service - Note)
128
- *
129
- * @type {TEXT_LONG}
130
- * @placeholder body
131
- */
132
- Body: string;
133
127
  /** Data field for Note records. Used by Customer Service team.
134
128
  *
135
129
  * @type {JSON}
@@ -180,6 +174,12 @@ export interface NoteProperties {
180
174
  * @hidden This field is hidden in the UI
181
175
  */
182
176
  Collapsed: boolean;
177
+ /** body of the note (Customer Service - Note)
178
+ *
179
+ * @type {TEXT_LONG}
180
+ * @placeholder Type here
181
+ */
182
+ Body: string;
183
183
  }
184
184
  /**
185
185
  * Note entity from SupportModule
@@ -28,8 +28,6 @@ var NoteEntityTypes;
28
28
  */
29
29
  var NotePropertyKeys;
30
30
  (function (NotePropertyKeys) {
31
- /** body of the note (Customer Service - Note) */
32
- NotePropertyKeys["Body"] = "Body";
33
31
  /** Data field for Note records. Used by Customer Service team. */
34
32
  NotePropertyKeys["MetaData"] = "MetaData";
35
33
  /** JSONContent (Customer Service - Note) */
@@ -48,6 +46,8 @@ var NotePropertyKeys;
48
46
  NotePropertyKeys["Case"] = "Case";
49
47
  /** True makes the desktop case conversation feed show only the first line of this note, with Show more to open it. Empty or false shows the whole note. Set by Edgar AI on the notes it writes. */
50
48
  NotePropertyKeys["Collapsed"] = "Collapsed";
49
+ /** body of the note (Customer Service - Note) */
50
+ NotePropertyKeys["Body"] = "Body";
51
51
  })(NotePropertyKeys = exports.NotePropertyKeys || (exports.NotePropertyKeys = {}));
52
52
  /**
53
53
  * Note entity from SupportModule
@@ -614,7 +614,9 @@ export declare enum OrderPropertyKeys {
614
614
  /** How many commitments are Pending or Breached. Written only by the lifecycle. */
615
615
  OpenCommitmentCount = "OpenCommitmentCount",
616
616
  /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
617
- EarliestDueAt = "EarliestDueAt"
617
+ EarliestDueAt = "EarliestDueAt",
618
+ /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
619
+ RouterUpgradeDeclined = "RouterUpgradeDeclined"
618
620
  }
619
621
  /**
620
622
  * Properties for Order records
@@ -1297,6 +1299,12 @@ export interface OrderProperties {
1297
1299
  * @default
1298
1300
  */
1299
1301
  EarliestDueAt: string;
1302
+ /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493).
1303
+ *
1304
+ * @type {BOOLEAN}
1305
+ * @default
1306
+ */
1307
+ RouterUpgradeDeclined: boolean;
1300
1308
  }
1301
1309
  /**
1302
1310
  * Order entity from OrderModule
@@ -598,6 +598,8 @@ var OrderPropertyKeys;
598
598
  OrderPropertyKeys["OpenCommitmentCount"] = "OpenCommitmentCount";
599
599
  /** The next commitment to fall due. What a "what is about to breach" query sorts on, without walking every commitment. Written only by the lifecycle. */
600
600
  OrderPropertyKeys["EarliestDueAt"] = "EarliestDueAt";
601
+ /** True while the customer has declined the router/mesh dispatch this recontract would otherwise raise. Written by dispatchRouterForSpeedChange on every call — true when a decline is honoured, false otherwise — so reversal is simply calling the endpoint again with no decline flag (ORD-493). */
602
+ OrderPropertyKeys["RouterUpgradeDeclined"] = "RouterUpgradeDeclined";
601
603
  })(OrderPropertyKeys = exports.OrderPropertyKeys || (exports.OrderPropertyKeys = {}));
602
604
  /**
603
605
  * Order entity from OrderModule
@@ -56,7 +56,9 @@ export declare enum OutboundDialCampaignPropertyKeys {
56
56
  /** Override Twilio CLI Outbound number in case needed for different campaigns */
57
57
  CallerId = "CallerId",
58
58
  /** How cases reach agents: SELF_SELECT (agents pick from the queue) or ROUND_ROBIN (the dialler hands new cases to agents in turn, CASES-1984). Empty means SELF_SELECT. */
59
- DistributionMode = "DistributionMode"
59
+ DistributionMode = "DistributionMode",
60
+ /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
61
+ RetentionCampaign = "RetentionCampaign"
60
62
  }
61
63
  /**
62
64
  * Properties for OutboundDialCampaign records
@@ -110,6 +112,12 @@ export interface OutboundDialCampaignProperties {
110
112
  * @default
111
113
  */
112
114
  DistributionMode: string;
115
+ /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false.
116
+ *
117
+ * @type {BOOLEAN}
118
+ * @default
119
+ */
120
+ RetentionCampaign: boolean;
113
121
  }
114
122
  /**
115
123
  * OutboundDialCampaign entity from SupportModule
@@ -58,6 +58,8 @@ var OutboundDialCampaignPropertyKeys;
58
58
  OutboundDialCampaignPropertyKeys["CallerId"] = "CallerId";
59
59
  /** How cases reach agents: SELF_SELECT (agents pick from the queue) or ROUND_ROBIN (the dialler hands new cases to agents in turn, CASES-1984). Empty means SELF_SELECT. */
60
60
  OutboundDialCampaignPropertyKeys["DistributionMode"] = "DistributionMode";
61
+ /** When true, agents on this campaign record the retention RET outcomes and give a reason when they skip a case (CASES-1993). Empty means false. */
62
+ OutboundDialCampaignPropertyKeys["RetentionCampaign"] = "RetentionCampaign";
61
63
  })(OutboundDialCampaignPropertyKeys = exports.OutboundDialCampaignPropertyKeys || (exports.OutboundDialCampaignPropertyKeys = {}));
62
64
  /**
63
65
  * OutboundDialCampaign entity from SupportModule
@@ -62,7 +62,11 @@ export declare enum OutboundDialCampaignCasePropertyKeys {
62
62
  /** When this campaign last dialled this case. Per-campaign successor to Case.LastDialAt. */
63
63
  LastDialAt = "LastDialAt",
64
64
  /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
65
- LastDialOutcome = "LastDialOutcome"
65
+ LastDialOutcome = "LastDialOutcome",
66
+ /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries. */
67
+ AgentOutcome = "AgentOutcome",
68
+ /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993). */
69
+ SkipReason = "SkipReason"
66
70
  }
67
71
  /**
68
72
  * Properties for OutboundDialCampaignCase records
@@ -122,6 +126,18 @@ export interface OutboundDialCampaignCaseProperties {
122
126
  * @default
123
127
  */
124
128
  LastDialOutcome: string;
129
+ /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries.
130
+ *
131
+ * @type {TEXT}
132
+ * @default
133
+ */
134
+ AgentOutcome: string;
135
+ /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993).
136
+ *
137
+ * @type {TEXT}
138
+ * @default
139
+ */
140
+ SkipReason: string;
125
141
  }
126
142
  /**
127
143
  * OutboundDialCampaignCase entity from SupportModule
@@ -66,6 +66,10 @@ var OutboundDialCampaignCasePropertyKeys;
66
66
  OutboundDialCampaignCasePropertyKeys["LastDialAt"] = "LastDialAt";
67
67
  /** Outcome of this campaign's most recent dial of this case: CONNECTED, NO_ANSWER, BUSY, MACHINE or FAILED (the dialer's LastDialOutcome union). TEXT, not ENUM: the dialer is the only writer and a schema enum would need option shepherding on every new outcome. Per-campaign successor to Case.LastDialOutcome. */
68
68
  OutboundDialCampaignCasePropertyKeys["LastDialOutcome"] = "LastDialOutcome";
69
+ /** The call outcome the agent saved, e.g. "RET - Re-Contracted - Free MESH" (CASES-1993). Reporting only: LastDialOutcome is what drives retries. */
70
+ OutboundDialCampaignCasePropertyKeys["AgentOutcome"] = "AgentOutcome";
71
+ /** Why the agent skipped this case before dialling: ALREADY_RECONTRACTED, OTS_OTHER_PROCESS, PENDING_CANCELLATION, or "OTHER: <note>" (CASES-1993). */
72
+ OutboundDialCampaignCasePropertyKeys["SkipReason"] = "SkipReason";
69
73
  })(OutboundDialCampaignCasePropertyKeys = exports.OutboundDialCampaignCasePropertyKeys || (exports.OutboundDialCampaignCasePropertyKeys = {}));
70
74
  /**
71
75
  * OutboundDialCampaignCase entity from SupportModule