@d19n/youfibre-odin-sdk 1.0.332 → 1.0.334

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
@@ -348,7 +348,7 @@ This SDK includes **160** entities across **12** modules.
348
348
 
349
349
  ## Actions
350
350
 
351
- This SDK includes **525** actions.
351
+ This SDK includes **526** actions.
352
352
 
353
353
  ### Action Types
354
354
 
@@ -982,6 +982,7 @@ This SDK includes **525** actions.
982
982
  |--------|------|-------|
983
983
  | `CloseConversation` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Conversation.Update.CloseConversation |
984
984
  | `CreateConversation` | CREATE | k1.t-hEOJjsDb.NotificationModule.Conversation.Create.CreateConversation |
985
+ | `ReopenConversation` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation |
985
986
  | `UpdateConversation` | UPDATE | k1.t-hEOJjsDb.NotificationModule.Conversation.Update.UpdateConversation |
986
987
 
987
988
  #### UgAuditOfInstallation
@@ -74,6 +74,14 @@ export interface CreatePgPaymentMethodProperties {
74
74
  * @required
75
75
  */
76
76
  Fingerprint: string;
77
+ /**
78
+ * InUse
79
+ *
80
+ * Payment method to be used for the customer, if true
81
+ * @type {BOOLEAN}
82
+ * @required
83
+ */
84
+ InUse: boolean;
77
85
  /**
78
86
  * BacsReference
79
87
  *
@@ -0,0 +1,94 @@
1
+ /**
2
+ * ReopenConversation Action DTO
3
+ *
4
+ * Action for reopening a conversation
5
+ *
6
+ * @module NotificationModule
7
+ * @entity Conversation
8
+ * @entityType DEFAULT
9
+ * @actionKey ReopenConversation
10
+ * @event k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation
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 ReopenConversation updated events
17
+ *
18
+ * @event k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation
19
+ */
20
+ export interface ReopenConversationMessage extends OdinRecordUpdatedEvent<ReopenConversationDto, ReopenConversationProperties> {
21
+ }
22
+ /**
23
+ * Properties for ReopenConversation action
24
+ *
25
+ * @property Required fields: 3
26
+ * @property Optional fields: 0
27
+ */
28
+ export interface ReopenConversationProperties {
29
+ /**
30
+ * ClosedAt
31
+ *
32
+ * Data field for Conversation records. Used by Communications team.
33
+ * @type {DATE_TIME}
34
+ * @required
35
+ */
36
+ ClosedAt: string;
37
+ /**
38
+ * ClosedBy
39
+ *
40
+ * Data field for Conversation records. Used by Communications team.
41
+ * @type {TEXT}
42
+ * @required
43
+ */
44
+ ClosedBy: string;
45
+ /**
46
+ * Status
47
+ *
48
+ * the status of the conversation (Communications - Conversation)
49
+ * @type {ENUM}
50
+ * @required
51
+ */
52
+ Status: string;
53
+ }
54
+ /**
55
+ * ReopenConversation
56
+ *
57
+ * Action for reopening a conversation
58
+ *
59
+ * @actionType UPDATE - Updates an existing Conversation record
60
+ * @module NotificationModule
61
+ * @entity Conversation
62
+ * @entityType DEFAULT (Default)
63
+ * @event k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation
64
+ * @permission schema.action.reopenconversation.trigger
65
+ * @benchmark This action is tracked for performance benchmarks
66
+ */
67
+ export declare class ReopenConversationDto extends OdinRecordUpdateDto<ReopenConversationProperties> {
68
+ /** Used by SDK generators to identify action type */
69
+ static readonly ACTION_TYPE = "UPDATE";
70
+ static readonly ACTION_KEY = "ReopenConversation";
71
+ static readonly MODULE_NAME = "NotificationModule";
72
+ static readonly ENTITIES: string[];
73
+ static readonly ENTITY_TYPE = "DEFAULT";
74
+ static readonly EVENT_NAME = "k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation";
75
+ static readonly PERMISSION = "schema.action.reopenconversation.trigger";
76
+ /** Step metadata - entity this action targets */
77
+ static readonly STEP_ENTITY = "NotificationModule:Conversation";
78
+ static readonly STEP_SCHEMA_ID = "3a96ecbc-cc51-4d68-a4eb-1199737ade3a";
79
+ static readonly STEP_SCHEMA_ACTION_ID = "16d683e5-0ce8-4c73-849f-34506ba0b035";
80
+ static readonly STEP_SCHEMA_TYPE_ID = "20ff9844-8142-42cc-a55f-c3e10fa1d26a";
81
+ static readonly STEP_TYPE = "DEFAULT";
82
+ static readonly AUTO_LINK_PARENT = false;
83
+ readonly actionName: string;
84
+ readonly schemaActionId: string;
85
+ readonly entity: string;
86
+ constructor(record: OdinRecord<any> | {
87
+ id: string;
88
+ entity: string;
89
+ type?: string;
90
+ }, properties: ReopenConversationProperties, options?: {
91
+ journeyId?: string;
92
+ stageKey?: string;
93
+ });
94
+ }
@@ -0,0 +1,61 @@
1
+ "use strict";
2
+ /**
3
+ * ReopenConversation Action DTO
4
+ *
5
+ * Action for reopening a conversation
6
+ *
7
+ * @module NotificationModule
8
+ * @entity Conversation
9
+ * @entityType DEFAULT
10
+ * @actionKey ReopenConversation
11
+ * @event k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation
12
+ *
13
+ * AUTO-GENERATED - DO NOT EDIT DIRECTLY
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.ReopenConversationDto = void 0;
17
+ const core_1 = require("@d19n/odin-types/dist/core");
18
+ /**
19
+ * ReopenConversation
20
+ *
21
+ * Action for reopening a conversation
22
+ *
23
+ * @actionType UPDATE - Updates an existing Conversation record
24
+ * @module NotificationModule
25
+ * @entity Conversation
26
+ * @entityType DEFAULT (Default)
27
+ * @event k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation
28
+ * @permission schema.action.reopenconversation.trigger
29
+ * @benchmark This action is tracked for performance benchmarks
30
+ */
31
+ class ReopenConversationDto 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 = 'ReopenConversation';
42
+ this.schemaActionId = '16d683e5-0ce8-4c73-849f-34506ba0b035';
43
+ this.entity = 'NotificationModule:Conversation';
44
+ }
45
+ }
46
+ exports.ReopenConversationDto = ReopenConversationDto;
47
+ /** Used by SDK generators to identify action type */
48
+ ReopenConversationDto.ACTION_TYPE = 'UPDATE';
49
+ ReopenConversationDto.ACTION_KEY = 'ReopenConversation';
50
+ ReopenConversationDto.MODULE_NAME = 'NotificationModule';
51
+ ReopenConversationDto.ENTITIES = ['Conversation'];
52
+ ReopenConversationDto.ENTITY_TYPE = 'DEFAULT';
53
+ ReopenConversationDto.EVENT_NAME = 'k1.t-hEOJjsDb.NotificationModule.Conversation.Update.ReopenConversation';
54
+ ReopenConversationDto.PERMISSION = 'schema.action.reopenconversation.trigger';
55
+ /** Step metadata - entity this action targets */
56
+ ReopenConversationDto.STEP_ENTITY = 'NotificationModule:Conversation';
57
+ ReopenConversationDto.STEP_SCHEMA_ID = '3a96ecbc-cc51-4d68-a4eb-1199737ade3a';
58
+ ReopenConversationDto.STEP_SCHEMA_ACTION_ID = '16d683e5-0ce8-4c73-849f-34506ba0b035';
59
+ ReopenConversationDto.STEP_SCHEMA_TYPE_ID = '20ff9844-8142-42cc-a55f-c3e10fa1d26a';
60
+ ReopenConversationDto.STEP_TYPE = 'DEFAULT';
61
+ ReopenConversationDto.AUTO_LINK_PARENT = false;
@@ -21,7 +21,7 @@ export interface UpdateConversationMessage extends OdinRecordUpdatedEvent<Update
21
21
  /**
22
22
  * Properties for UpdateConversation action
23
23
  *
24
- * @property Required fields: 2
24
+ * @property Required fields: 1
25
25
  * @property Optional fields: 1
26
26
  */
