@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
package/README.md CHANGED
@@ -351,7 +351,7 @@ This SDK includes **163** entities across **12** modules.
351
351
 
352
352
  ## Actions
353
353
 
354
- This SDK includes **600** actions.
354
+ This SDK includes **604** actions.
355
355
 
356
356
  ### Action Types
357
357
 
@@ -1205,6 +1205,9 @@ This SDK includes **600** actions.
1205
1205
  | `CreateOrderReferralReferrerPendingEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerPendingEmail |
1206
1206
  | `CreateOrderReferralReferrerQualifiedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderReferralReferrerQualifiedEmail |
1207
1207
  | `CreateTransactionalEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateTransactionalEmail |
1208
+ | `SendDirectDebitCreatedEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitCreatedEmail |
1209
+ | `SendDirectDebitSetupConfirmationEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendDirectDebitSetupConfirmationEmail |
1210
+ | `SendRefundTransactionEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendRefundTransactionEmail |
1208
1211
  | `SendTlosNinjaCaseEmail` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.SendTlosNinjaCaseEmail |
1209
1212
  | `UpdateEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateEmail |
1210
1213
  | `UpdateSupportEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.UpdateSupportEmail |
@@ -1657,6 +1660,12 @@ This SDK includes **600** actions.
1657
1660
  | `CreateVoiceConfiguration` | CREATE | k1.t-hEOJjsDb.ServiceModule.VoiceConfiguration.Create.CreateVoiceConfiguration |
1658
1661
  | `UpdateVoiceConfiguration` | UPDATE | k1.t-hEOJjsDb.ServiceModule.VoiceConfiguration.Update.UpdateVoiceConfiguration |
1659
1662
 
1663
+ #### Region
1664
+
1665
+ | Action | Type | Event |
1666
+ |--------|------|-------|
1667
+ | `CreateRegion` | CREATE | k1.t-hEOJjsDb.ProjectModule.Region.Create.CreateRegion |
1668
+
1660
1669
  #### SalesTerritory
1661
1670
 
1662
1671
  | Action | Type | Event |
@@ -93,6 +93,7 @@ import { PriceBookAccessor } from './accessors-v2/PriceBookAccessor';
93
93
  import { ProductAccessor } from './accessors-v2/ProductAccessor';
94
94
  import { PushNotificationAccessor } from './accessors-v2/PushNotificationAccessor';
95
95
  import { ReferralAccessor } from './accessors-v2/ReferralAccessor';
96
+ import { RegionAccessor } from './accessors-v2/RegionAccessor';
96
97
  import { RemediationOutcomeFormAccessor } from './accessors-v2/RemediationOutcomeFormAccessor';
97
98
  import { RemediationRequiredReasonAccessor } from './accessors-v2/RemediationRequiredReasonAccessor';
98
99
  import { ReturnsAccessor } from './accessors-v2/ReturnsAccessor';
