@d19n/youfibre-odin-sdk 2.0.76 → 2.0.78

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 (141) hide show
  1. package/README.md +10 -1
  2. package/dist/EntityRegistry.d.ts +2 -0
  3. package/dist/EntityRegistry.js +2 -0
  4. package/dist/OdinApiClient.d.ts +4 -0
  5. package/dist/OdinApiClient.js +8 -0
  6. package/dist/OdinDbClient.d.ts +4 -0
  7. package/dist/OdinDbClient.js +8 -0
  8. package/dist/accessors-v2/RegionAccessor.d.ts +111 -0
  9. package/dist/accessors-v2/RegionAccessor.js +190 -0
  10. package/dist/accessors-v2/index.d.ts +1 -0
  11. package/dist/accessors-v2/index.js +4 -2
  12. package/dist/actions-v2/CaseCreateNoteDto.d.ts +7 -0
  13. package/dist/actions-v2/CreateActivityLogEntryDto.d.ts +8 -0
  14. package/dist/actions-v2/CreateAppointmentDto.d.ts +8 -0
  15. package/dist/actions-v2/CreateBillingRequestTransactionDto.d.ts +9 -0
  16. package/dist/actions-v2/CreateBundleProductActionDto.d.ts +8 -0
  17. package/dist/actions-v2/CreateInstallDto.d.ts +9 -10
  18. package/dist/actions-v2/CreateInternetProductActionDto.d.ts +8 -0
  19. package/dist/actions-v2/CreateLaborProductActionDto.d.ts +8 -0
  20. package/dist/actions-v2/CreateLandlineProductActionDto.d.ts +8 -0
  21. package/dist/actions-v2/CreateLeadDto.d.ts +8 -0
  22. package/dist/actions-v2/CreateLeadFromAddressDto.d.ts +8 -0
  23. package/dist/actions-v2/CreateMeshProductActionDto.d.ts +8 -0
  24. package/dist/actions-v2/CreateMessageDto.d.ts +8 -0
  25. package/dist/actions-v2/CreateMobileProductActionDto.d.ts +8 -0
  26. package/dist/actions-v2/CreateOtpTransactionDto.d.ts +9 -0
  27. package/dist/actions-v2/CreatePgContactDto.d.ts +1 -1
  28. package/dist/actions-v2/CreateRegionDto.d.ts +65 -0
  29. package/dist/actions-v2/CreateRegionDto.js +52 -0
  30. package/dist/actions-v2/CreateTelevisionProductActionDto.d.ts +8 -0
  31. package/dist/actions-v2/CreateTransactionalEmailDto.d.ts +14 -0
  32. package/dist/actions-v2/NewAppointmentDto.d.ts +8 -0
  33. package/dist/actions-v2/SendDirectDebitCreatedEmailDto.d.ts +114 -0
  34. package/dist/actions-v2/SendDirectDebitCreatedEmailDto.js +59 -0
  35. package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.d.ts +114 -0
  36. package/dist/actions-v2/SendDirectDebitSetupConfirmationEmailDto.js +59 -0
  37. package/dist/actions-v2/SendRefundTransactionEmailDto.d.ts +109 -0
  38. package/dist/actions-v2/SendRefundTransactionEmailDto.js +54 -0
  39. package/dist/actions-v2/SendTlosNinjaCaseEmailDto.d.ts +7 -0
  40. package/dist/actions-v2/TransactionCreateDto.d.ts +8 -0
  41. package/dist/actions-v2/UpdateBundleProductActionDto.d.ts +8 -0
  42. package/dist/actions-v2/UpdateEmailDto.d.ts +14 -0
  43. package/dist/actions-v2/UpdateInternetProductActionDto.d.ts +8 -0
  44. package/dist/actions-v2/UpdateLaborProductActionDto.d.ts +8 -0
  45. package/dist/actions-v2/UpdateLandlineProductActionDto.d.ts +8 -0
  46. package/dist/actions-v2/UpdateLeadDto.d.ts +8 -0
  47. package/dist/actions-v2/UpdateMeshProductActionDto.d.ts +8 -0
  48. package/dist/actions-v2/UpdateMobileProductActionDto.d.ts +8 -0
  49. package/dist/actions-v2/UpdatePgContactDto.d.ts +1 -1
  50. package/dist/actions-v2/UpdateServiceDto.d.ts +8 -0
  51. package/dist/actions-v2/UpdateSupportEmailDto.d.ts +7 -0
  52. package/dist/actions-v2/UpdateTelevisionProductActionDto.d.ts +8 -0
  53. package/dist/api-sdk-v2/TeamApi.d.ts +2 -2
  54. package/dist/api-sdk-v2/TeamApi.js +6 -6
  55. package/dist/api-sdk-v2/UserApi.d.ts +4 -4
  56. package/dist/api-sdk-v2/UserApi.js +12 -12
  57. package/dist/db-accessors-v2/RegionDbAccessor.d.ts +149 -0
  58. package/dist/db-accessors-v2/RegionDbAccessor.js +227 -0
  59. package/dist/db-accessors-v2/index.d.ts +1 -0
  60. package/dist/db-accessors-v2/index.js +4 -2
  61. package/dist/db-sdk-v2/TeamDb.d.ts +2 -2
  62. package/dist/db-sdk-v2/TeamDb.js +6 -6
  63. package/dist/db-sdk-v2/UserDb.d.ts +4 -4
  64. package/dist/db-sdk-v2/UserDb.js +12 -12
  65. package/dist/entities-v2/Account.d.ts +60 -1
  66. package/dist/entities-v2/Account.js +20 -2
  67. package/dist/entities-v2/ActivityLog.d.ts +26 -1
  68. package/dist/entities-v2/ActivityLog.js +21 -1
  69. package/dist/entities-v2/Address.d.ts +23 -1
  70. package/dist/entities-v2/Address.js +17 -1
  71. package/dist/entities-v2/Appointment.d.ts +22 -1
  72. package/dist/entities-v2/Appointment.js +17 -1
  73. package/dist/entities-v2/Call.d.ts +15 -1
  74. package/dist/entities-v2/Call.js +4 -0
  75. package/dist/entities-v2/ConsumptionSchedule.d.ts +23 -1
  76. package/dist/entities-v2/ConsumptionSchedule.js +17 -1
  77. package/dist/entities-v2/Email.d.ts +45 -1
  78. package/dist/entities-v2/Email.js +4 -0
  79. package/dist/entities-v2/InvoiceItem.d.ts +26 -1
  80. package/dist/entities-v2/InvoiceItem.js +19 -1
  81. package/dist/entities-v2/KnowledgeArticle.d.ts +3 -1
  82. package/dist/entities-v2/KnowledgeArticle.js +2 -0
  83. package/dist/entities-v2/Lead.d.ts +31 -1
  84. package/dist/entities-v2/Lead.js +21 -1
  85. package/dist/entities-v2/Message.d.ts +23 -1
  86. package/dist/entities-v2/Message.js +2 -0
  87. package/dist/entities-v2/Milestone.d.ts +15 -1
  88. package/dist/entities-v2/Milestone.js +11 -1
  89. package/dist/entities-v2/Note.d.ts +8 -1
  90. package/dist/entities-v2/Note.js +2 -0
  91. package/dist/entities-v2/PaymentMethod.d.ts +43 -1
  92. package/dist/entities-v2/PaymentMethod.js +31 -1
  93. package/dist/entities-v2/PgContact.d.ts +8 -8
  94. package/dist/entities-v2/PgContact.js +2 -2
  95. package/dist/entities-v2/Product.d.ts +118 -1
  96. package/dist/entities-v2/Product.js +24 -2
  97. package/dist/entities-v2/ProductComponent.d.ts +27 -1
  98. package/dist/entities-v2/ProductComponent.js +21 -1
  99. package/dist/entities-v2/Program.d.ts +15 -1
  100. package/dist/entities-v2/Program.js +11 -1
  101. package/dist/entities-v2/Project.d.ts +15 -1
  102. package/dist/entities-v2/Project.js +11 -1
  103. package/dist/entities-v2/Restriction.d.ts +23 -1
  104. package/dist/entities-v2/Restriction.js +17 -1
  105. package/dist/entities-v2/Service.d.ts +22 -1
  106. package/dist/entities-v2/Service.js +17 -1
  107. package/dist/entities-v2/ServiceAppointment.d.ts +8 -1
  108. package/dist/entities-v2/ServiceAppointment.js +2 -0
  109. package/dist/entities-v2/ServiceVisitAudit.d.ts +13 -13
  110. package/dist/entities-v2/ServiceVisitAudit.js +2 -2
  111. package/dist/entities-v2/SmsMessage.d.ts +18 -1
  112. package/dist/entities-v2/SmsMessage.js +2 -0
  113. package/dist/entities-v2/Subtask.d.ts +15 -1
  114. package/dist/entities-v2/Subtask.js +11 -1
  115. package/dist/entities-v2/Task.d.ts +15 -1
  116. package/dist/entities-v2/Task.js +11 -1
  117. package/dist/entities-v2/Team.d.ts +3 -3
  118. package/dist/entities-v2/Transaction.d.ts +27 -1
  119. package/dist/entities-v2/Transaction.js +21 -1
  120. package/dist/entities-v2/User.d.ts +6 -6
  121. package/dist/entities-v2/Vendor.d.ts +22 -1
  122. package/dist/entities-v2/Vendor.js +17 -1
  123. package/dist/entities-v2/WorkOrder.d.ts +99 -1
  124. package/dist/entities-v2/WorkOrder.js +2 -0
  125. package/dist/entities-v2/YfStockCount.d.ts +9 -1
  126. package/dist/entities-v2/YfStockCount.js +8 -0
  127. package/dist/records-v2/EmailRecord.d.ts +87 -0
  128. package/dist/records-v2/EmailRecord.js +108 -0
  129. package/dist/records-v2/ExchangeRecord.d.ts +20 -0
  130. package/dist/records-v2/ExchangeRecord.js +33 -0
  131. package/dist/records-v2/RegionRecord.d.ts +205 -0
  132. package/dist/records-v2/RegionRecord.js +292 -0
  133. package/dist/records-v2/ServiceAppointmentConfigRecord.d.ts +20 -0
  134. package/dist/records-v2/ServiceAppointmentConfigRecord.js +33 -0
  135. package/dist/records-v2/TeamRecord.d.ts +20 -20
  136. package/dist/records-v2/TeamRecord.js +33 -33
  137. package/dist/records-v2/UserRecord.d.ts +40 -40
  138. package/dist/records-v2/UserRecord.js +66 -66
  139. package/dist/records-v2/index.d.ts +1 -0
  140. package/dist/records-v2/index.js +5 -2
  141. package/package.json +2 -2
