@d19n/youfibre-odin-sdk 1.0.260 → 1.0.261-beta.0

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.
@@ -146,9 +146,62 @@ export declare class CreateConversationDto extends OdinRecordCreateDto<CreateCon
146
146
  */
147
147
  export interface CreateConversationMessage extends OdinRecordCreatedEvent<CreateConversationDto, CreateConversationProperties> {
148
148
  }
149
+ /**
150
+ * Properties for CreateMessage action
151
+ *
152
+ * @property Required fields: 1
153
+ * @property Optional fields: 0
154
+ */
155
+ export interface CreateMessageProperties {
156
+ /**
157
+ * Body
158
+ *
159
+ * Content of the message (Communications - Message)
160
+ * @type {TEXT}
161
+ * @required
162
+ */
163
+ Body: string;
164
+ }
165
+ /**
166
+ * CreateMessage
167
+ *
168
+ * Used his to create a chat message
169
+ *
170
+ * @actionType CREATE - Creates a new Message record
171
+ * @module NotificationModule
172
+ * @entity Message
173
+ * @entityType DEFAULT (Default)
174
+ * @event MessageCreated
175
+ * @permission schema.action.createmessage.trigger
176
+ * @benchmark This action is tracked for performance benchmarks
177
+ */
178
+ export declare class CreateMessageDto extends OdinRecordCreateDto<CreateMessageProperties> {
179
+ /** Used by SDK generators to identify action type */
180
+ static readonly ACTION_TYPE = "CREATE";
181
+ static readonly ACTION_KEY = "CreateMessage";
182
+ static readonly MODULE_NAME = "NotificationModule";
183
+ static readonly ENTITIES: string[];
184
+ static readonly ENTITY_TYPE = "DEFAULT";
185
+ static readonly EVENT_NAME = "MessageCreated";
186
+ static readonly PERMISSION = "schema.action.createmessage.trigger";
187
+ readonly actionName: string;
188
+ readonly schemaActionId: string;
189
+ readonly entity: string;
190
+ constructor(properties: CreateMessageProperties, options?: {
191
+ journeyId?: string;
192
+ });
193
+ }
194
+ /**
195
+ * RabbitMQ message payload for CreateMessage created events
196
+ *
197
+ * @event MessageCreated
198
+ */
199
+ export interface CreateMessageMessage extends OdinRecordCreatedEvent<CreateMessageDto, CreateMessageProperties> {
200
+ }
149
201
  declare type StepClassMap = {
150
202
  CreateCaseDto: CreateCaseDto;
151
203
  CreateConversationDto: CreateConversationDto;
204
+ CreateMessageDto: CreateMessageDto;
152
205
  };
153
206
  /**
154
207
  * RabbitMQ message payload for CreateCaseForChat step flow events
@@ -164,7 +217,7 @@ export interface CreateCaseForChatMessage extends OdinRecordUpdatedEvent<CreateC
164
217
  export interface CreateCaseForChatProperties {
165
218
  }
166
219
  /**
167
- * CreateCaseForChat
220
+ * Create Chat Case
168
221
  *
169
222
  * Use this when creating a new case for the chat channel
170
223
  *
@@ -196,7 +249,7 @@ export declare class CreateCaseForChatDto extends OdinRecordUpdateDto<Record<str
196
249
  journeyId?: string;
197
250
  });
198
251
  /** Step classes that can be used with this action */
199
- static readonly stepClasses: readonly ["CreateCaseDto", "CreateConversationDto"];
252
+ static readonly stepClasses: readonly ["CreateCaseDto", "CreateConversationDto", "CreateMessageDto"];
200
253
  steps: StepClassMap[(typeof CreateCaseForChatDto.stepClasses)[number]][];
201
254
  }
202
255
  /**
@@ -13,7 +13,7 @@
13
13
  * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
14
  */
15
15
  Object.defineProperty(exports, "__esModule", { value: true });
