@d19n/youfibre-odin-sdk 2.0.336 → 2.0.337

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
@@ -379,7 +379,7 @@ This SDK includes **191** entities across **12** modules.
379
379
 
380
380
  ## Actions
381
381
 
382
- This SDK includes **895** actions.
382
+ This SDK includes **896** actions.
383
383
 
384
384
  ### Action Types
385
385
 
@@ -1418,6 +1418,7 @@ This SDK includes **895** actions.
1418
1418
  | `CreateFailedInvoicePayment` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateFailedInvoicePayment |
1419
1419
  | `CreateGenericRemediationRequired` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateGenericRemediationRequired |
1420
1420
  | `CreateInboundSupportEmail` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Email.Update.CreateInboundSupportEmail |
1421
+ | `CreateInstallDayBeforeWifiEducation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation |
1421
1422
  | `CreateNewCreditNote` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateNewCreditNote |
1422
1423
  | `CreateNewInvoice` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateNewInvoice |
1423
1424
  | `CreateOrderConfirmation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateOrderConfirmation |
@@ -0,0 +1,63 @@
1
+ /**
2
+ * CreateInstallDayBeforeWifiEducation Action DTO
3
+ *
4
+ * Create install day-before Wi-Fi education email
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Email
8
+ * @entityType TRANSACTIONAL
9
+ * @actionKey CreateInstallDayBeforeWifiEducation
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
11
+ *
12
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
13
+ */
14
+ import { OdinRecordCreateDto, OdinRecordCreatedEvent } from '@d19n/odin-types/dist/core';
15
+ /**
16
+ * RabbitMQ message payload for CreateInstallDayBeforeWifiEducation created events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
19
+ */
20
+ export interface CreateInstallDayBeforeWifiEducationMessage extends OdinRecordCreatedEvent<CreateInstallDayBeforeWifiEducationDto, CreateInstallDayBeforeWifiEducationProperties> {
21
+ }
22
+ /**
23
+ * Properties for CreateInstallDayBeforeWifiEducation action
24
+ *
25
+ */
26
+ export interface CreateInstallDayBeforeWifiEducationProperties {
27
+ }
28
+ /**
29
+ * CreateInstallDayBeforeWifiEducation
30
+ *
31
+ * Create install day-before Wi-Fi education email
32
+ *
33
+ * @actionType CREATE - Creates a new Email record
34
+ * @module NotificationModule
35
+ * @entity Email
36
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
37
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
38
+ * @permission schema.action.createinstalldaybeforewifieducation.trigger
39
+ * @benchmark This action is tracked for performance benchmarks
40
+ */
41
+ export declare class CreateInstallDayBeforeWifiEducationDto extends OdinRecordCreateDto<CreateInstallDayBeforeWifiEducationProperties> {
42
+ /** Used by SDK generators to identify action type */
43
+ static readonly ACTION_TYPE = "CREATE";
44
+ static readonly ACTION_KEY = "CreateInstallDayBeforeWifiEducation";
45
+ static readonly MODULE_NAME = "NotificationModule";
46
+ static readonly ENTITIES: string[];
47
+ static readonly ENTITY_TYPE = "TRANSACTIONAL";
48
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation";
49
+ static readonly PERMISSION = "schema.action.createinstalldaybeforewifieducation.trigger";
50
+ /** Step metadata - entity this action targets */
51
+ static readonly STEP_ENTITY = "NotificationModule:Email";
52
+ static readonly STEP_SCHEMA_ID = "cb37958c-d72f-44aa-975a-a8fae42b1b72";
53
+ static readonly STEP_SCHEMA_ACTION_ID = "c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8";
54
+ static readonly STEP_SCHEMA_TYPE_ID = "14042940-a388-44c7-87fe-3a4105d92e94";
55
+ static readonly STEP_TYPE = "TRANSACTIONAL";
56
+ static readonly AUTO_LINK_PARENT = true;
57
+ readonly actionName: string;
58
+ readonly schemaActionId: string;
59
+ readonly entity: string;
60
+ constructor(properties: CreateInstallDayBeforeWifiEducationProperties, options?: {
61
+ journeyId?: string;
62
+ });
63
+ }
@@ -0,0 +1,59 @@
1
+ "use strict";
2
+ /**
3
+ * CreateInstallDayBeforeWifiEducation Action DTO
4
+ *
5
+ * Create install day-before Wi-Fi education email
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Email
9
+ * @entityType TRANSACTIONAL
10
+ * @actionKey CreateInstallDayBeforeWifiEducation
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.CreateInstallDayBeforeWifiEducationDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * CreateInstallDayBeforeWifiEducation
20
+ *
21
+ * Create install day-before Wi-Fi education email
22
+ *
23
+ * @actionType CREATE - Creates a new Email record
24
+ * @module NotificationModule
25
+ * @entity Email
26
+ * @entityType TRANSACTIONAL (TRANSACTIONAL)
27
+ * @event k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation
28
+ * @permission schema.action.createinstalldaybeforewifieducation.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class CreateInstallDayBeforeWifiEducationDto extends core_1.OdinRecordCreateDto {
32
+ constructor(properties, options) {
33
+ super({
34
+ entity: 'NotificationModule:Email',
35
+ type: 'TRANSACTIONAL',
36
+ properties,
37
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
38
+ });
39
+ this.actionName = 'CreateInstallDayBeforeWifiEducation';
40
+ this.schemaActionId = 'c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8';
41
+ this.entity = 'NotificationModule:Email';
42
+ }
43
+ }
44
+ exports.CreateInstallDayBeforeWifiEducationDto = CreateInstallDayBeforeWifiEducationDto;
45
+ /** Used by SDK generators to identify action type */
46
+ CreateInstallDayBeforeWifiEducationDto.ACTION_TYPE = 'CREATE';
47
+ CreateInstallDayBeforeWifiEducationDto.ACTION_KEY = 'CreateInstallDayBeforeWifiEducation';
48
+ CreateInstallDayBeforeWifiEducationDto.MODULE_NAME = 'NotificationModule';
49
+ CreateInstallDayBeforeWifiEducationDto.ENTITIES = ['Email'];
50
+ CreateInstallDayBeforeWifiEducationDto.ENTITY_TYPE = 'TRANSACTIONAL';
51
+ CreateInstallDayBeforeWifiEducationDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Email.Create.CreateInstallDayBeforeWifiEducation';
52
+ CreateInstallDayBeforeWifiEducationDto.PERMISSION = 'schema.action.createinstalldaybeforewifieducation.trigger';
53
+ /** Step metadata - entity this action targets */
54
+ CreateInstallDayBeforeWifiEducationDto.STEP_ENTITY = 'NotificationModule:Email';
55
+ CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_ID = 'cb37958c-d72f-44aa-975a-a8fae42b1b72';
56
+ CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_ACTION_ID = 'c4f9cf49-bd6d-4998-b78d-2c39a2c3cfe8';
57
+ CreateInstallDayBeforeWifiEducationDto.STEP_SCHEMA_TYPE_ID = '14042940-a388-44c7-87fe-3a4105d92e94';
58
+ CreateInstallDayBeforeWifiEducationDto.STEP_TYPE = 'TRANSACTIONAL';
59
+ CreateInstallDayBeforeWifiEducationDto.AUTO_LINK_PARENT = true;
@@ -26,7 +26,7 @@ export interface CreateLeadSalesAppMessage extends OdinRecordCreatedEvent<Create
26
26
  */