@@ -107,6 +107,23 @@ export declare enum TransactionPaymentMethod {
107
107
  PHONE_PAYMENT = "PHONE_PAYMENT",
108
108
  STRIPE = "STRIPE"
109
109
  }
110
+ /**
111
+ * Valid values for Transaction.Type
112
+ *
113
+ * type of transaction (Finance - Transaction)
114
+ *
115
+ * @remarks Available options:
116
+ * - `BILLING_REQUEST` - Billing Request
117
+ * - `OTP`
118
+ * - `PAYMENT` - Payment
119
+ * - `REFUND` - Refund
120
+ */
121
+ export declare enum TransactionType {
122
+ BILLING_REQUEST = "BILLING_REQUEST",
123
+ OTP = "OTP",
124
+ PAYMENT = "PAYMENT",
125
+ REFUND = "REFUND"
126
+ }
110
127
  /**
111
128
  * Property keys for Transaction
112
129
  * Use these constants instead of string literals for type safety
@@ -151,7 +168,9 @@ export declare enum TransactionPropertyKeys {
151
168
  /** charge date 1 (Finance - Transaction) */
152
169
  ChargeDate1 = "ChargeDate1",
153
170
  /** will attempt retry (Finance - Transaction) */
154
- WillAttemptRetry = "WillAttemptRetry"
171
+ WillAttemptRetry = "WillAttemptRetry",
172
+ /** type of transaction (Finance - Transaction) */
173
+ Type = "Type"
155
174
  }