16
- exports.ROUTING_KEY_CHAT_CASE_CREATED = exports.CreateCaseForChatDto = exports.CreateConversationDto = exports.CreateCaseDto = void 0;
16
+ exports.ROUTING_KEY_CHAT_CASE_CREATED = exports.CreateCaseForChatDto = exports.CreateMessageDto = exports.CreateConversationDto = exports.CreateCaseDto = void 0;
17
17
  const core_1 = require("@d19n/odin-types/dist/core");
18
18
  /**
19
19
  * CreateCase
@@ -86,7 +86,42 @@ CreateConversationDto.ENTITIES = ['Conversation'];
86
86
  CreateConversationDto.EVENT_NAME = 'NotificationModule.Conversation.Create.CreateConversation';
87
87
  CreateConversationDto.PERMISSION = 'schema.action.createconversation.trigger';
88
88
  /**
89
- * CreateCaseForChat
89
+ * CreateMessage
90
+ *
91
+ * Used his to create a chat message
92
+ *
93
+ * @actionType CREATE - Creates a new Message record
94
+ * @module NotificationModule
95
+ * @entity Message
96
+ * @entityType DEFAULT (Default)
97
+ * @event MessageCreated
98
+ * @permission schema.action.createmessage.trigger
99
+ * @benchmark This action is tracked for performance benchmarks
100
+ */
101
+ class CreateMessageDto extends core_1.OdinRecordCreateDto {
102
+ constructor(properties, options) {
103
+ super({
104
+ entity: 'NotificationModule:Message',
105
+ type: 'DEFAULT',
106
+ properties,
107
+ journeyId: options === null || options === void 0 ? void 0 : options.journeyId,
108
+ });
109
+ this.actionName = 'CreateMessage';
110
+ this.schemaActionId = 'ee49c5e2-16eb-4678-8629-b67129f94f60';
111
+ this.entity = 'NotificationModule:Message';
112
+ }
113
+ }
114
+ exports.CreateMessageDto = CreateMessageDto;
115
+ /** Used by SDK generators to identify action type */
116
+ CreateMessageDto.ACTION_TYPE = 'CREATE';
117
+ CreateMessageDto.ACTION_KEY = 'CreateMessage';
118
+ CreateMessageDto.MODULE_NAME = 'NotificationModule';
119
+ CreateMessageDto.ENTITIES = ['Message'];
120
+ CreateMessageDto.ENTITY_TYPE = 'DEFAULT';
121
+ CreateMessageDto.EVENT_NAME = 'MessageCreated';
122
+ CreateMessageDto.PERMISSION = 'schema.action.createmessage.trigger';
123
+ /**
124
+ * Create Chat Case
90
125
  *
91
126
  * Use this when creating a new case for the chat channel
92
127
  *
@@ -122,7 +157,7 @@ CreateCaseForChatDto.ENTITY_TYPE = 'DEFAULT';
122
157
  CreateCaseForChatDto.EVENT_NAME = 'ChatCaseCreated';
123
158
  CreateCaseForChatDto.PERMISSION = 'schema.action.createcaseforchat.trigger';
124
159
  /** Step classes that can be used with this action */
125
- CreateCaseForChatDto.stepClasses = ['CreateCaseDto', 'CreateConversationDto'];
160
+ CreateCaseForChatDto.stepClasses = ['CreateCaseDto', 'CreateConversationDto', 'CreateMessageDto'];
126
161
  /**
127
162
  * RabbitMQ routing key for CreateCaseForChat events
128
163
  *
@@ -28,6 +28,7 @@ import { MoveCaseToBlockedActionProperties } from '../actions-v2/Casedefaultstag
28
28
  import { ChangeCaseChannelProperties } from '../actions-v2/ChangeCaseChannelDto';
29
29
  import { CreateCaseProperties } from '../actions-v2/CreateCaseDto';
30
30
  import { CreateConversationProperties } from '../actions-v2/CreateCaseForChatDto';
31
+ import { CreateMessageProperties } from '../actions-v2/CreateCaseForChatDto';
31
32
  import { EditCaseFormProperties } from '../actions-v2/EditCaseFormDto';
32
33
  import { MarkCaseClosedProperties } from '../actions-v2/MarkCaseClosedDto';
33
34
  import { MarkCaseResolvedProperties } from '../actions-v2/MarkCaseResolvedDto';
@@ -262,6 +263,13 @@ declare class CreateCaseForChatFlowBuilder {
262
263
  * @returns this (for method chaining)
263
264
  */
