@d19n/youfibre-odin-sdk 2.0.384 → 2.0.385

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.
package/README.md CHANGED
@@ -406,7 +406,7 @@ This SDK includes **213** entities across **13** modules.
406
406
 
407
407
  ## Actions
408
408
 
409
- This SDK includes **951** actions.
409
+ This SDK includes **952** actions.
410
410
 
411
411
  ### Action Types
412
412
 
@@ -1678,6 +1678,7 @@ This SDK includes **951** actions.
1678
1678
  | `CreateCustomerDeviceBattery` | CREATE | k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Create.CreateCustomerDeviceBattery |
1679
1679
  | `CreateCustomerDeviceTvDevice` | CREATE | k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Create.CreateCustomerDeviceTvDevice |
1680
1680
  | `UpdateCustomerDeviceBattery` | UPDATE | k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceBattery |
1681
+ | `UpdateCustomerDeviceTvDevice` | UPDATE | k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice |
1681
1682
 
1682
1683
  #### CustomerDeviceConfiguration
1683
1684
 
@@ -0,0 +1,84 @@
1
+ /**
2
+ * UpdateCustomerDeviceTvDevice Action DTO
3
+ *
4
+ * Correct the serial number or MAC address on a TV box.
5
+ *
6
+ * @module ServiceModule
7
+ * @entity CustomerDevice
8
+ * @entityType TV_DEVICE
9
+ * @actionKey UpdateCustomerDeviceTvDevice
10
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecord, OdinRecordUpdateDto, OdinRecordUpdatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for UpdateCustomerDeviceTvDevice updated events
17
+ *
18
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice
19
+ */
20
+ export interface UpdateCustomerDeviceTvDeviceMessage extends OdinRecordUpdatedEvent<UpdateCustomerDeviceTvDeviceDto, UpdateCustomerDeviceTvDeviceProperties> {
21
+ }
22
+ /**
23
+ * Properties for UpdateCustomerDeviceTvDevice action
24
+ *
25
+ * @property Required fields: 0
26
+ * @property Optional fields: 2
27
+ */
28
+ export interface UpdateCustomerDeviceTvDeviceProperties {
29
+ /**
30
+ * Serial Number
31
+ *
32
+ * Serial Number
33
+ * @type {TEXT}
34
+ */
35
+ SerialNumber?: string | null;
36
+ /**
37
+ * MAC Address
38
+ *
39
+ * Mac Address
40
+ * @type {TEXT}
41
+ */
42
+ MacAddress?: string | null;
43
+ }
44
+ /**
45
+ * UpdateCustomerDeviceTvDevice
46
+ *
47
+ * Correct the serial number or MAC address on a TV box.
48
+ *
49
+ * @actionType UPDATE - Updates an existing CustomerDevice record
50
+ * @module ServiceModule
51
+ * @entity CustomerDevice
52
+ * @entityType TV_DEVICE (TV Device)
53
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice
54
+ * @permission schema.action.updatecustomerdevicetvdevice.trigger
55
+ * @benchmark This action is tracked for performance benchmarks
56
+ */
57
+ export declare class UpdateCustomerDeviceTvDeviceDto extends OdinRecordUpdateDto<UpdateCustomerDeviceTvDeviceProperties> {
58
+ /** Used by SDK generators to identify action type */
59
+ static readonly ACTION_TYPE = "UPDATE";
60
+ static readonly ACTION_KEY = "UpdateCustomerDeviceTvDevice";
61
+ static readonly MODULE_NAME = "ServiceModule";
62
+ static readonly ENTITIES: string[];
63
+ static readonly ENTITY_TYPE = "TV_DEVICE";
64
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice";
65
+ static readonly PERMISSION = "schema.action.updatecustomerdevicetvdevice.trigger";
66
+ /** Step metadata - entity this action targets */
67
+ static readonly STEP_ENTITY = "ServiceModule:CustomerDevice";
68
+ static readonly STEP_SCHEMA_ID = "a72ffce5-0294-4038-8fb1-45fad5e4e473";
69
+ static readonly STEP_SCHEMA_ACTION_ID = "070ff180-6dc3-46b4-807a-8c61a743306f";
70
+ static readonly STEP_SCHEMA_TYPE_ID = "4245a2ef-9255-49c0-af63-96bf8cde26aa";
71
+ static readonly STEP_TYPE = "TV_DEVICE";
72
+ static readonly AUTO_LINK_PARENT = false;
73
+ readonly actionName: string;
74
+ readonly schemaActionId: string;
75
+ readonly entity: string;
76
+ constructor(record: OdinRecord<any> | {
77
+ id: string;
78
+ entity: string;
79
+ type?: string;
80
+ }, properties: UpdateCustomerDeviceTvDeviceProperties, options?: {
81
+ journeyId?: string;
82
+ stageKey?: string;
83
+ });
84
+ }
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /**
3
+ * UpdateCustomerDeviceTvDevice Action DTO
4
+ *
5
+ * Correct the serial number or MAC address on a TV box.
6
+ *
7
+ * @module ServiceModule
8
+ * @entity CustomerDevice
9
+ * @entityType TV_DEVICE
10
+ * @actionKey UpdateCustomerDeviceTvDevice
11
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.UpdateCustomerDeviceTvDeviceDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * UpdateCustomerDeviceTvDevice
20
+ *
21
+ * Correct the serial number or MAC address on a TV box.
22
+ *
23
+ * @actionType UPDATE - Updates an existing CustomerDevice record
24
+ * @module ServiceModule
25
+ * @entity CustomerDevice
26
+ * @entityType TV_DEVICE (TV Device)
27
+ * @event k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice
28
+ * @permission schema.action.updatecustomerdevicetvdevice.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class UpdateCustomerDeviceTvDeviceDto extends core_1.OdinRecordUpdateDto {
32
+ constructor(record, properties, options) {
33
+ super({
34
+ id: record.id,
35
+ entity: record.entity,
36
+ type: record.type,
37
+ properties,
38
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
39
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
40
+ });
41
+ this.actionName = 'UpdateCustomerDeviceTvDevice';
42
+ this.schemaActionId = '070ff180-6dc3-46b4-807a-8c61a743306f';
43
+ this.entity = 'ServiceModule:CustomerDevice';
44
+ }
45
+ }
46
+ exports.UpdateCustomerDeviceTvDeviceDto = UpdateCustomerDeviceTvDeviceDto;
47
+ /** Used by SDK generators to identify action type */
48
+ UpdateCustomerDeviceTvDeviceDto.ACTION_TYPE = 'UPDATE';
49
+ UpdateCustomerDeviceTvDeviceDto.ACTION_KEY = 'UpdateCustomerDeviceTvDevice';
50
+ UpdateCustomerDeviceTvDeviceDto.MODULE_NAME = 'ServiceModule';
51
+ UpdateCustomerDeviceTvDeviceDto.ENTITIES = ['CustomerDevice'];
52
+ UpdateCustomerDeviceTvDeviceDto.ENTITY_TYPE = 'TV_DEVICE';
53
+ UpdateCustomerDeviceTvDeviceDto.EVENT_NAME = 'k1.t-hEOJjsDb.ServiceModule.CustomerDevice.Update.UpdateCustomerDeviceTvDevice';
54
+ UpdateCustomerDeviceTvDeviceDto.PERMISSION = 'schema.action.updatecustomerdevicetvdevice.trigger';
55
+ /** Step metadata - entity this action targets */
56
+ UpdateCustomerDeviceTvDeviceDto.STEP_ENTITY = 'ServiceModule:CustomerDevice';
57
+ UpdateCustomerDeviceTvDeviceDto.STEP_SCHEMA_ID = 'a72ffce5-0294-4038-8fb1-45fad5e4e473';
58
+ UpdateCustomerDeviceTvDeviceDto.STEP_SCHEMA_ACTION_ID = '070ff180-6dc3-46b4-807a-8c61a743306f';
59
+ UpdateCustomerDeviceTvDeviceDto.STEP_SCHEMA_TYPE_ID = '4245a2ef-9255-49c0-af63-96bf8cde26aa';
60
+ UpdateCustomerDeviceTvDeviceDto.STEP_TYPE = 'TV_DEVICE';
61
+ UpdateCustomerDeviceTvDeviceDto.AUTO_LINK_PARENT = false;
@@ -17,9 +17,9 @@ export declare class RouterPingSnapshotApi extends ApiProvider {
17
17
  private readonly moduleName;
18
18
  private readonly entityName;
19
19
  private sourceRecord;
20
- private _routerpingsnapshot?;
20
+ private _customerdevicerouter?;
21
21
  constructor(authParams?: OauthParams, authToken?: string);
22
- get routerpingsnapshot(): ApiRecordLinkManager;
22
+ get customerdevicerouter(): ApiRecordLinkManager;
23
23
  setRecord(sourceRecord: any): void;
24
24
  schema(): Promise<import("@d19n/odin-types/dist/core").OdinSchema>;
25
25
  search(params: Partial<OdinSearchV2>): Promise<import("@d19n/odin-sdk-generator/dist/odin-sdk-types").OdinSearchResponse<import("@d19n/odin-types/dist/core").OdinRecord<RouterPingSnapshotProperties>>>;
@@ -33,11 +33,11 @@ class RouterPingSnapshotApi extends api_provider_1.ApiProvider {
33
33
  // LAZY-LOADED LINK MANAGERS (Public Getters)
34
34
  // ============================================
35
35
  // Usage remains identical: api.address.list(recordId)
36
- get routerpingsnapshot() {
37
- if (!this._routerpingsnapshot) {
38
- this._routerpingsnapshot = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'ServiceModule:RouterPingSnapshot', 'ServiceModule:RouterPingSnapshot', 'CustomerDeviceRouter__RouterPingSnapshot');
36
+ get customerdevicerouter() {
37
+ if (!this._customerdevicerouter) {
38
+ this._customerdevicerouter = new api_record_link_manager_1.ApiRecordLinkManager(this.authParams, 'ServiceModule:RouterPingSnapshot', 'ServiceModule:CustomerDeviceRouter', 'CustomerDeviceRouter__RouterPingSnapshot');
39
39
  }
40
- return this._routerpingsnapshot;
40
+ return this._customerdevicerouter;
41
41
  }
42
42
  // ============================================
43
43
  // STANDARD METHODS (Unchanged API)
@@ -21,9 +21,9 @@ export declare class RouterPingSnapshotDb extends DbProvider {
21
21
  private readonly moduleName;
22
22
  private readonly entityName;
23
23
  private sourceRecord;
24
- private _customerdevicerouter?;
24
+ private _routerpingsnapshot?;
25
25
  constructor(principal: any, dbService: any, defaultOptions?: DbProviderOptions);
26
- get customerdevicerouter(): DbRecordLinkManager;
26
+ get routerpingsnapshot(): DbRecordLinkManager;
27
27
  setRecord(sourceRecord: any): void;
28
28
  /**
29
29
  * Search records with manual pagination control
@@ -38,11 +38,11 @@ class RouterPingSnapshotDb extends db_provider_1.DbProvider {
38
38
  // LAZY-LOADED LINK MANAGERS (Public Getters)
39
39
  // ============================================
40
40
  // Usage remains identical: db.address.list(recordId)
41
- get customerdevicerouter() {
42
- if (!this._customerdevicerouter) {
43
- this._customerdevicerouter = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'ServiceModule:RouterPingSnapshot', 'ServiceModule:CustomerDeviceRouter', 'CustomerDeviceRouter__RouterPingSnapshot');
41
+ get routerpingsnapshot() {
42
+ if (!this._routerpingsnapshot) {
43
+ this._routerpingsnapshot = new db_record_link_manager_1.DbRecordLinkManager(this.principal, this.dbService, 'ServiceModule:RouterPingSnapshot', 'ServiceModule:RouterPingSnapshot', 'CustomerDeviceRouter__RouterPingSnapshot');
44
44
  }
45
- return this._customerdevicerouter;
45
+ return this._routerpingsnapshot;
46
46
  }
47
47
  // ============================================
48
48
  // STANDARD METHODS
@@ -49,7 +49,9 @@ export declare enum CustomerDevicePropertyKeys {
49
49
  /** Serial Number */
50
50
  SerialNumber = "SerialNumber",
51
51
  /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405). */
52
- Version = "Version"
52
+ Version = "Version",
53
+ /** Set automatically from the device type, MAC and serial, e.g. "TV - AA:BB:CC:DD:EE:FF (SN123)". Do not type it: every device save rewrites it. */
54
+ Name = "Name"
53
55
  }
54
56
  /**
55
57
  * Properties for CustomerDevice records
@@ -74,6 +76,12 @@ export interface CustomerDeviceProperties {
74
76
  * @enum {CustomerDeviceVersion}
75
77
  */
76
78
  Version: CustomerDeviceVersion;
79
+ /** Set automatically from the device type, MAC and serial, e.g. "TV - AA:BB:CC:DD:EE:FF (SN123)". Do not type it: every device save rewrites it.
80
+ *
81
+ * @type {TEXT}
82
+ * @default
83
+ */
84
+ Name: string;
77
85
  }
78
86
  /**
79
87
  * Properties for BATTERY CustomerDevice records
@@ -98,6 +106,12 @@ export interface BatteryCustomerDeviceProperties {
98
106
  * @enum {CustomerDeviceVersion}
99
107
  */
100
108
  Version: CustomerDeviceVersion;
109
+ /** Set automatically from the device type, MAC and serial, e.g. "TV - AA:BB:CC:DD:EE:FF (SN123)". Do not type it: every device save rewrites it.
110
+ *
111
+ * @type {TEXT}
112
+ * @default
113
+ */
114
+ Name: string;
101
115
  }