156
175
  /**
157
176
  * Properties for Transaction records
@@ -288,6 +307,13 @@ export interface TransactionProperties {
288
307
  * @tracked Changes to this field are tracked in audit history
289
308
  */
290
309
  WillAttemptRetry: boolean;
310
+ /** type of transaction (Finance - Transaction)
311
+ *
312
+ * @type {ENUM}
313
+ * @enum {TransactionType}
314
+ * @hidden This field is hidden in the UI
315
+ */
316
+ Type: TransactionType;
291
317
  }
292
318
  /**
293
319
  * Transaction entity from BillingModule
@@ -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_TRANSACTION_TRANSACTION_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_TRANSACTION_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_PAYMENT_METHOD_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_PAYMENT_METHOD_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_NOTE_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_NOTE_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_FILE_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_FILE_CREATED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_DELETED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_UPDATED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_CREATED = exports.ROUTING_KEY_TRANSACTION_DELETED = exports.ROUTING_KEY_TRANSACTION_UPDATED = exports.ROUTING_KEY_TRANSACTION_CREATED = exports.Transaction = exports.TransactionPropertyKeys = exports.TransactionPaymentMethod = exports.TransactionStatus = exports.TransactionCurrencyCode = exports.TransactionEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_TRANSACTION_TRANSACTION_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_TRANSACTION_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_PAYMENT_METHOD_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_PAYMENT_METHOD_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_NOTE_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_NOTE_CREATED = exports.ROUTING_KEY_LINK_TRANSACTION_FILE_DELETED = exports.ROUTING_KEY_LINK_TRANSACTION_FILE_CREATED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_DELETED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_UPDATED = exports.ROUTING_KEY_TRANSACTION_DEFAULT_CREATED = exports.ROUTING_KEY_TRANSACTION_DELETED = exports.ROUTING_KEY_TRANSACTION_UPDATED = exports.ROUTING_KEY_TRANSACTION_CREATED = exports.Transaction = exports.TransactionPropertyKeys = exports.TransactionType = exports.TransactionPaymentMethod = exports.TransactionStatus = exports.TransactionCurrencyCode = exports.TransactionEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for Transaction records
@@ -107,6 +107,24 @@ var TransactionPaymentMethod;
107
107
  TransactionPaymentMethod["PHONE_PAYMENT"] = "PHONE_PAYMENT";
108
108
  TransactionPaymentMethod["STRIPE"] = "STRIPE";
109
109
  })(TransactionPaymentMethod = exports.TransactionPaymentMethod || (exports.TransactionPaymentMethod = {}));
110
+ /**
111
+ * Valid values for Transaction.Type
112
+ *
113
+ * type of transaction (Finance - Transaction)
114
+ *
115
+ * @remarks Available options:
116
+ * - `BILLING_REQUEST` - Billing Request
117
+ * - `OTP`
118
+ * - `PAYMENT` - Payment
119
+ * - `REFUND` - Refund
120
+ */
121
+ var TransactionType;
122
+ (function (TransactionType) {
123
+ TransactionType["BILLING_REQUEST"] = "BILLING_REQUEST";
124
+ TransactionType["OTP"] = "OTP";
125
+ TransactionType["PAYMENT"] = "PAYMENT";
126
+ TransactionType["REFUND"] = "REFUND";
127
+ })(TransactionType = exports.TransactionType || (exports.TransactionType = {}));
110
128
  /**
111
129
  * Property keys for Transaction
112
130
  * Use these constants instead of string literals for type safety
@@ -153,6 +171,8 @@ var TransactionPropertyKeys;
153
171
  TransactionPropertyKeys["ChargeDate1"] = "ChargeDate1";
154
172
  /** will attempt retry (Finance - Transaction) */