264
265
  createConversation(properties: CreateConversationProperties, options?: Omit<CreateCaseForChatFlowBuilderStepOptions, "id">): this;
266
+ /**
267
+ * Add CreateMessage step to the flow
268
+ * @param properties - Properties for this step
269
+ * @param options - Optional step settings (associations, groups)
270
+ * @returns this (for method chaining)
271
+ */
272
+ createMessage(properties: CreateMessageProperties, options?: Omit<CreateCaseForChatFlowBuilderStepOptions, "id">): this;
265
273
  /**
266
274
  * Execute the flow with all collected steps
267
275
  * @returns The action result
@@ -1004,6 +1012,7 @@ export declare class CaseRecord {
1004
1012
  * await record.createCaseForChat()
1005
1013
  * .createCase({ ... })
1006
1014
  * .createConversation({ ... })
1015
+ * .createMessage({ ... })
1007
1016
  * .execute();
1008
1017
  * ```
1009
1018
  */
@@ -296,6 +296,21 @@ class CreateCaseForChatFlowBuilder {
296
296
  });
297
297
  return this;
298
298
  }
299
+ /**
300
+ * Add CreateMessage step to the flow
301
+ * @param properties - Properties for this step
302
+ * @param options - Optional step settings (associations, groups)
303
+ * @returns this (for method chaining)
304
+ */
305
+ createMessage(properties, options) {
306
+ this._steps.push({
307
+ actionName: 'CreateMessage',
308
+ properties,
309
+ associations: options === null || options === void 0 ? void 0 : options.associations,
310
+ groups: options === null || options === void 0 ? void 0 : options.groups,
311
+ });
312
+ return this;
313
+ }
299
314
  /**
300
315
  * Execute the flow with all collected steps
301
316
  * @returns The action result
@@ -1442,6 +1457,7 @@ class CaseRecord {
1442
1457
  * await record.createCaseForChat()
1443
1458
  * .createCase({ ... })
1444
1459
  * .createConversation({ ... })
1460
+ * .createMessage({ ... })
1445
1461
  * .execute();
1446
1462
  * ```
1447
1463
  */
@@ -20,7 +20,7 @@ import { IDbRecordCreateUpdateRes } from '@d19n/odin-types/dist/core/interfaces/
20
20
  import { IOdinProvider } from '@d19n/odin-sdk-generator/dist/odin-sdk-types';
21
21
  import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-manager';
22
22
  import { MessageProperties } from '../entities-v2/Message';
23
- import { CreateMessageProperties } from '../actions-v2/CreateMessageDto';
23
+ import { CreateMessageProperties } from '../actions-v2/CreateCaseForChatDto';
24
24
  import { ConversationRecord } from './ConversationRecord';
25
25
  /** Valid entity types for Message */
26
26
  export declare type MessageType = 'DEFAULT' | 'EVENT';
@@ -46,6 +46,7 @@ export { AppointmentRecord, isAppointmentRecord } from './AppointmentRecord';
46
46
  export { PgFileAllocationRecord, isPgFileAllocationRecord } from './PgFileAllocationRecord';
47
47
  export { ProductRecord, isProductRecord } from './ProductRecord';
48
48
  export { ConversationRecord, isConversationRecord } from './ConversationRecord';
49
+ export { MessageRecord, isMessageRecord } from './MessageRecord';
49
50
  export { ContactRecord, isContactRecord } from './ContactRecord';
50
51
  export { ConfigRecord, isConfigRecord } from './ConfigRecord';
51
52
  export { CustomerDeviceOntRecord, isCustomerDeviceOntRecord } from './CustomerDeviceOntRecord';
@@ -55,7 +56,6 @@ export { FieldServiceProductRecord, isFieldServiceProductRecord } from './FieldS
55
56
  export { ActivityRecord, isActivityRecord } from './ActivityRecord';