27
27
  export interface CreateLeadSalesAppProperties {
28
28
  /**
29
- * Name
29
+ * First name
30
30
  *
31
31
  * Copy and paste address title please
32
32
  * @type {TEXT}
@@ -34,7 +34,7 @@ export interface CreateLeadSalesAppProperties {
34
34
  */
35
35
  Name: string;
36
36
  /**
37
- * last name
37
+ * Nast name
38
38
  *
39
39
  * Display name/title for Lead records. Primary identifier for Sales team.
40
40
  * @type {TEXT}
@@ -102,7 +102,17 @@ export declare enum QaReportPropertyKeys {
102
102
  /** Free text from the person giving feedback. TEXT, not TEXT_LONG: the ceiling is the same either way, about 2,700 characters of varied text, which is far more than a comment needs. */
103
103
  FeedbackComment = "FeedbackComment",
104
104
  /** When the feedback was given. Separate from updatedAt, which moves on any change to the record. */
105
- FeedbackAt = "FeedbackAt"
105
+ FeedbackAt = "FeedbackAt",
106
+ /** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used. */
107
+ Rubric = "Rubric",
108
+ /** Version of that QaRubric at the time of scoring. */
109
+ RubricVersion = "RubricVersion",
110
+ /** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria. */
111
+ RubricSha256 = "RubricSha256",
112
+ /** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back. */
113
+ RubricSnapshotUrl = "RubricSnapshotUrl",
114
+ /** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this. */
115
+ QaResultUrl = "QaResultUrl"
106
116
  }