155
173
  TransactionPropertyKeys["WillAttemptRetry"] = "WillAttemptRetry";
174
+ /** type of transaction (Finance - Transaction) */
175
+ TransactionPropertyKeys["Type"] = "Type";
156
176
  })(TransactionPropertyKeys = exports.TransactionPropertyKeys || (exports.TransactionPropertyKeys = {}));
157
177
  /**
158
178
  * Transaction entity from BillingModule
@@ -13,7 +13,6 @@
13
13
  import { OdinRecord, OdinLink, LinkedOdinRecord } from '@d19n/odin-types/dist/core';
14
14
  import { BlockageA55Properties } from './BlockageA55';
15
15
  import { TimeSlotProperties } from './TimeSlot';
16
- import { TeamProperties } from './Team';
17
16
  import { ReturnsProperties } from './Returns';
18
17
  import { PushNotificationProperties } from './PushNotification';
19
18
  import { EmailProperties } from './Email';
@@ -30,8 +29,9 @@ import { ChangeReasonProperties } from './ChangeReason';
30
29
  import { CrmDatasetProperties } from './CrmDataset';
31
30
  import { CustomerDeviceConfigurationProperties } from './CustomerDeviceConfiguration';
32
31
  import { TwilioUserUpdateProperties } from './TwilioUserUpdate';
33
- import { SalesTerritoryProperties } from './SalesTerritory';
34
32
  import { CallTransferProperties } from './CallTransfer';
33
+ import { TeamProperties } from './Team';
34
+ import { SalesTerritoryProperties } from './SalesTerritory';
35
35
  /**
36
36
  * Available types for User records
37
37
  */
@@ -242,8 +242,6 @@ export declare class User extends OdinRecord<UserProperties> {
242
242
  BlockageA55: OdinLink<LinkedOdinRecord<BlockageA55Properties>>;
243
243
  /** Linked TimeSlot records (User__TimeSlot) */
244
244
  TimeSlot: OdinLink<LinkedOdinRecord<TimeSlotProperties>>;
245
- /** Linked Team records (Team_User) */
246
- Team: OdinLink<LinkedOdinRecord<TeamProperties>>;
247
245
  /** Linked Returns records (Returns__Inspected_By) */
248
246
  Returns: OdinLink<LinkedOdinRecord<ReturnsProperties>>;
249
247
  /** Linked PushNotification records (User__PushNotification) */
@@ -276,10 +274,12 @@ export declare class User extends OdinRecord<UserProperties> {
276
274
  CustomerDeviceConfiguration: OdinLink<LinkedOdinRecord<CustomerDeviceConfigurationProperties>>;
277
275
  /** Linked TwilioUserUpdate records (TwilioUserUpdate) */
278
276
  TwilioUserUpdate: OdinLink<LinkedOdinRecord<TwilioUserUpdateProperties>>;
279
- /** Linked SalesTerritory records (SalesTerritory__User) */
280
- SalesTerritory: OdinLink<LinkedOdinRecord<SalesTerritoryProperties>>;
281
277
  /** Linked CallTransfer records (CallTransfer_ToAgent) */
282
278
  CallTransfer: OdinLink<LinkedOdinRecord<CallTransferProperties>>;
279
+ /** Linked Team records (Team_User) */
280
+ Team: OdinLink<LinkedOdinRecord<TeamProperties>>;
281
+ /** Linked SalesTerritory records (SalesTerritory__User) */
282
+ SalesTerritory: OdinLink<LinkedOdinRecord<SalesTerritoryProperties>>;
283
283
  }
284
284
  /**
285
285
  * RabbitMQ routing keys for User events
@@ -20,13 +20,28 @@ export declare enum VendorEntityTypes {
20
20
  /** Default record type */
21
21
  DEFAULT = "DEFAULT"
22
22
  }
23
+ /**
24
+ * Valid values for Vendor.Type
25
+ *
26
+ * type of vendor (Product Management - Vendor)
27
+ *
28
+ * @remarks Available options:
29
+ * - `CONTRACTOR` - Contractor
30
+ * - `SUPPLIER` - Supplier
31
+ */
32
+ export declare enum VendorType {
33
+ CONTRACTOR = "CONTRACTOR",
34
+ SUPPLIER = "SUPPLIER"
35
+ }
23
36
  /**
24
37
  * Property keys for Vendor
25
38
  * Use these constants instead of string literals for type safety
26
39
  */
27
40
  export declare enum VendorPropertyKeys {
28
41
  /** is the vendor archived (Product Management - Vendor) */
29
- Archived = "Archived"
42
+ Archived = "Archived",
43
+ /** type of vendor (Product Management - Vendor) */
44
+ Type = "Type"
30
45
  }
31
46
  /**
32
47
  * Properties for Vendor records
@@ -39,6 +54,12 @@ export interface VendorProperties {
39
54
  * @type {BOOLEAN}
40
55
  */