56
57
  export { ImpersonationTrackerRecord, isImpersonationTrackerRecord } from './ImpersonationTrackerRecord';
57
58
  export { LeadRecord, isLeadRecord } from './LeadRecord';
58
- export { MessageRecord, isMessageRecord } from './MessageRecord';
59
59
  export { NetworkDeviceRecord, isNetworkDeviceRecord } from './NetworkDeviceRecord';
60
60
  export { ReturnsRecord, isReturnsRecord } from './ReturnsRecord';
61
61
  export { OneTouchSwitchRecord, isOneTouchSwitchRecord } from './OneTouchSwitchRecord';
@@ -9,7 +9,7 @@
9
9
  */
10
10
  Object.defineProperty(exports, "__esModule", { value: true });
11
11
  exports.isOhInstallationAuditRecord = exports.OhInstallationAuditRecord = exports.isUgInProgressAuditRecord = exports.UgInProgressAuditRecord = exports.isBlockageA55Record = exports.BlockageA55Record = exports.isInternalInstallAuditRecord = exports.InternalInstallAuditRecord = exports.isUgAuditOfInstallationRecord = exports.UgAuditOfInstallationRecord = exports.isOhRetroAuditRecord = exports.OhRetroAuditRecord = exports.isSweeperMaintenanceAuditRecord = exports.SweeperMaintenanceAuditRecord = exports.isOntReplacementApprovalRecord = exports.OntReplacementApprovalRecord = exports.isAccountRecord = exports.AccountRecord = exports.isPermissionToFailRecord = exports.PermissionToFailRecord = exports.isTransactionRecord = exports.TransactionRecord = exports.isPaymentRecord = exports.PaymentRecord = exports.isPICRequestRecord = exports.PICRequestRecord = exports.isChangeReasonRecord = exports.ChangeReasonRecord = exports.isChurnRequestRecord = exports.ChurnRequestRecord = exports.isBillingRequestRecord = exports.BillingRequestRecord = exports.isBillingAdjustmentRecord = exports.BillingAdjustmentRecord = exports.isServiceAppointmentConfigRecord = exports.ServiceAppointmentConfigRecord = exports.isCrmDatasetRecord = exports.CrmDatasetRecord = exports.isWorkOrderRecord = exports.WorkOrderRecord = exports.isNoteRecord = exports.NoteRecord = exports.isCaseRecord = exports.CaseRecord = exports.isContractBuyOutRecord = exports.ContractBuyOutRecord = exports.isAddressRecord = exports.AddressRecord = exports.isOrderRecord = exports.OrderRecord = void 0;