27
27
  export interface UpdateConversationProperties {
@@ -68,6 +68,13 @@ export interface UpdatePgPaymentMethodProperties {
68
68
  * @type {LOOKUP}
69
69
  */
70
70
  Contact?: string | null;
71
+ /**
72
+ * InUse
73
+ *
74
+ * Payment method to be used for the customer, if true
75
+ * @type {BOOLEAN}
76
+ */
77
+ InUse?: boolean | null;
71
78
  /**
72
79
  * Message
73
80
  *
@@ -23,12 +23,12 @@ export declare enum ConfigEntityTypes {
23
23
  * Use these constants instead of string literals for type safety
24
24
  */
25
25
  export declare enum ConfigPropertyKeys {
26
- /** Data field for Config records. Used by Platform team. */
27
- Test = "Test",
26
+ /** the name of the app this config relates to (Platform - Config) */
27
+ AppName = "AppName",
28
28
  /** object of { key: value } mappings (Platform - Config) */
29
29
  Mappings = "Mappings",
30
- /** the name of the app this config relates to (Platform - Config) */
31
- AppName = "AppName"
30
+ /** Data field for Config records. Used by Platform team. */
31
+ Test = "Test"
32
32
  }
33
33
  /**
34
34
  * Properties for Config records
@@ -36,21 +36,21 @@ export declare enum ConfigPropertyKeys {
36
36
  * @see SchemaModule:Config
37
37
  */
38
38
  export interface ConfigProperties {
39
- /** Data field for Config records. Used by Platform team.
39
+ /** the name of the app this config relates to (Platform - Config)
40
40
  *
41
41
  * @type {TEXT}
42
42
  */
43
- Test: string;
43
+ AppName: string;
44
44
  /** object of { key: value } mappings (Platform - Config)
45
45
  *
46
46
  * @type {JSON}
47
47
  */
48
48
  Mappings: string;
49
- /** the name of the app this config relates to (Platform - Config)
49
+ /** Data field for Config records. Used by Platform team.
50
50
  *
51
51
  * @type {TEXT}
52
52
  */
53
- AppName: string;
53
+ Test: string;
54
54
  }
55
55
  /**
56
56
  * Config entity from SchemaModule
@@ -28,12 +28,12 @@ var ConfigEntityTypes;
28
28
  */
29
29
  var ConfigPropertyKeys;
30
30
  (function (ConfigPropertyKeys) {
31
- /** Data field for Config records. Used by Platform team. */
32
- ConfigPropertyKeys["Test"] = "Test";
33
- /** object of { key: value } mappings (Platform - Config) */
34
- ConfigPropertyKeys["Mappings"] = "Mappings";
35
31
  /** the name of the app this config relates to (Platform - Config) */
36
32
  ConfigPropertyKeys["AppName"] = "AppName";
33
+ /** object of { key: value } mappings (Platform - Config) */
34
+ ConfigPropertyKeys["Mappings"] = "Mappings";
35
+ /** Data field for Config records. Used by Platform team. */
36
+ ConfigPropertyKeys["Test"] = "Test";
37
37
  })(ConfigPropertyKeys = exports.ConfigPropertyKeys || (exports.ConfigPropertyKeys = {}));
38
38
  /**
39
39
  * Config entity from SchemaModule
@@ -44,8 +44,6 @@ export declare enum MessageSenderType {
44
44
  export declare enum MessagePropertyKeys {
45
45
  /** External ID of the message (Communications - Message) */
46
46
  ExternalId = "ExternalId",
47
- /** Who sent the message (Communications - Message) */
48
- From = "From",
49
47
  /** Message that indicates reason of not sending message (Communications - Message) */
50
48
  ErrorMessage = "ErrorMessage",
51
49
  /** Status of the message (CREATED,DELETED) (Communications - Message) */
@@ -54,6 +52,8 @@ export declare enum MessagePropertyKeys {
54
52
  Files = "Files",
55
53
  /** Content of the message (Communications - Message) */
56
54
  Body = "Body",
55
+ /** Who sent the message (Communications - Message) */
56
+ From = "From",
57
57
  /** Who receive the message (if needed) (Communications - Message) */
58
58
  To = "To",
59
59
  /** sender type (Communications - Message) */
@@ -70,11 +70,6 @@ export interface MessageProperties {
70
70
  * @type {TEXT}
71
71
  */
72
72
  ExternalId: string;
73
- /** Who sent the message (Communications - Message)
74
- *
75
- * @type {TEXT}
76
- */
77
- From: string;
78
73
  /** Message that indicates reason of not sending message (Communications - Message)
79
74
  *
80
75
  * @type {TEXT}
@@ -95,6 +90,11 @@ export interface MessageProperties {
95
90
  * @type {TEXT}
96
91
  */
97
92
  Body: string;
93
+ /** Who sent the message (Communications - Message)
94
+ *
95
+ * @type {TEXT}
96
+ */
97
+ From: string;
98
98
  /** Who receive the message (if needed) (Communications - Message)
99
99
  *
100
100
  * @type {TEXT}
@@ -118,11 +118,6 @@ export interface EventMessageProperties {
118
118
  * @type {TEXT}
119
119
  */
120
120
  ExternalId: string;
121
- /** Who sent the message (Communications - Message)
122
- *
123
- * @type {TEXT}
124
- */
125
- From: string;
126
121
  /** Message that indicates reason of not sending message (Communications - Message)
127
122
  *
128
123
  * @type {TEXT}
@@ -143,6 +138,11 @@ export interface EventMessageProperties {
143
138
  * @type {TEXT}
144
139
  */
145
140
  Body: string;
141
+ /** Who sent the message (Communications - Message)
142
+ *
143
+ * @type {TEXT}
144
+ */
145
+ From: string;
146
146
  /** Who receive the message (if needed) (Communications - Message)
147
147
  *
148
148
  * @type {TEXT}
@@ -48,8 +48,6 @@ var MessagePropertyKeys;
48
48
  (function (MessagePropertyKeys) {
49
49
  /** External ID of the message (Communications - Message) */
50
50
  MessagePropertyKeys["ExternalId"] = "ExternalId";
51
- /** Who sent the message (Communications - Message) */
52
- MessagePropertyKeys["From"] = "From";
53
51
  /** Message that indicates reason of not sending message (Communications - Message) */
54
52
  MessagePropertyKeys["ErrorMessage"] = "ErrorMessage";
55
53
  /** Status of the message (CREATED,DELETED) (Communications - Message) */
@@ -58,6 +56,8 @@ var MessagePropertyKeys;
58
56
  MessagePropertyKeys["Files"] = "Files";
59
57
  /** Content of the message (Communications - Message) */
60
58
  MessagePropertyKeys["Body"] = "Body";
59
+ /** Who sent the message (Communications - Message) */
60
+ MessagePropertyKeys["From"] = "From";
61
61
  /** Who receive the message (if needed) (Communications - Message) */
62
62
  MessagePropertyKeys["To"] = "To";
63
63
  /** sender type (Communications - Message) */
@@ -151,7 +151,9 @@ export declare enum PgPaymentMethodPropertyKeys {
151
151
  /** Message */
152
152
  Message = "Message",
153
153
  /** Company */
154
- Company = "Company"
154
+ Company = "Company",
155
+ /** Payment method to be used for the customer, if true */
156
+ InUse = "InUse"
155
157
  }
156
158
  /**
157
159
  * Properties for PgPaymentMethod records
@@ -244,6 +246,11 @@ export interface PgPaymentMethodProperties {
244
246
  * @enum {PgPaymentMethodCompany}
245
247
  */
246
248
  Company: PgPaymentMethodCompany;
249
+ /** Payment method to be used for the customer, if true
250
+ *
251
+ * @type {BOOLEAN}
252
+ */
253
+ InUse: boolean;
247
254
  }
248
255
  /**
249
256
  * PgPaymentMethod entity from BillingModule
@@ -157,6 +157,8 @@ var PgPaymentMethodPropertyKeys;
157
157
  PgPaymentMethodPropertyKeys["Message"] = "Message";
158
158
  /** Company */
159
159
  PgPaymentMethodPropertyKeys["Company"] = "Company";
160
+ /** Payment method to be used for the customer, if true */
161
+ PgPaymentMethodPropertyKeys["InUse"] = "InUse";
160
162
  })(PgPaymentMethodPropertyKeys = exports.PgPaymentMethodPropertyKeys || (exports.PgPaymentMethodPropertyKeys = {}));
161
163
  /**
162
164
  * PgPaymentMethod entity from BillingModule
@@ -25,6 +25,7 @@ import { RecordLinkManager } from '@d19n/odin-sdk-generator/dist/record-link-man
25
25
  import { ConversationProperties } from '../entities-v2/Conversation';
26
26
  import { CloseConversationProperties } from '../actions-v2/CloseConversationDto';
27
27
  import { CreateConversationProperties } from '../actions-v2/CreateCaseForChatDto';
28
+ import { ReopenConversationProperties } from '../actions-v2/ReopenConversationDto';
28
29
  import { UpdateConversationProperties } from '../actions-v2/UpdateConversationDto';
29
30
  import { MessageRecord } from './MessageRecord';
30
31
  import { CaseRecord } from './CaseRecord';
@@ -217,6 +218,32 @@ export declare class ConversationRecord<TProps = ConversationProperties> {
217
218
  journeyId?: string;
218
219
  stageKey?: string;
219
220
  }): ActionBuilder;
221
+ /**
222
+ * ReopenConversation
223
+ *
224
+ * Updates this Conversation record with the specified properties.
225
+ * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
226
+ *
227
+ * @param properties - Required properties for this action
228
+ * @param options - Optional settings
229
+ * @param options.journeyId - Associate with a journey
230
+ * @param options.stageKey - Transition to pipeline stage
231
+ * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
232
+ * @throws Error if called on a new (unsaved) record
233
+ *
234
+ * @example
235
+ * ```typescript
236
+ * const record = await odinClient.conversations.get(id);
237
+ * await record.reopenConversation({ ... }).execute();
238
+ *
239
+ * // Dry run (for debugging)
240
+ * const payload = record.reopenConversation({ ... }).dryRun();
241
+ * ```
242
+ */
243
+ reopenConversation(properties: ReopenConversationProperties, options?: {
244
+ journeyId?: string;
245
+ stageKey?: string;
246
+ }): ActionBuilder;
220
247
  /**
221
248
  * UpdateConversation
222
249
  *
@@ -292,6 +292,35 @@ class ConversationRecord {
292
292
  const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'CloseConversation', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
293
293
  return new ActionBuilder(this._provider, 'NotificationModule', 'Conversation', payload, () => { this._pendingLinks = []; });
294
294
  }
295
+ /**
296
+ * ReopenConversation
297
+ *
298
+ * Updates this Conversation record with the specified properties.
299
+ * Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
300
+ *
301
+ * @param properties - Required properties for this action
302
+ * @param options - Optional settings
303
+ * @param options.journeyId - Associate with a journey
304
+ * @param options.stageKey - Transition to pipeline stage
305
+ * @returns ActionBuilder - call .execute() to update or .dryRun() for payload
306
+ * @throws Error if called on a new (unsaved) record
307
+ *
308
+ * @example
309
+ * ```typescript
310
+ * const record = await odinClient.conversations.get(id);
311
+ * await record.reopenConversation({ ... }).execute();
312
+ *
313
+ * // Dry run (for debugging)
314
+ * const payload = record.reopenConversation({ ... }).dryRun();
315
+ * ```
316
+ */
317
+ reopenConversation(properties, options) {
318
+ var _a;
319
+ if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
320
+ throw new Error('reopenConversation requires an existing record. Use accessor.get() first.');
321
+ const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'ReopenConversation', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
322
+ return new ActionBuilder(this._provider, 'NotificationModule', 'Conversation', payload, () => { this._pendingLinks = []; });
323
+ }
295
324
  /**
296
325
  * UpdateConversation
297
326
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@d19n/youfibre-odin-sdk",
3
- "version": "1.0.332",
3
+ "version": "1.0.334",
4
4
  "description": "",
5
5
  "author": "@d19n",
6
6
  "license": "UNLICENSED",