41
56
  Archived: boolean;
57
+ /** type of vendor (Product Management - Vendor)
58
+ *
59
+ * @type {ENUM}
60
+ * @enum {VendorType}
61
+ */
62
+ Type: VendorType;
42
63
  }
43
64
  /**
44
65
  * Vendor entity from ProductModule
@@ -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_VENDOR_PRICE_BOOK_DELETED = exports.ROUTING_KEY_LINK_VENDOR_PRICE_BOOK_CREATED = exports.ROUTING_KEY_LINK_VENDOR_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_VENDOR_PRODUCT_CREATED = exports.ROUTING_KEY_VENDOR_DEFAULT_DELETED = exports.ROUTING_KEY_VENDOR_DEFAULT_UPDATED = exports.ROUTING_KEY_VENDOR_DEFAULT_CREATED = exports.ROUTING_KEY_VENDOR_DELETED = exports.ROUTING_KEY_VENDOR_UPDATED = exports.ROUTING_KEY_VENDOR_CREATED = exports.Vendor = exports.VendorPropertyKeys = exports.VendorEntityTypes = void 0;
15
+ exports.ROUTING_KEY_LINK_VENDOR_PRICE_BOOK_DELETED = exports.ROUTING_KEY_LINK_VENDOR_PRICE_BOOK_CREATED = exports.ROUTING_KEY_LINK_VENDOR_PRODUCT_DELETED = exports.ROUTING_KEY_LINK_VENDOR_PRODUCT_CREATED = exports.ROUTING_KEY_VENDOR_DEFAULT_DELETED = exports.ROUTING_KEY_VENDOR_DEFAULT_UPDATED = exports.ROUTING_KEY_VENDOR_DEFAULT_CREATED = exports.ROUTING_KEY_VENDOR_DELETED = exports.ROUTING_KEY_VENDOR_UPDATED = exports.ROUTING_KEY_VENDOR_CREATED = exports.Vendor = exports.VendorPropertyKeys = exports.VendorType = exports.VendorEntityTypes = void 0;
16
16
  const core_1 = require("@d19n/odin-types/dist/core");
17
17
  /**
18
18
  * Available types for Vendor records
@@ -22,6 +22,20 @@ var VendorEntityTypes;
22
22
  /** Default record type */
23
23
  VendorEntityTypes["DEFAULT"] = "DEFAULT";
24
24
  })(VendorEntityTypes = exports.VendorEntityTypes || (exports.VendorEntityTypes = {}));
25
+ /**
26
+ * Valid values for Vendor.Type
27
+ *
28
+ * type of vendor (Product Management - Vendor)
29
+ *
30
+ * @remarks Available options:
31
+ * - `CONTRACTOR` - Contractor
32
+ * - `SUPPLIER` - Supplier
33
+ */
34
+ var VendorType;
35
+ (function (VendorType) {
36
+ VendorType["CONTRACTOR"] = "CONTRACTOR";
37
+ VendorType["SUPPLIER"] = "SUPPLIER";
38
+ })(VendorType = exports.VendorType || (exports.VendorType = {}));
25
39
  /**
26
40
  * Property keys for Vendor
27
41
  * Use these constants instead of string literals for type safety
@@ -30,6 +44,8 @@ var VendorPropertyKeys;
30
44
  (function (VendorPropertyKeys) {
31
45
  /** is the vendor archived (Product Management - Vendor) */
32
46
  VendorPropertyKeys["Archived"] = "Archived";
47
+ /** type of vendor (Product Management - Vendor) */
48
+ VendorPropertyKeys["Type"] = "Type";
33
49
  })(VendorPropertyKeys = exports.VendorPropertyKeys || (exports.VendorPropertyKeys = {}));
34
50
  /**
35
51
  * Vendor entity from ProductModule
@@ -1483,7 +1483,9 @@ export declare enum WorkOrderPropertyKeys {
1483
1483
  /** Reference identifier for WorkOrder relationships. Used for data integrity. */
1484
1484
  OrderId = "OrderId",
1485
1485
  /** Contact information field for WorkOrder. Used by Field Operations team for communication. */
1486
- AlternativeAddressPostCode = "AlternativeAddressPostCode"
1486
+ AlternativeAddressPostCode = "AlternativeAddressPostCode",
1487
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder) */
1488
+ Type = "Type"
1487
1489
  }
1488
1490
  /**
1489
1491
  * Properties for WorkOrder records
@@ -2216,6 +2218,12 @@ export interface WorkOrderProperties {
2216
2218
  * @type {TEXT}
2217
2219
  */
2218
2220
  AlternativeAddressPostCode: string;
2221
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
2222
+ *
2223
+ * @type {TEXT}
2224
+ * @hidden This field is hidden in the UI
2225
+ */
2226
+ Type: string;
2219
2227
  }
2220
2228
  /**
2221
2229
  * Properties for COLLECTION WorkOrder records
@@ -2948,6 +2956,12 @@ export interface CollectionWorkOrderProperties {
2948
2956
  * @type {TEXT}
2949
2957
  */
2950
2958
  AlternativeAddressPostCode: string;
2959
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
2960
+ *
2961
+ * @type {TEXT}
2962
+ * @hidden This field is hidden in the UI
2963
+ */
2964
+ Type: string;
2951
2965
  }