12
- exports.isMessageRecord = exports.MessageRecord = exports.isLeadRecord = exports.LeadRecord = exports.isImpersonationTrackerRecord = exports.ImpersonationTrackerRecord = exports.isActivityRecord = exports.ActivityRecord = exports.isFieldServiceProductRecord = exports.FieldServiceProductRecord = exports.isFieldServiceDispatchedProductRecord = exports.FieldServiceDispatchedProductRecord = exports.isEmailTemplateRecord = exports.EmailTemplateRecord = exports.isCustomerDeviceOntRecord = exports.CustomerDeviceOntRecord = exports.isConfigRecord = exports.ConfigRecord = exports.isContactRecord = exports.ContactRecord = exports.isConversationRecord = exports.ConversationRecord = exports.isProductRecord = exports.ProductRecord = exports.isPgFileAllocationRecord = exports.PgFileAllocationRecord = exports.isAppointmentRecord = exports.AppointmentRecord = exports.isActivityLogRecord = exports.ActivityLogRecord = exports.isYfFieldServiceVisitRecord = exports.YfFieldServiceVisitRecord = exports.isServiceVisitAuditRecord = exports.ServiceVisitAuditRecord = exports.isRemediationOutcomeFormRecord = exports.RemediationOutcomeFormRecord = exports.isUgExternalAuditRecord = exports.UgExternalAuditRecord = exports.isOhExternalAuditRecord = exports.OhExternalAuditRecord = exports.isPaymentMethodRefundRecord = exports.PaymentMethodRefundRecord = exports.isUgRetroAuditRecord = exports.UgRetroAuditRecord = exports.isOhInProgressAuditRecord = exports.OhInProgressAuditRecord = exports.isUgInstallationAuditRecord = exports.UgInstallationAuditRecord = exports.isOhAuditOfInstallationRecord = exports.OhAuditOfInstallationRecord = void 0;
12
+ exports.isLeadRecord = exports.LeadRecord = exports.isImpersonationTrackerRecord = exports.ImpersonationTrackerRecord = exports.isActivityRecord = exports.ActivityRecord = exports.isFieldServiceProductRecord = exports.FieldServiceProductRecord = exports.isFieldServiceDispatchedProductRecord = exports.FieldServiceDispatchedProductRecord = exports.isEmailTemplateRecord = exports.EmailTemplateRecord = exports.isCustomerDeviceOntRecord = exports.CustomerDeviceOntRecord = exports.isConfigRecord = exports.ConfigRecord = exports.isContactRecord = exports.ContactRecord = exports.isMessageRecord = exports.MessageRecord = exports.isConversationRecord = exports.ConversationRecord = exports.isProductRecord = exports.ProductRecord = exports.isPgFileAllocationRecord = exports.PgFileAllocationRecord = exports.isAppointmentRecord = exports.AppointmentRecord = exports.isActivityLogRecord = exports.ActivityLogRecord = exports.isYfFieldServiceVisitRecord = exports.YfFieldServiceVisitRecord = exports.isServiceVisitAuditRecord = exports.ServiceVisitAuditRecord = exports.isRemediationOutcomeFormRecord = exports.RemediationOutcomeFormRecord = exports.isUgExternalAuditRecord = exports.UgExternalAuditRecord = exports.isOhExternalAuditRecord = exports.OhExternalAuditRecord = exports.isPaymentMethodRefundRecord = exports.PaymentMethodRefundRecord = exports.isUgRetroAuditRecord = exports.UgRetroAuditRecord = exports.isOhInProgressAuditRecord = exports.OhInProgressAuditRecord = exports.isUgInstallationAuditRecord = exports.UgInstallationAuditRecord = exports.isOhAuditOfInstallationRecord = exports.OhAuditOfInstallationRecord = void 0;
13
13
  exports.isCustomerDeviceAtaRecord = exports.CustomerDeviceAtaRecord = exports.isCreditNoteRecord = exports.CreditNoteRecord = exports.isWorkOrderStatusUpdateRecord = exports.WorkOrderStatusUpdateRecord = exports.isWayleaveAuditRecord = exports.WayleaveAuditRecord = exports.isTimeSlotRecord = exports.TimeSlotRecord = exports.isTeamRecord = exports.TeamRecord = exports.isVoiceConfigurationRecord = exports.VoiceConfigurationRecord = exports.isOrderItemRecord = exports.OrderItemRecord = exports.isPushNotificationRecord = exports.PushNotificationRecord = exports.isPgWebhookRecord = exports.PgWebhookRecord = exports.isPgWebhookAttemptRecord = exports.PgWebhookAttemptRecord = exports.isPgAccountValidationRecord = exports.PgAccountValidationRecord = exports.isPgTransactionRecord = exports.PgTransactionRecord = exports.isPgSortCodeSubstitutionRecord = exports.PgSortCodeSubstitutionRecord = exports.isPgVocalinkRecord = exports.PgVocalinkRecord = exports.isPgDirectDebitFileRecord = exports.PgDirectDebitFileRecord = exports.isPgPaymentMethodRecord = exports.PgPaymentMethodRecord = exports.isPgLogRecord = exports.PgLogRecord = exports.isPgDisputeRecord = exports.PgDisputeRecord = exports.isPgContactRecord = exports.PgContactRecord = exports.isPaymentMethodRecord = exports.PaymentMethodRecord = exports.isOrderCheckRecord = exports.OrderCheckRecord = exports.isOneTouchSwitchRecord = exports.OneTouchSwitchRecord = exports.isReturnsRecord = exports.ReturnsRecord = exports.isNetworkDeviceRecord = exports.NetworkDeviceRecord = void 0;