@@ -205,6 +206,7 @@ export declare const EntityRegistry: {
205
206
  readonly Product: typeof ProductAccessor;
206
207
  readonly PushNotification: typeof PushNotificationAccessor;
207
208
  readonly Referral: typeof ReferralAccessor;
209
+ readonly Region: typeof RegionAccessor;
208
210
  readonly RemediationOutcomeForm: typeof RemediationOutcomeFormAccessor;
209
211
  readonly RemediationRequiredReason: typeof RemediationRequiredReasonAccessor;
210
212
  readonly Returns: typeof ReturnsAccessor;
@@ -96,6 +96,7 @@ const PriceBookAccessor_1 = require("./accessors-v2/PriceBookAccessor");
96
96
  const ProductAccessor_1 = require("./accessors-v2/ProductAccessor");
97
97
  const PushNotificationAccessor_1 = require("./accessors-v2/PushNotificationAccessor");
98
98
  const ReferralAccessor_1 = require("./accessors-v2/ReferralAccessor");
99
+ const RegionAccessor_1 = require("./accessors-v2/RegionAccessor");
99
100
  const RemediationOutcomeFormAccessor_1 = require("./accessors-v2/RemediationOutcomeFormAccessor");
100
101
  const RemediationRequiredReasonAccessor_1 = require("./accessors-v2/RemediationRequiredReasonAccessor");
101
102
  const ReturnsAccessor_1 = require("./accessors-v2/ReturnsAccessor");
@@ -208,6 +209,7 @@ exports.EntityRegistry = {
208
209
  'Product': ProductAccessor_1.ProductAccessor,
209
210
  'PushNotification': PushNotificationAccessor_1.PushNotificationAccessor,
210
211
  'Referral': ReferralAccessor_1.ReferralAccessor,
212
+ 'Region': RegionAccessor_1.RegionAccessor,
211
213
  'RemediationOutcomeForm': RemediationOutcomeFormAccessor_1.RemediationOutcomeFormAccessor,
212
214
  'RemediationRequiredReason': RemediationRequiredReasonAccessor_1.RemediationRequiredReasonAccessor,
213
215
  'Returns': ReturnsAccessor_1.ReturnsAccessor,
@@ -103,6 +103,7 @@ import { PriceBookAccessor } from './accessors-v2/PriceBookAccessor';
103
103
  import { ProductAccessor } from './accessors-v2/ProductAccessor';
104
104
  import { PushNotificationAccessor } from './accessors-v2/PushNotificationAccessor';
105
105
  import { ReferralAccessor } from './accessors-v2/ReferralAccessor';
106
+ import { RegionAccessor } from './accessors-v2/RegionAccessor';
106
107
  import { RemediationOutcomeFormAccessor } from './accessors-v2/RemediationOutcomeFormAccessor';
107
108
  import { RemediationRequiredReasonAccessor } from './accessors-v2/RemediationRequiredReasonAccessor';
108
109
  import { ReturnsAccessor } from './accessors-v2/ReturnsAccessor';
@@ -224,6 +225,7 @@ export declare class OdinApiClient {
224
225
  private _products?;
225
226
  private _pushNotifications?;
226
227
  private _referrals?;
228
+ private _regions?;
227
229
  private _remediationOutcomeForms?;
228
230
  private _remediationRequiredReasons?;
229
231
  private _returnses?;
@@ -428,6 +430,8 @@ export declare class OdinApiClient {
428
430
  get pushNotifications(): PushNotificationAccessor;
429
431
  /** Access Referral records */
430
432
  get referrals(): ReferralAccessor;
433
+ /** Access Region records */
434
+ get regions(): RegionAccessor;
431
435
  /** Access RemediationOutcomeForm records */
432
436
  get remediationOutcomeForms(): RemediationOutcomeFormAccessor;
433
437
  /** Access RemediationRequiredReason records */
@@ -114,6 +114,7 @@ const PriceBookAccessor_1 = require("./accessors-v2/PriceBookAccessor");
114
114
  const ProductAccessor_1 = require("./accessors-v2/ProductAccessor");
115
115
  const PushNotificationAccessor_1 = require("./accessors-v2/PushNotificationAccessor");
116
116
  const ReferralAccessor_1 = require("./accessors-v2/ReferralAccessor");
117
+ const RegionAccessor_1 = require("./accessors-v2/RegionAccessor");
117
118
  const RemediationOutcomeFormAccessor_1 = require("./accessors-v2/RemediationOutcomeFormAccessor");
118
119
  const RemediationRequiredReasonAccessor_1 = require("./accessors-v2/RemediationRequiredReasonAccessor");
119
120
  const ReturnsAccessor_1 = require("./accessors-v2/ReturnsAccessor");
@@ -745,6 +746,13 @@ class OdinApiClient {
745
746
  }
746
747
  return this._referrals;
747
748
  }
749
+ /** Access Region records */
750
+ get regions() {
751
+ if (!this._regions) {
752
+ this._regions = new RegionAccessor_1.RegionAccessor(this._provider);
753
+ }
754
+ return this._regions;
755
+ }
748
756
  /** Access RemediationOutcomeForm records */
749
757
  get remediationOutcomeForms() {
750
758
  if (!this._remediationOutcomeForms) {
@@ -110,6 +110,7 @@ import { PriceBookDbAccessor } from './db-accessors-v2/PriceBookDbAccessor';
110
110
  import { ProductDbAccessor } from './db-accessors-v2/ProductDbAccessor';
111
111
  import { PushNotificationDbAccessor } from './db-accessors-v2/PushNotificationDbAccessor';
112
112
  import { ReferralDbAccessor } from './db-accessors-v2/ReferralDbAccessor';
113
+ import { RegionDbAccessor } from './db-accessors-v2/RegionDbAccessor';
113
114
  import { RemediationOutcomeFormDbAccessor } from './db-accessors-v2/RemediationOutcomeFormDbAccessor';
114
115
  import { RemediationRequiredReasonDbAccessor } from './db-accessors-v2/RemediationRequiredReasonDbAccessor';
115
116
  import { ReturnsDbAccessor } from './db-accessors-v2/ReturnsDbAccessor';
@@ -225,6 +226,7 @@ export declare class OdinDbClient {
225
226
  private _products?;
226
227
  private _pushNotifications?;
227
228
  private _referrals?;
229
+ private _regions?;
228
230
  private _remediationOutcomeForms?;
229
231
  private _remediationRequiredReasons?;
230
232
  private _returnses?;
@@ -438,6 +440,8 @@ export declare class OdinDbClient {
438
440
  get pushNotifications(): PushNotificationDbAccessor;
439
441
  /** Access Referral records */
440
442
  get referrals(): ReferralDbAccessor;
443
+ /** Access Region records */
444
+ get regions(): RegionDbAccessor;
441
445
  /** Access RemediationOutcomeForm records */
442
446
  get remediationOutcomeForms(): RemediationOutcomeFormDbAccessor;
443
447
  /** Access RemediationRequiredReason records */
@@ -112,6 +112,7 @@ const PriceBookDbAccessor_1 = require("./db-accessors-v2/PriceBookDbAccessor");
112
112
  const ProductDbAccessor_1 = require("./db-accessors-v2/ProductDbAccessor");
113
113
  const PushNotificationDbAccessor_1 = require("./db-accessors-v2/PushNotificationDbAccessor");
114
114
  const ReferralDbAccessor_1 = require("./db-accessors-v2/ReferralDbAccessor");
115
+ const RegionDbAccessor_1 = require("./db-accessors-v2/RegionDbAccessor");
115
116
  const RemediationOutcomeFormDbAccessor_1 = require("./db-accessors-v2/RemediationOutcomeFormDbAccessor");
116
117
  const RemediationRequiredReasonDbAccessor_1 = require("./db-accessors-v2/RemediationRequiredReasonDbAccessor");
117
118
  const ReturnsDbAccessor_1 = require("./db-accessors-v2/ReturnsDbAccessor");
@@ -746,6 +747,13 @@ class OdinDbClient {
746
747
  }
747
748
  return this._referrals;
748
749
  }
750
+ /** Access Region records */
751
+ get regions() {
752
+ if (!this._regions) {
753
+ this._regions = new RegionDbAccessor_1.RegionDbAccessor(this._principal, this._dbService, this._defaultOptions);
754
+ }
755
+ return this._regions;
756
+ }
749
757
  /** Access RemediationOutcomeForm records */
750
758
  get remediationOutcomeForms() {
751
759
  if (!this._remediationOutcomeForms) {
@@ -0,0 +1,111 @@
1
+ /**
2
+ * Region Accessor
3
+ *
4
+ * Provides typed access to Region records via API.
5
+ * Returns wrapped records with typed action methods.
6
+ *
7
+ * @example
8
+ * ```typescript
9
+ * // Get existing record
10
+ * const record = await accessor.get(id);
11
+ * await record.updateRegion({ ... });
12
+ *
13
+ * // Create new record
14
+ * const newRecord = accessor.new();
15
+ * await newRecord.createRegion({ ... });
16
+ * ```
17
+ *
18
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
19
+ */
20
+ import { OdinSearchV2 } from '@d19n/odin-types/dist/core';
21
+ import { ApiProvider } from '@d19n/odin-sdk-generator/dist/api.provider';
22
+ import { OauthParams } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
23
+ import { QueryBuilder } from '@d19n/odin-sdk-generator/dist/query-builder';
24
+ import { RegionProperties } from '../entities-v2/Region';
25
+ import { RegionRecord } from '../records-v2/RegionRecord';
26
+ /** List response with wrapped records */
27
+ export interface RegionListResponse {
28
+ data: RegionRecord[];
29
+ hasMore: boolean;
30
+ totalRecords: number;
31
+ }
32
+ /** Search response with wrapped records */
33
+ export interface RegionSearchResponse {
34
+ records: RegionRecord[];
35
+ totalRecords: number;
36
+ hasMore: boolean;
37
+ }
38
+ export declare class RegionAccessor {
39
+ private readonly _provider;
40
+ private readonly _moduleName;
41
+ private readonly _entityName;
42
+ constructor(provider: ApiProvider);
43
+ constructor(authParams: OauthParams);
44
+ constructor(authToken: string, host?: string);
45
+ get moduleName(): string;
46
+ get entityName(): string;
47
+ /**
48
+ * Create a new empty Region record instance for create operations.
49
+ * Pre-generates an ID that can be referenced before the record is saved.
50
+ *
51
+ * @param id - Optional ID to use (auto-generated UUID if not provided)
52
+ * @returns A new record wrapper with pre-generated ID
53
+ *
54
+ * @example
55
+ * ```typescript
56
+ * // Auto-generated ID
57
+ * const note = odinClient.notes.new();
58
+ * console.log(note.id); // UUID available immediately
59
+ *
60
+ * // Custom ID
61
+ * const order = odinClient.orders.new("custom-id-123");
62
+ *
63
+ * // Reference ID before save
64
+ * const account = odinClient.accounts.new();
65
+ * const contact = odinClient.contacts.new();
66
+ * await contact
67
+ * .link({ id: account.id, entity: "CrmModule:Account" })
68
+ * .createContact({ FirstName: "John" });
69
+ * ```
70
+ */
71
+ new(id?: string): RegionRecord;
72
+ /**
73
+ * Get a single Region record by ID
74
+ */
75
+ get(id: string): Promise<RegionRecord>;
76
+ /**
77
+ * Get multiple Region records by IDs
78
+ */
79
+ getMany(ids: string[]): Promise<RegionRecord[]>;
80
+ /**
81
+ * Search Region records
82
+ */
83
+ search(params: Partial<OdinSearchV2>): Promise<RegionSearchResponse>;
84
+ /**
85
+ * Search all Region records with automatic pagination
86
+ */
87
+ searchAll(params: Partial<OdinSearchV2>): Promise<RegionRecord[]>;
88
+ /**
89
+ * Async generator for paginating through all matching records.
90
+ * Yields batches of wrapped records.
91
+ */
92
+ paginate(params: Partial<OdinSearchV2>): AsyncGenerator<RegionRecord[]>;
93
+ /**
94
+ * Create a fluent query builder for Region records
95
+ *
96
+ * @example
97
+ * ```typescript
98
+ * const results = await accessor
99
+ * .query()
100
+ * .where('Status', 'in', ['Active', 'Pending'])
101
+ * .where('CreatedAt', 'gte', '2025-01-01')
102
+ * .select('id', 'title', 'properties.*')
103
+ * .sortBy('createdAt', 'desc')
104
+ * .limit(100)
105
+ * .execute();
106
+ * ```
107
+ */
108
+ query(): QueryBuilder<RegionProperties, RegionRecord>;
109
+ /** Access the underlying ApiProvider */
110
+ get provider(): ApiProvider;
111
+ }
@@ -0,0 +1,190 @@
1
+ "use strict";
2
+ /**
3
+ * Region Accessor
4
+ *
5
+ * Provides typed access to Region records via API.
6
+ * Returns wrapped records with typed action methods.
7
+ *
8
+ * @example
9
+ * ```typescript
10
+ * // Get existing record
11
+ * const record = await accessor.get(id);
12
+ * await record.updateRegion({ ... });
13
+ *
14
+ * // Create new record
15
+ * const newRecord = accessor.new();
16
+ * await newRecord.createRegion({ ... });
17
+ * ```
18
+ *
19
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
20
+ */
21
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
22
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
23
+ return new (P || (P = Promise))(function (resolve, reject) {
24
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
25
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
26
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
27
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
28
+ });
29
+ };
30
+ var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
31
+ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
32
+ if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
33
+ var g = generator.apply(thisArg, _arguments || []), i, q = [];
34
+ return i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i;
35
+ function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }
36
+ function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
37
+ function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
38
+ function fulfill(value) { resume("next", value); }
39
+ function reject(value) { resume("throw", value); }
40
+ function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
41
+ };
42
+ Object.defineProperty(exports, "__esModule", { value: true });
43
+ exports.RegionAccessor = void 0;
44
+ const api_provider_1 = require("@d19n/odin-sdk-generator/dist/api.provider");
45
+ const query_builder_1 = require("@d19n/odin-sdk-generator/dist/query-builder");
46
+ const RegionRecord_1 = require("../records-v2/RegionRecord");
47
+ class RegionAccessor {
48
+ constructor(providerOrAuth, host) {
49
+ this._moduleName = 'ProjectModule';
50
+ this._entityName = 'Region';
51
+ if (providerOrAuth instanceof api_provider_1.ApiProvider) {
52
+ this._provider = providerOrAuth;
53
+ }
54
+ else if (typeof providerOrAuth === 'string') {
55
+ // Auth token provided
56
+ this._provider = new api_provider_1.ApiProvider(host ? { host } : undefined, providerOrAuth);
57
+ }
58
+ else {
59
+ // OauthParams provided
60
+ this._provider = new api_provider_1.ApiProvider(providerOrAuth);
61
+ }
62
+ }
63
+ get moduleName() { return this._moduleName; }
64
+ get entityName() { return this._entityName; }
65
+ // ============================================
66
+ // RECORD CREATION
67
+ // ============================================
68
+ /**
69
+ * Create a new empty Region record instance for create operations.
70
+ * Pre-generates an ID that can be referenced before the record is saved.
71
+ *
72
+ * @param id - Optional ID to use (auto-generated UUID if not provided)
73
+ * @returns A new record wrapper with pre-generated ID
74
+ *
75
+ * @example
76
+ * ```typescript
77
+ * // Auto-generated ID
78
+ * const note = odinClient.notes.new();
79
+ * console.log(note.id); // UUID available immediately
80
+ *
81
+ * // Custom ID
82
+ * const order = odinClient.orders.new("custom-id-123");
83
+ *
84
+ * // Reference ID before save
85
+ * const account = odinClient.accounts.new();
86
+ * const contact = odinClient.contacts.new();
87
+ * await contact
88
+ * .link({ id: account.id, entity: "CrmModule:Account" })
89
+ * .createContact({ FirstName: "John" });
90
+ * ```
91
+ */
92
+ new(id) {
93
+ return new RegionRecord_1.RegionRecord(null, this._provider, id);
94
+ }
95
+ // ============================================
96
+ // RECORD RETRIEVAL
97
+ // ============================================
98
+ /**
99
+ * Get a single Region record by ID
100
+ */
101
+ get(id) {
102
+ return __awaiter(this, void 0, void 0, function* () {
103
+ const record = yield this._provider._getByPrimaryKey(this._moduleName, this._entityName, id);
104
+ return new RegionRecord_1.RegionRecord(record, this._provider);
105
+ });
106
+ }
107
+ /**
108
+ * Get multiple Region records by IDs
109
+ */
110
+ getMany(ids) {
111
+ return __awaiter(this, void 0, void 0, function* () {
112
+ if (ids.length === 0)
113
+ return [];
114
+ const records = yield this._provider._getManyByPrimaryKey(this._moduleName, this._entityName, ids);
115
+ return records.map((r) => new RegionRecord_1.RegionRecord(r, this._provider));
116
+ });
117
+ }
118
+ // ============================================
119
+ // SEARCH OPERATIONS
120
+ // ============================================
121
+ /**
122
+ * Search Region records
123
+ */
124
+ search(params) {
125
+ return __awaiter(this, void 0, void 0, function* () {
126
+ const result = yield this._provider._searchRecords(this._moduleName, this._entityName, params);
127
+ return {
128
+ records: result.records.map((r) => new RegionRecord_1.RegionRecord(r, this._provider)),
129
+ totalRecords: result.totalRecords,
130
+ hasMore: result.hasMore,
131
+ };
132
+ });
133
+ }
134
+ /**
135
+ * Search all Region records with automatic pagination
136
+ */
137
+ searchAll(params) {
138
+ return __awaiter(this, void 0, void 0, function* () {
139
+ const result = yield this._provider._searchAllRecordsAndPaginate(this._moduleName, this._entityName, params);
140
+ return result.records.map((r) => new RegionRecord_1.RegionRecord(r, this._provider));
141
+ });
142
+ }
143
+ /**
144
+ * Async generator for paginating through all matching records.
145
+ * Yields batches of wrapped records.
146
+ */
147
+ paginate(params) {
148
+ var _a;
149
+ return __asyncGenerator(this, arguments, function* paginate_1() {
150
+ let hasMore = true;
151
+ let searchAfter;
152
+ const query = Object.assign(Object.assign({}, params.query), { pageSize: ((_a = params.query) === null || _a === void 0 ? void 0 : _a.pageSize) || 500 });
153
+ while (hasMore) {
154
+ const result = yield __await(this._provider._searchRecords(this._moduleName, this._entityName, Object.assign(Object.assign({}, params), { query: Object.assign(Object.assign({}, query), { searchAfter }) })));
155
+ if (result.records.length > 0) {
156
+ yield yield __await(result.records.map((r) => new RegionRecord_1.RegionRecord(r, this._provider)));
157
+ const lastRecord = result.records[result.records.length - 1];
158
+ searchAfter = lastRecord === null || lastRecord === void 0 ? void 0 : lastRecord.sort;
159
+ }
160
+ hasMore = result.hasMore && result.records.length >= query.pageSize;
161
+ }
162
+ });
163
+ }
164
+ // ============================================
165
+ // QUERY BUILDER
166
+ // ============================================
167
+ /**
168
+ * Create a fluent query builder for Region records
169
+ *
170
+ * @example
171
+ * ```typescript
172
+ * const results = await accessor
173
+ * .query()
174
+ * .where('Status', 'in', ['Active', 'Pending'])
175
+ * .where('CreatedAt', 'gte', '2025-01-01')
176
+ * .select('id', 'title', 'properties.*')
177
+ * .sortBy('createdAt', 'desc')
178
+ * .limit(100)
179
+ * .execute();
180
+ * ```
181
+ */
182
+ query() {
183
+ return (0, query_builder_1.createQueryBuilder)(this);
184
+ }
185
+ /** Access the underlying ApiProvider */
186
+ get provider() {
187
+ return this._provider;
188
+ }
189
+ }
190
+ exports.RegionAccessor = RegionAccessor;
@@ -88,6 +88,7 @@ export { PriceBookAccessor, PriceBookSearchResponse, PriceBookListResponse } fro
88
88
  export { ProductAccessor, ProductSearchResponse, ProductListResponse } from './ProductAccessor';
89
89
  export { PushNotificationAccessor, PushNotificationSearchResponse, PushNotificationListResponse } from './PushNotificationAccessor';
90
90
  export { ReferralAccessor, ReferralSearchResponse, ReferralListResponse } from './ReferralAccessor';
91
+ export { RegionAccessor, RegionSearchResponse, RegionListResponse } from './RegionAccessor';
91
92
  export { RemediationOutcomeFormAccessor, RemediationOutcomeFormSearchResponse, RemediationOutcomeFormListResponse } from './RemediationOutcomeFormAccessor';
92
93
  export { RemediationRequiredReasonAccessor, RemediationRequiredReasonSearchResponse, RemediationRequiredReasonListResponse } from './RemediationRequiredReasonAccessor';
93
94
  export { ReturnsAccessor, ReturnsSearchResponse, ReturnsListResponse } from './ReturnsAccessor';
@@ -9,8 +9,8 @@
9
9
  */
10
10
  Object.defineProperty(exports, "__esModule", { value: true });
11
11
  exports.OhExternalAuditAccessor = exports.OhAuditOfInstallationAccessor = exports.OfferAccessor = exports.NoteAccessor = exports.NetworkDeviceAccessor = exports.MessageAccessor = exports.LeadAccessor = exports.KnowledgeArticleAccessor = exports.InvoiceAccessor = exports.InvoiceItemAccessor = exports.InternalInstallAuditAccessor = exports.ImpersonationTrackerAccessor = exports.FieldServiceProductAccessor = exports.FieldServiceDispatchedProductAccessor = exports.ExchangeAccessor = exports.EmailTemplateAccessor = exports.EmailSenderAccessor = exports.EmailAccessor = exports.DiscountAccessor = exports.CustomerPhonePortingAccessor = exports.CustomerDeviceRouterAccessor = exports.CustomerDeviceOntAccessor = exports.CustomerDeviceConfigurationAccessor = exports.CustomerDeviceAtaAccessor = exports.CrmDatasetAccessor = exports.CreditNoteAccessor = exports.ConversationAccessor = exports.ContractBuyOutAccessor = exports.ContactAccessor = exports.ConfigAccessor = exports.ChurnRequestAccessor = exports.ChangeReasonAccessor = exports.CaseAccessor = exports.CampaignAccessor = exports.CallTransferAccessor = exports.CallAccessor = exports.CallLegAccessor = exports.CallEventAccessor = exports.BrskEntityMigrationErrorAccessor = exports.BngProvisionAccessor = exports.BlockageA55Accessor = exports.BillingRequestAccessor = exports.BillingAdjustmentAccessor = exports.AppointmentAccessor = exports.AffiliateCodeAccessor = exports.AddressAccessor = exports.ActivityAccessor = exports.ActivityLogAccessor = exports.AccountAccessor = exports.AccountCreditAccessor = void 0;
12
- exports.UgAuditOfInstallationAccessor = exports.TwilioTaskQueueAccessor = exports.TransactionAccessor = exports.TimeSlotAccessor = exports.TeamAccessor = exports.SweeperMaintenanceAuditAccessor = exports.SmsMessageAccessor = exports.SiteSpecificRiskAssessmentOutcomeFormAccessor = exports.ServiceVisitAuditAccessor = exports.ServiceAccessor = exports.ServiceAppointmentAccessor = exports.ServiceAppointmentConfigAccessor = exports.ScheduleSlotAccessor = exports.SalesTerritoryAccessor = exports.RewardAccessor = exports.ReturnsAccessor = exports.RemediationRequiredReasonAccessor = exports.RemediationOutcomeFormAccessor = exports.ReferralAccessor = exports.PushNotificationAccessor = exports.ProductAccessor = exports.PriceBookAccessor = exports.PgWebhookAccessor = exports.PgWebhookAttemptAccessor = exports.PgVocalinkAccessor = exports.PgTransactionAccessor = exports.PgSortCodeSubstitutionAccessor = exports.PgPaymentMethodAccessor = exports.PgLogAccessor = exports.PgFileAllocationAccessor = exports.PgDisputeAccessor = exports.PgDirectDebitFileAccessor = exports.PgContactAccessor = exports.PgAccountValidationAccessor = exports.PermissionToFailAccessor = exports.PaymentAccessor = exports.PaymentMethodRefundAccessor = exports.PaymentMethodAccessor = exports.PICRequestAccessor = exports.OverlayRealA55Accessor = exports.OutageAccessor = exports.OrderAccessor = exports.OrderKciAccessor = exports.OrderItemAccessor = exports.OrderCheckAccessor = exports.OntReplacementApprovalAccessor = exports.OneTouchSwitchAccessor = exports.OhRetroAuditAccessor = exports.OhInstallationAuditAccessor = exports.OhInProgressAuditAccessor = void 0;
13
- exports.YfFieldServiceVisitAccessor = exports.WorkOrderStatusUpdateAccessor = exports.WorkOrderAccessor = exports.WayleaveAuditAccessor = exports.VoiceConfigurationAccessor = exports.VisitAccessor = exports.UserAccessor = exports.UgRetroAuditAccessor = exports.UgInstallationAuditAccessor = exports.UgInProgressAuditAccessor = exports.UgExternalAuditAccessor = void 0;
12
+ exports.TwilioTaskQueueAccessor = exports.TransactionAccessor = exports.TimeSlotAccessor = exports.TeamAccessor = exports.SweeperMaintenanceAuditAccessor = exports.SmsMessageAccessor = exports.SiteSpecificRiskAssessmentOutcomeFormAccessor = exports.ServiceVisitAuditAccessor = exports.ServiceAccessor = exports.ServiceAppointmentAccessor = exports.ServiceAppointmentConfigAccessor = exports.ScheduleSlotAccessor = exports.SalesTerritoryAccessor = exports.RewardAccessor = exports.ReturnsAccessor = exports.RemediationRequiredReasonAccessor = exports.RemediationOutcomeFormAccessor = exports.RegionAccessor = exports.ReferralAccessor = exports.PushNotificationAccessor = exports.ProductAccessor = exports.PriceBookAccessor = exports.PgWebhookAccessor = exports.PgWebhookAttemptAccessor = exports.PgVocalinkAccessor = exports.PgTransactionAccessor = exports.PgSortCodeSubstitutionAccessor = exports.PgPaymentMethodAccessor = exports.PgLogAccessor = exports.PgFileAllocationAccessor = exports.PgDisputeAccessor = exports.PgDirectDebitFileAccessor = exports.PgContactAccessor = exports.PgAccountValidationAccessor = exports.PermissionToFailAccessor = exports.PaymentAccessor = exports.PaymentMethodRefundAccessor = exports.PaymentMethodAccessor = exports.PICRequestAccessor = exports.OverlayRealA55Accessor = exports.OutageAccessor = exports.OrderAccessor = exports.OrderKciAccessor = exports.OrderItemAccessor = exports.OrderCheckAccessor = exports.OntReplacementApprovalAccessor = exports.OneTouchSwitchAccessor = exports.OhRetroAuditAccessor = exports.OhInstallationAuditAccessor = exports.OhInProgressAuditAccessor = void 0;
13
+ exports.YfFieldServiceVisitAccessor = exports.WorkOrderStatusUpdateAccessor = exports.WorkOrderAccessor = exports.WayleaveAuditAccessor = exports.VoiceConfigurationAccessor = exports.VisitAccessor = exports.UserAccessor = exports.UgRetroAuditAccessor = exports.UgInstallationAuditAccessor = exports.UgInProgressAuditAccessor = exports.UgExternalAuditAccessor = exports.UgAuditOfInstallationAccessor = void 0;
14
14
  var AccountCreditAccessor_1 = require("./AccountCreditAccessor");
15
15
  Object.defineProperty(exports, "AccountCreditAccessor", { enumerable: true, get: function () { return AccountCreditAccessor_1.AccountCreditAccessor; } });
16
16
  var AccountAccessor_1 = require("./AccountAccessor");
@@ -175,6 +175,8 @@ var PushNotificationAccessor_1 = require("./PushNotificationAccessor");
175
175
  Object.defineProperty(exports, "PushNotificationAccessor", { enumerable: true, get: function () { return PushNotificationAccessor_1.PushNotificationAccessor; } });
176
176
  var ReferralAccessor_1 = require("./ReferralAccessor");
177
177
  Object.defineProperty(exports, "ReferralAccessor", { enumerable: true, get: function () { return ReferralAccessor_1.ReferralAccessor; } });
178
+ var RegionAccessor_1 = require("./RegionAccessor");
179
+ Object.defineProperty(exports, "RegionAccessor", { enumerable: true, get: function () { return RegionAccessor_1.RegionAccessor; } });
178
180
  var RemediationOutcomeFormAccessor_1 = require("./RemediationOutcomeFormAccessor");
179
181
  Object.defineProperty(exports, "RemediationOutcomeFormAccessor", { enumerable: true, get: function () { return RemediationOutcomeFormAccessor_1.RemediationOutcomeFormAccessor; } });
180
182
  var RemediationRequiredReasonAccessor_1 = require("./RemediationRequiredReasonAccessor");
@@ -40,6 +40,13 @@ export interface CaseCreateNoteProperties {
40
40
  * @type {TEXT_LONG}
41
41
  */
42
42
  Body?: string | null;
43
+ /**
44
+ * Case
45
+ *
46
+ * Data field for Note records. Used by Customer Service team.
47
+ * @type {LOOKUP}
48
+ */
49
+ Case?: string | null;
43
50
  }
44
51
  /**
45
52
  * CaseCreateNote
@@ -33,6 +33,14 @@ export interface CreateActivityLogEntryProperties {
33
33
  * @required
34
34
  */
35
35
  Priority: string;
36
+ /**
37
+ * Type
38
+ *
39
+ * the type of activity being recorded INFO, WARNING etc. (Compliance - ActivityLog)
40
+ * @type {ENUM}
41
+ * @required
42
+ */
43
+ Type: string;
36
44
  /**
37
45
  * Summary
38
46
  *
@@ -33,6 +33,14 @@ export interface CreateAppointmentProperties {
33
33
  * @required
34
34
  */
35
35
  MeetingTitle: string;
36
+ /**
37
+ * Type
38
+ *
39
+ * Appointment type (Sales - Appointment)
40
+ * @type {ENUM}
41
+ * @required
42
+ */
43
+ Type: string;
36
44
  /**
37
45
  * Date
38
46
  *
@@ -34,6 +34,15 @@ export interface CreateBillingRequestTransactionProperties {
34
34
  * @default CREATED
35
35
  */
36
36
  Status: string;
37
+ /**
38
+ * Type
39
+ *
40
+ * type of transaction (Finance - Transaction)
41
+ * @type {ENUM}
42
+ * @required
43
+ * @default BILLING_REQUEST
44
+ */
45
+ Type: string;
37
46
  /**
38
47
  * Amount
39
48
  *
@@ -34,6 +34,14 @@ export interface CreateBundleProductActionProperties {
34
34
  * @required
35
35
  */
36
36
  Category: string;
37
+ /**
38
+ * Type
39
+ *
40
+ * type of product (Product Management - Product)
41
+ * @type {ENUM}
42
+ * @required
43
+ */
44
+ Type: string;
37
45
  /**
38
46
  * CustomerType
39
47
  *
@@ -22,8 +22,8 @@ export interface CreateInstallMessage extends OdinRecordCreatedEvent<CreateInsta
22
22
  /**
23
23
  * Properties for CreateINSTALL action
24
24
  *
25
- * @property Required fields: 4
26
- * @property Optional fields: 7
25
+ * @property Required fields: 3
26
+ * @property Optional fields: 8
27
27
  */
28
28
  export interface CreateInstallProperties {
29
29
  /**
@@ -51,14 +51,6 @@ export interface CreateInstallProperties {
51
51
  * @required
52
52
  */
53
53
  Contractor: string;
54
- /**
55
- * Region
56
- *
57
- * The linked region (Field Operations - ServiceAppointmentConfig)
58
- * @type {LOOKUP}
59
- * @required
60
- */
61
- RegionId: string;
62
54
  /**
63
55
  * ExPolygonId
64
56
  *
@@ -81,6 +73,13 @@ export interface CreateInstallProperties {
81
73
  * @format DD/MM/YYYY
82
74
  */
83
75
  AvailableTo?: string | null;
76
+ /**
77
+ * Region
78
+ *
79
+ * The linked region (Field Operations - ServiceAppointmentConfig)
80
+ * @type {LOOKUP}
81
+ */
82
+ RegionId?: string | null;
84
83
  /**
85
84
  * BookingDelay
86
85
  *
@@ -34,6 +34,14 @@ export interface CreateInternetProductActionProperties {
34
34
  * @required
35
35
  */
36
36
  Category: string;
37
+ /**
38
+ * Type
39
+ *
40
+ * type of product (Product Management - Product)
41
+ * @type {ENUM}
42
+ * @required
43
+ */
44
+ Type: string;
37
45
  /**
38
46
  * CustomerType
39
47
  *
@@ -34,6 +34,14 @@ export interface CreateLaborProductActionProperties {
34
34
  * @required
35
35
  */
36
36
  Category: string;
37
+ /**
38
+ * Type
39
+ *
40
+ * type of product (Product Management - Product)
41
+ * @type {ENUM}
42
+ * @required
43
+ */
44
+ Type: string;
37
45
  /**
38
46
  * CustomerType
39
47
  *