2952
2966
  /**
2953
2967
  * Properties for COLLECTION_AMCO WorkOrder records
@@ -3680,6 +3694,12 @@ export interface CollectionAmcoWorkOrderProperties {
3680
3694
  * @type {TEXT}
3681
3695
  */
3682
3696
  AlternativeAddressPostCode: string;
3697
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
3698
+ *
3699
+ * @type {TEXT}
3700
+ * @hidden This field is hidden in the UI
3701
+ */
3702
+ Type: string;
3683
3703
  }
3684
3704
  /**
3685
3705
  * Properties for DISPATCH_AMCO WorkOrder records
@@ -4412,6 +4432,12 @@ export interface DispatchAmcoWorkOrderProperties {
4412
4432
  * @type {TEXT}
4413
4433
  */
4414
4434
  AlternativeAddressPostCode: string;
4435
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
4436
+ *
4437
+ * @type {TEXT}
4438
+ * @hidden This field is hidden in the UI
4439
+ */
4440
+ Type: string;
4415
4441
  }
4416
4442
  /**
4417
4443
  * Properties for FINANCE WorkOrder records
@@ -5144,6 +5170,12 @@ export interface FinanceWorkOrderProperties {
5144
5170
  * @type {TEXT}
5145
5171
  */
5146
5172
  AlternativeAddressPostCode: string;
5173
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
5174
+ *
5175
+ * @type {TEXT}
5176
+ * @hidden This field is hidden in the UI
5177
+ */
5178
+ Type: string;
5147
5179
  }
5148
5180
  /**
5149
5181
  * Properties for INSPECTION WorkOrder records
@@ -5876,6 +5908,12 @@ export interface InspectionWorkOrderProperties {
5876
5908
  * @type {TEXT}
5877
5909
  */
5878
5910
  AlternativeAddressPostCode: string;
5911
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
5912
+ *
5913
+ * @type {TEXT}
5914
+ * @hidden This field is hidden in the UI
5915
+ */
5916
+ Type: string;
5879
5917
  }
5880
5918
  /**
5881
5919
  * Properties for INSTALL WorkOrder records
@@ -6608,6 +6646,12 @@ export interface InstallWorkOrderProperties {
6608
6646
  * @type {TEXT}
6609
6647
  */
6610
6648
  AlternativeAddressPostCode: string;
6649
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
6650
+ *
6651
+ * @type {TEXT}
6652
+ * @hidden This field is hidden in the UI
6653
+ */
6654
+ Type: string;
6611
6655
  }
6612
6656
  /**
6613
6657
  * Properties for INSTALL_BUSINESS WorkOrder records
@@ -7340,6 +7384,12 @@ export interface InstallBusinessWorkOrderProperties {
7340
7384
  * @type {TEXT}
7341
7385
  */
7342
7386
  AlternativeAddressPostCode: string;
7387
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
7388
+ *
7389
+ * @type {TEXT}
7390
+ * @hidden This field is hidden in the UI
7391
+ */
7392
+ Type: string;
7343
7393
  }
7344
7394
  /**
7345
7395
  * Properties for INSTALL_SERVICE WorkOrder records
@@ -8072,6 +8122,12 @@ export interface InstallServiceWorkOrderProperties {
8072
8122
  * @type {TEXT}
8073
8123
  */
8074
8124
  AlternativeAddressPostCode: string;
8125
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
8126
+ *
8127
+ * @type {TEXT}
8128
+ * @hidden This field is hidden in the UI
8129
+ */
8130
+ Type: string;
8075
8131
  }
8076
8132
  /**
8077
8133
  * Properties for NETWORK_ADJUSTMENT WorkOrder records
@@ -8804,6 +8860,12 @@ export interface NetworkAdjustmentWorkOrderProperties {
8804
8860
  * @type {TEXT}
8805
8861
  */
8806
8862
  AlternativeAddressPostCode: string;
8863
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
8864
+ *
8865
+ * @type {TEXT}
8866
+ * @hidden This field is hidden in the UI
8867
+ */
8868
+ Type: string;
8807
8869
  }
8808
8870
  /**
8809
8871
  * Properties for PLANNING WorkOrder records
@@ -9536,6 +9598,12 @@ export interface PlanningWorkOrderProperties {
9536
9598
  * @type {TEXT}
9537
9599
  */
9538
9600
  AlternativeAddressPostCode: string;
9601
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
9602
+ *
9603
+ * @type {TEXT}
9604
+ * @hidden This field is hidden in the UI
9605
+ */
9606
+ Type: string;
9539
9607
  }
9540
9608
  /**
9541
9609
  * Properties for PRE_PULL WorkOrder records
@@ -10268,6 +10336,12 @@ export interface PrePullWorkOrderProperties {
10268
10336
  * @type {TEXT}
10269
10337
  */
10270
10338
  AlternativeAddressPostCode: string;
10339
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
10340
+ *
10341
+ * @type {TEXT}
10342
+ * @hidden This field is hidden in the UI
10343
+ */
10344
+ Type: string;
10271
10345
  }