14
14
  exports.isCustomerPhonePortingRecord = exports.CustomerPhonePortingRecord = exports.isVisitRecord = exports.VisitRecord = exports.isUserRecord = exports.UserRecord = exports.isEmailRecord = exports.EmailRecord = exports.isServiceRecord = exports.ServiceRecord = exports.isCallRecord = exports.CallRecord = exports.isCallLegRecord = exports.CallLegRecord = exports.isScheduleSlotRecord = exports.ScheduleSlotRecord = exports.isPriceBookRecord = exports.PriceBookRecord = exports.isOverlayRealA55Record = exports.OverlayRealA55Record = exports.isOfferRecord = exports.OfferRecord = exports.isServiceAppointmentRecord = exports.ServiceAppointmentRecord = exports.isOutageRecord = exports.OutageRecord = exports.isSiteSpecificRiskAssessmentOutcomeFormRecord = exports.SiteSpecificRiskAssessmentOutcomeFormRecord = exports.isRemediationRequiredReasonRecord = exports.RemediationRequiredReasonRecord = exports.isKnowledgeArticleRecord = exports.KnowledgeArticleRecord = exports.isInvoiceRecord = exports.InvoiceRecord = exports.isDiscountRecord = exports.DiscountRecord = exports.isCustomerDeviceRouterRecord = exports.CustomerDeviceRouterRecord = void 0;
15
15
  var OrderRecord_1 = require("./OrderRecord");
@@ -132,6 +132,9 @@ Object.defineProperty(exports, "isProductRecord", { enumerable: true, get: funct
132
132
  var ConversationRecord_1 = require("./ConversationRecord");
133
133
  Object.defineProperty(exports, "ConversationRecord", { enumerable: true, get: function () { return ConversationRecord_1.ConversationRecord; } });
134
134
  Object.defineProperty(exports, "isConversationRecord", { enumerable: true, get: function () { return ConversationRecord_1.isConversationRecord; } });
135
+ var MessageRecord_1 = require("./MessageRecord");
136
+ Object.defineProperty(exports, "MessageRecord", { enumerable: true, get: function () { return MessageRecord_1.MessageRecord; } });
137
+ Object.defineProperty(exports, "isMessageRecord", { enumerable: true, get: function () { return MessageRecord_1.isMessageRecord; } });
135
138
  var ContactRecord_1 = require("./ContactRecord");
136
139
  Object.defineProperty(exports, "ContactRecord", { enumerable: true, get: function () { return ContactRecord_1.ContactRecord; } });
137
140
  Object.defineProperty(exports, "isContactRecord", { enumerable: true, get: function () { return ContactRecord_1.isContactRecord; } });
@@ -159,9 +162,6 @@ Object.defineProperty(exports, "isImpersonationTrackerRecord", { enumerable: tru
159
162
  var LeadRecord_1 = require("./LeadRecord");
160
163
  Object.defineProperty(exports, "LeadRecord", { enumerable: true, get: function () { return LeadRecord_1.LeadRecord; } });
161
164
  Object.defineProperty(exports, "isLeadRecord", { enumerable: true, get: function () { return LeadRecord_1.isLeadRecord; } });
162
- var MessageRecord_1 = require("./MessageRecord");
163
- Object.defineProperty(exports, "MessageRecord", { enumerable: true, get: function () { return MessageRecord_1.MessageRecord; } });
164
- Object.defineProperty(exports, "isMessageRecord", { enumerable: true, get: function () { return MessageRecord_1.isMessageRecord; } });
165
165
  var NetworkDeviceRecord_1 = require("./NetworkDeviceRecord");
166
166
  Object.defineProperty(exports, "NetworkDeviceRecord", { enumerable: true, get: function () { return NetworkDeviceRecord_1.NetworkDeviceRecord; } });
167
167
  Object.defineProperty(exports, "isNetworkDeviceRecord", { enumerable: true, get: function () { return NetworkDeviceRecord_1.isNetworkDeviceRecord; } });
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "1.0.260",
3
+ "version": "1.0.261-beta.0",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",