107
117
  /**
108
118
  * Properties for QaReport records
@@ -198,6 +208,36 @@ export interface QaReportProperties {
198
208
  * @default
199
209
  */
200
210
  FeedbackAt: string;
211
+ /** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used.
212
+ *
213
+ * @type {TEXT}
214
+ * @default
215
+ */
216
+ Rubric: string;
217
+ /** Version of that QaRubric at the time of scoring.
218
+ *
219
+ * @type {NUMBER}
220
+ * @default
221
+ */
222
+ RubricVersion: number;
223
+ /** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria.
224
+ *
225
+ * @type {TEXT}
226
+ * @default
227
+ */
228
+ RubricSha256: string;
229
+ /** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back.
230
+ *
231
+ * @type {TEXT}
232
+ * @default
233
+ */
234
+ RubricSnapshotUrl: string;
235
+ /** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this.
236
+ *
237
+ * @type {TEXT}
238
+ * @default
239
+ */
240
+ QaResultUrl: string;
201
241
  }
202
242
  /**
203
243
  * QaReport entity from SupportModule
@@ -110,6 +110,16 @@ var QaReportPropertyKeys;
110
110
  QaReportPropertyKeys["FeedbackComment"] = "FeedbackComment";
111
111
  /** When the feedback was given. Separate from updatedAt, which moves on any change to the record. */
112
112
  QaReportPropertyKeys["FeedbackAt"] = "FeedbackAt";
113
+ /** Record number of the QaRubric the report was scored against, e.g. QRB2. Empty when the Databricks prompt's built-in rubric was used. */
114
+ QaReportPropertyKeys["Rubric"] = "Rubric";
115
+ /** Version of that QaRubric at the time of scoring. */
116
+ QaReportPropertyKeys["RubricVersion"] = "RubricVersion";
117
+ /** SHA-256 of the exact scoring_criteria string sent to Databricks, confirmed by the model. Two reports with the same value were scored against identical criteria. */
118
+ QaReportPropertyKeys["RubricSha256"] = "RubricSha256";
119
+ /** S3 URL of the exact scoring_criteria JSON sent with this report, so the criteria that produced the score can always be read back. */
120
+ QaReportPropertyKeys["RubricSnapshotUrl"] = "RubricSnapshotUrl";
121
+ /** S3 URL of qa_result: the verdict and points for every rubric item, the section totals and the score, all computed in code by the Databricks endpoint. Only set when the report was scored against an Odin rubric. Per-item analytics read this. */
122
+ QaReportPropertyKeys["QaResultUrl"] = "QaResultUrl";
113
123
  })(QaReportPropertyKeys = exports.QaReportPropertyKeys || (exports.QaReportPropertyKeys = {}));