10272
10346
  /**
10273
10347
  * Properties for REMEDIATION WorkOrder records
@@ -11000,6 +11074,12 @@ export interface RemediationWorkOrderProperties {
11000
11074
  * @type {TEXT}
11001
11075
  */
11002
11076
  AlternativeAddressPostCode: string;
11077
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
11078
+ *
11079
+ * @type {TEXT}
11080
+ * @hidden This field is hidden in the UI
11081
+ */
11082
+ Type: string;
11003
11083
  }
11004
11084
  /**
11005
11085
  * Properties for REPLACEMENT_AMCO WorkOrder records
@@ -11732,6 +11812,12 @@ export interface ReplacementAmcoWorkOrderProperties {
11732
11812
  * @type {TEXT}
11733
11813
  */
11734
11814
  AlternativeAddressPostCode: string;
11815
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
11816
+ *
11817
+ * @type {TEXT}
11818
+ * @hidden This field is hidden in the UI
11819
+ */
11820
+ Type: string;
11735
11821
  }
11736
11822
  /**
11737
11823
  * Properties for SERVICE WorkOrder records
@@ -12464,6 +12550,12 @@ export interface ServiceWorkOrderProperties {
12464
12550
  * @type {TEXT}
12465
12551
  */
12466
12552
  AlternativeAddressPostCode: string;
12553
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
12554
+ *
12555
+ * @type {TEXT}
12556
+ * @hidden This field is hidden in the UI
12557
+ */
12558
+ Type: string;
12467
12559
  }
12468
12560
  /**
12469
12561
  * Properties for WAYLEAVE WorkOrder records
@@ -13196,6 +13288,12 @@ export interface WayleaveWorkOrderProperties {
13196
13288
  * @type {TEXT}
13197
13289
  */
13198
13290
  AlternativeAddressPostCode: string;
13291
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder)
13292
+ *
13293
+ * @type {TEXT}
13294
+ * @hidden This field is hidden in the UI
13295
+ */
13296
+ Type: string;
13199
13297
  }
13200
13298
  /**
13201
13299
  * WorkOrder entity from FieldServiceModule
@@ -1487,6 +1487,8 @@ var WorkOrderPropertyKeys;
1487
1487
  WorkOrderPropertyKeys["OrderId"] = "OrderId";
1488
1488
  /** Contact information field for WorkOrder. Used by Field Operations team for communication. */
1489
1489
  WorkOrderPropertyKeys["AlternativeAddressPostCode"] = "AlternativeAddressPostCode";
1490
+ /** Deprecated. replaced by native entity types (Field Operations - WorkOrder) */
1491
+ WorkOrderPropertyKeys["Type"] = "Type";
1490
1492
  })(WorkOrderPropertyKeys = exports.WorkOrderPropertyKeys || (exports.WorkOrderPropertyKeys = {}));
1491
1493
  /**
1492
1494
  * WorkOrder entity from FieldServiceModule
@@ -82,7 +82,15 @@ export declare enum YfStockCountPropertyKeys {
82
82
  /** Total number of faulty units (Field Operations - YfStockCount) */
83
83
  Nvg578Lx1RouterFaulty = "NVG578LX1RouterFaulty",
84
84
  /** Data field for YfStockCount records. Used by Field Operations team. */
85
- Alert1 = "Alert1"
85
+ Alert1 = "Alert1",
86
+ /** Total number of units (Field Operations - YfStockCount) */
87
+ X5042WiFiWiFi6Extender = "X5042Wi-FiWi-Fi6Extender",
88
+ /** Total number of faulty units (Field Operations - YfStockCount) */
89
+ Nvg578LxWiFi6GatewayFaulty = "NVG578LXWi-Fi6GatewayFaulty",
90
+ /** Total number of units (Field Operations - YfStockCount) */
91
+ Nvg578LxWiFi6Gateway = "NVG578LXWi-Fi6Gateway",
92
+ /** Total number of faulty units (Field Operations - YfStockCount) */
93
+ X5042WiFiWiFi6ExtendeFaulty = "X5042Wi-FiWi-Fi6ExtendeFaulty"
86
94
  }
87
95
  /**
88
96
  * Properties for YfStockCount records
@@ -86,6 +86,14 @@ var YfStockCountPropertyKeys;
86
86
  YfStockCountPropertyKeys["Nvg578Lx1RouterFaulty"] = "NVG578LX1RouterFaulty";
87
87
  /** Data field for YfStockCount records. Used by Field Operations team. */
88
88
  YfStockCountPropertyKeys["Alert1"] = "Alert1";
89
+ /** Total number of units (Field Operations - YfStockCount) */
90
+ YfStockCountPropertyKeys["X5042WiFiWiFi6Extender"] = "X5042Wi-FiWi-Fi6Extender";
91
+ /** Total number of faulty units (Field Operations - YfStockCount) */
92
+ YfStockCountPropertyKeys["Nvg578LxWiFi6GatewayFaulty"] = "NVG578LXWi-Fi6GatewayFaulty";
93
+ /** Total number of units (Field Operations - YfStockCount) */
94
+ YfStockCountPropertyKeys["Nvg578LxWiFi6Gateway"] = "NVG578LXWi-Fi6Gateway";
95
+ /** Total number of faulty units (Field Operations - YfStockCount) */
96
+ YfStockCountPropertyKeys["X5042WiFiWiFi6ExtendeFaulty"] = "X5042Wi-FiWi-Fi6ExtendeFaulty";
89
97
  })(YfStockCountPropertyKeys = exports.YfStockCountPropertyKeys || (exports.YfStockCountPropertyKeys = {}));