102
116
  /**
103
117
  * Properties for TV_DEVICE CustomerDevice records
@@ -122,6 +136,12 @@ export interface TvDeviceCustomerDeviceProperties {
122
136
  * @enum {CustomerDeviceVersion}
123
137
  */
124
138
  Version: CustomerDeviceVersion;
139
+ /** Set automatically from the device type, MAC and serial, e.g. "TV - AA:BB:CC:DD:EE:FF (SN123)". Do not type it: every device save rewrites it.
140
+ *
141
+ * @type {TEXT}
142
+ * @default
143
+ */
144
+ Name: string;
125
145
  }
126
146
  /**
127
147
  * CustomerDevice entity from ServiceModule
@@ -52,6 +52,8 @@ var CustomerDevicePropertyKeys;
52
52
  CustomerDevicePropertyKeys["SerialNumber"] = "SerialNumber";
53
53
  /** Which TV box this is: the original BetterTV box (V1) or the Pleio box (V2) (PORTAPP-3405). */
54
54
  CustomerDevicePropertyKeys["Version"] = "Version";
55
+ /** Set automatically from the device type, MAC and serial, e.g. "TV - AA:BB:CC:DD:EE:FF (SN123)". Do not type it: every device save rewrites it. */
56
+ CustomerDevicePropertyKeys["Name"] = "Name";
55
57
  })(CustomerDevicePropertyKeys = exports.CustomerDevicePropertyKeys || (exports.CustomerDevicePropertyKeys = {}));
56
58
  /**
57
59
  * CustomerDevice entity from ServiceModule