114
124
  /**
115
125
  * QaReport entity from SupportModule
@@ -47,6 +47,7 @@ import { CreateCboEmailProperties } from '../actions-v2/CreateCboEmailDto';
47
47
  import { CreateFailedInvoicePaymentProperties } from '../actions-v2/CreateFailedInvoicePaymentDto';
48
48
  import { CreateGenericRemediationRequiredProperties } from '../actions-v2/CreateGenericRemediationRequiredDto';
49
49
  import { CreateInboundSupportEmailProperties } from '../actions-v2/CreateInboundSupportEmailDto';
50
+ import { CreateInstallDayBeforeWifiEducationProperties } from '../actions-v2/CreateInstallDayBeforeWifiEducationDto';
50
51
  import { CreateNewCreditNoteProperties } from '../actions-v2/CreateNewCreditNoteDto';
51
52
  import { CreateNewInvoiceProperties } from '../actions-v2/CreateNewInvoiceDto';
52
53
  import { CreateOrderConfirmationProperties } from '../actions-v2/CreateOrderConfirmationDto';
@@ -1095,6 +1096,34 @@ export declare class EmailRecord<TProps = EmailProperties> {
1095
1096
  journeyId?: string;
1096
1097
  stageKey?: string;
1097
1098
  }): ActionBuilder;
1099
+ /**
1100
+ * CreateInstallDayBeforeWifiEducation
1101
+ *
1102
+ * Creates a new Email record with the specified properties.
1103
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
1104
+ *
1105
+ * @remarks Record type: TRANSACTIONAL
1106
+ *
1107
+ * @param properties - The properties for the new record
1108
+ * @param options - Optional settings
1109
+ * @param options.journeyId - Associate with a journey
1110
+ * @param options.stageKey - Set initial pipeline stage
1111
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
1112
+ *
1113
+ * @example
1114
+ * ```typescript
1115
+ * // Create with properties
1116
+ * const record = odinClient.emails.new();
1117
+ * await record.createInstallDayBeforeWifiEducation({ ... }).execute();
1118
+ *
1119
+ * // Dry run (for debugging)
1120
+ * const payload = record.createInstallDayBeforeWifiEducation({ ... }).dryRun();
1121
+ * ```
1122
+ */
1123
+ createInstallDayBeforeWifiEducation(properties?: CreateInstallDayBeforeWifiEducationProperties, options?: {
1124
+ journeyId?: string;
1125
+ stageKey?: string;
1126
+ }): ActionBuilder;
1098
1127
  /**
1099
1128
  * CreateNewCreditNote
1100
1129
  *
@@ -1355,6 +1355,42 @@ class EmailRecord {
1355
1355
  };
1356
1356
  return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
1357
1357
  }
1358
+ /**
1359
+ * CreateInstallDayBeforeWifiEducation
1360
+ *
1361
+ * Creates a new Email record with the specified properties.
1362
+ * Returns an ActionBuilder - call .execute() to create or .dryRun() for debugging.
1363
+ *
1364
+ * @remarks Record type: TRANSACTIONAL
1365
+ *
1366
+ * @param properties - The properties for the new record
1367
+ * @param options - Optional settings
1368
+ * @param options.journeyId - Associate with a journey
1369
+ * @param options.stageKey - Set initial pipeline stage
1370
+ * @returns ActionBuilder - call .execute() to create or .dryRun() for payload
1371
+ *
1372
+ * @example
1373
+ * ```typescript
1374
+ * // Create with properties
1375
+ * const record = odinClient.emails.new();
1376
+ * await record.createInstallDayBeforeWifiEducation({ ... }).execute();
1377
+ *
1378
+ * // Dry run (for debugging)
1379
+ * const payload = record.createInstallDayBeforeWifiEducation({ ... }).dryRun();
1380
+ * ```
1381
+ */
1382
+ createInstallDayBeforeWifiEducation(properties, options) {
1383
+ const payload = {
1384
+ entity: 'NotificationModule:Email',
1385
+ type: 'TRANSACTIONAL',
1386
+ actionName: 'CreateInstallDayBeforeWifiEducation',
1387
+ properties: properties || {},
1388
+ associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined,
1389
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
1390
+ stageKey: options === null || options === void 0 ? void 0 : options.stageKey,
1391
+ };
1392
+ return new ActionBuilder(this._provider, 'NotificationModule', 'Email', payload, () => { this._pendingLinks = []; });
1393
+ }
1358
1394
  /**
1359
1395
  * CreateNewCreditNote
1360
1396
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "2.0.336",
3
+ "version": "2.0.337",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",