90
98
  /**
91
99
  * YfStockCount entity from FieldServiceModule
@@ -38,6 +38,9 @@ import { CreateOrderReferralReferrerNotQualifiedEmailProperties } from '../actio
38
38
  import { CreateOrderReferralReferrerPendingEmailProperties } from '../actions-v2/CreateOrderReferralReferrerPendingEmailDto';
39
39
  import { CreateOrderReferralReferrerQualifiedEmailProperties } from '../actions-v2/CreateOrderReferralReferrerQualifiedEmailDto';
40
40
  import { CreateTransactionalEmailProperties } from '../actions-v2/CreateTransactionalEmailDto';
41
+ import { SendDirectDebitCreatedEmailProperties } from '../actions-v2/SendDirectDebitCreatedEmailDto';
42
+ import { SendDirectDebitSetupConfirmationEmailProperties } from '../actions-v2/SendDirectDebitSetupConfirmationEmailDto';
43
+ import { SendRefundTransactionEmailProperties } from '../actions-v2/SendRefundTransactionEmailDto';
41
44
  import { SendTlosNinjaCaseEmailProperties } from '../actions-v2/SendTlosNinjaCaseEmailDto';
42
45
  import { UpdateEmailProperties } from '../actions-v2/UpdateEmailDto';
43
46
  import { UpdateSupportEmailProperties } from '../actions-v2/UpdateSupportEmailDto';
@@ -775,6 +778,90 @@ export declare class EmailRecord<TProps = EmailProperties> {
775
778
  journeyId?: string;
776
779
  stageKey?: string;
777
780
  }): ActionBuilder;
781
+ /**
782
+ * SendDirectDebitCreatedEmail
783
+ *
784
+ * Creates a new Email record with the specified properties.
785
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
786
+ *
787
+ * @remarks Record type: TRANSACTIONAL
788
+ *
789
+ * @param properties - The properties for the new record
790
+ * @param options - Optional settings
791
+ * @param options.journeyId - Associate with a journey
792
+ * @param options.stageKey - Set initial pipeline stage
793
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
794
+ *
795
+ * @example
796
+ * ```typescript
797
+ * // Create with properties
798
+ * const record = odinClient.emails.new();
799
+ * await record.sendDirectDebitCreatedEmail({ ... }).execute();
800
+ *
801
+ * // Dry run (for debugging)
802
+ * const payload = record.sendDirectDebitCreatedEmail({ ... }).dryRun();
803
+ * ```
804
+ */
805
+ sendDirectDebitCreatedEmail(properties?: SendDirectDebitCreatedEmailProperties, options?: {
806
+ journeyId?: string;
807
+ stageKey?: string;
808
+ }): ActionBuilder;
809
+ /**
810
+ * SendDirectDebitSetupConfirmationEmail
811
+ *
812
+ * Creates a new Email record with the specified properties.
813
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
814
+ *
815
+ * @remarks Record type: TRANSACTIONAL
816
+ *
817
+ * @param properties - The properties for the new record
818
+ * @param options - Optional settings
819
+ * @param options.journeyId - Associate with a journey
820
+ * @param options.stageKey - Set initial pipeline stage
821
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
822
+ *
823
+ * @example
824
+ * ```typescript
825
+ * // Create with properties
826
+ * const record = odinClient.emails.new();
827
+ * await record.sendDirectDebitSetupConfirmationEmail({ ... }).execute();
828
+ *
829
+ * // Dry run (for debugging)
830
+ * const payload = record.sendDirectDebitSetupConfirmationEmail({ ... }).dryRun();
831
+ * ```
832
+ */
833
+ sendDirectDebitSetupConfirmationEmail(properties?: SendDirectDebitSetupConfirmationEmailProperties, options?: {
834
+ journeyId?: string;
835
+ stageKey?: string;
836
+ }): ActionBuilder;
837
+ /**
838
+ * SendRefundTransactionEmail
839
+ *
840
+ * Creates a new Email record with the specified properties.
841
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
842
+ *
843
+ * @param properties - The properties for the new record
844
+ * @param options - Optional settings
845
+ * @param options.type - Override the record type
846
+ * @param options.journeyId - Associate with a journey
847
+ * @param options.stageKey - Set initial pipeline stage
848
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
849
+ *
850
+ * @example
851
+ * ```typescript
852
+ * // Create with properties
853
+ * const record = odinClient.emails.new();
854
+ * await record.sendRefundTransactionEmail({ ... }).execute();
855
+ *
856
+ * // Dry run (for debugging)
857
+ * const payload = record.sendRefundTransactionEmail({ ... }).dryRun();
858
+ * ```
859
+ */
860
+ sendRefundTransactionEmail(properties?: SendRefundTransactionEmailProperties, options?: {
861
+ type?: string;
862
+ journeyId?: string;
863
+ stageKey?: string;
864
+ }): ActionBuilder;
778
865
  /**
779
866
  * SendTlosNinjaCaseEmail
780
867
  *