@d19n/youfibre-odin-sdk 2.0.46 → 2.0.47
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 +14 -3
- package/dist/actions-v2/AssignCaseTransitionDto.d.ts +141 -2
- package/dist/actions-v2/AssignCaseTransitionDto.js +90 -4
- package/dist/actions-v2/CaseDefaultStageEscalatedDto.d.ts +152 -19
- package/dist/actions-v2/CaseDefaultStageEscalatedDto.js +101 -23
- package/dist/actions-v2/CrmDatasetCreateDto.d.ts +8 -1
- package/dist/actions-v2/EscalateCaseActionBrskDto.d.ts +91 -0
- package/dist/actions-v2/EscalateCaseActionBrskDto.js +56 -0
- package/dist/actions-v2/EscalateCaseActionYfDto.d.ts +82 -0
- package/dist/actions-v2/EscalateCaseActionYfDto.js +56 -0
- package/dist/actions-v2/EscalateCaseActionYfcsDto.d.ts +89 -0
- package/dist/actions-v2/EscalateCaseActionYfcsDto.js +56 -0
- package/dist/actions-v2/UpdateExternalServiceIdDto.d.ts +73 -0
- package/dist/actions-v2/UpdateExternalServiceIdDto.js +56 -0
- package/dist/actions-v2/UpdateTeamDto.d.ts +3 -3
- package/dist/api-sdk-v2/CrmDatasetApi.d.ts +2 -0
- package/dist/api-sdk-v2/CrmDatasetApi.js +6 -0
- package/dist/api-sdk-v2/ExchangeApi.d.ts +2 -0
- package/dist/api-sdk-v2/ExchangeApi.js +6 -0
- package/dist/db-sdk-v2/CrmDatasetDb.d.ts +2 -0
- package/dist/db-sdk-v2/CrmDatasetDb.js +6 -0
- package/dist/db-sdk-v2/ExchangeDb.d.ts +2 -0
- package/dist/db-sdk-v2/ExchangeDb.js +6 -0
- package/dist/entities-v2/Address.d.ts +8 -1
- package/dist/entities-v2/Address.js +2 -0
- package/dist/entities-v2/Config.d.ts +8 -8
- package/dist/entities-v2/Config.js +4 -4
- package/dist/entities-v2/CreditNote.d.ts +20 -20
- package/dist/entities-v2/CreditNote.js +6 -6
- package/dist/entities-v2/CrmDataset.d.ts +3 -4
- package/dist/entities-v2/Exchange.d.ts +7 -0
- package/dist/entities-v2/Exchange.js +5 -1
- package/dist/entities-v2/Team.d.ts +12 -10
- package/dist/entities-v2/Team.js +13 -11
- package/dist/records-v2/AddressRecord.d.ts +27 -0
- package/dist/records-v2/AddressRecord.js +29 -0
- package/dist/records-v2/CaseRecord.d.ts +207 -13
- package/dist/records-v2/CaseRecord.js +312 -16
- package/dist/records-v2/CrmDatasetRecord.d.ts +20 -0
- package/dist/records-v2/CrmDatasetRecord.js +33 -0
- package/dist/records-v2/ExchangeRecord.d.ts +20 -0
- package/dist/records-v2/ExchangeRecord.js +33 -0
- package/package.json +1 -1
package/dist/entities-v2/Team.js
CHANGED
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
* Generated from Odin schema definition
|
|
13
13
|
*/
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
|
-
exports.ROUTING_KEY_LINK_TEAM_USER_DELETED = exports.ROUTING_KEY_LINK_TEAM_USER_CREATED = exports.ROUTING_KEY_TEAM_DEFAULT_DELETED = exports.ROUTING_KEY_TEAM_DEFAULT_UPDATED = exports.ROUTING_KEY_TEAM_DEFAULT_CREATED = exports.ROUTING_KEY_TEAM_DELETED = exports.ROUTING_KEY_TEAM_UPDATED = exports.ROUTING_KEY_TEAM_CREATED = exports.Team = exports.TeamPropertyKeys = exports.
|
|
15
|
+
exports.ROUTING_KEY_LINK_TEAM_USER_DELETED = exports.ROUTING_KEY_LINK_TEAM_USER_CREATED = exports.ROUTING_KEY_TEAM_DEFAULT_DELETED = exports.ROUTING_KEY_TEAM_DEFAULT_UPDATED = exports.ROUTING_KEY_TEAM_DEFAULT_CREATED = exports.ROUTING_KEY_TEAM_DELETED = exports.ROUTING_KEY_TEAM_UPDATED = exports.ROUTING_KEY_TEAM_CREATED = exports.Team = exports.TeamPropertyKeys = exports.TeamDomain = exports.TeamSupportTeam = exports.TeamPrimaryChannel = exports.TeamCanEscalateTo = exports.TeamWorksCases = exports.TeamSecondaryChannel = exports.TeamSocialAccess = exports.TeamEntityTypes = void 0;
|
|
16
16
|
const core_1 = require("@d19n/odin-types/dist/core");
|
|
17
17
|
/**
|
|
18
18
|
* Available types for Team records
|
|
@@ -111,19 +111,21 @@ var TeamSupportTeam;
|
|
|
111
111
|
TeamSupportTeam["YES"] = "YES";
|
|
112
112
|
})(TeamSupportTeam = exports.TeamSupportTeam || (exports.TeamSupportTeam = {}));
|
|
113
113
|
/**
|
|
114
|
-
* Valid values for Team.
|
|
114
|
+
* Valid values for Team.Domain
|
|
115
115
|
*
|
|
116
|
-
*
|
|
116
|
+
* Domain
|
|
117
117
|
*
|
|
118
118
|
* @remarks Available options:
|
|
119
119
|
* - `Brsk`
|
|
120
|
-
* - `
|
|
120
|
+
* - `Joint support`
|
|
121
|
+
* - `YouFibre`
|
|
121
122
|
*/
|
|
122
|
-
var
|
|
123
|
-
(function (
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
123
|
+
var TeamDomain;
|
|
124
|
+
(function (TeamDomain) {
|
|
125
|
+
TeamDomain["BRSK"] = "Brsk";
|
|
126
|
+
TeamDomain["JOINT_SUPPORT"] = "Joint support";
|
|
127
|
+
TeamDomain["YOU_FIBRE"] = "YouFibre";
|
|
128
|
+
})(TeamDomain = exports.TeamDomain || (exports.TeamDomain = {}));
|
|
127
129
|
/**
|
|
128
130
|
* Property keys for Team
|
|
129
131
|
* Use these constants instead of string literals for type safety
|
|
@@ -150,8 +152,8 @@ var TeamPropertyKeys;
|
|
|
150
152
|
TeamPropertyKeys["TwilioSupport"] = "TwilioSupport";
|
|
151
153
|
/** Flags if this is a support team (IT Security - Team) */
|
|
152
154
|
TeamPropertyKeys["SupportTeam"] = "SupportTeam";
|
|
153
|
-
/**
|
|
154
|
-
TeamPropertyKeys["
|
|
155
|
+
/** Domain */
|
|
156
|
+
TeamPropertyKeys["Domain"] = "Domain";
|
|
155
157
|
})(TeamPropertyKeys = exports.TeamPropertyKeys || (exports.TeamPropertyKeys = {}));
|
|
156
158
|
/**
|
|
157
159
|
* Team entity from IdentityModule
|
|
@@ -25,6 +25,7 @@ import { AddressCreateProperties } from '../actions-v2/AddressCreateDto';
|
|
|
25
25
|
import { AddressUpdateProperties } from '../actions-v2/AddressUpdateDto';
|
|
26
26
|
import { CreateLeadProperties } from '../actions-v2/CreateLeadFromAddressDto';
|
|
27
27
|
import { CreateContactProperties } from '../actions-v2/CreateLeadFromAddressDto';
|
|
28
|
+
import { UpdateExternalServiceIdProperties } from '../actions-v2/UpdateExternalServiceIdDto';
|
|
28
29
|
import { OrderRecord } from './OrderRecord';
|
|
29
30
|
import { CustomerDeviceOntRecord } from './CustomerDeviceOntRecord';
|
|
30
31
|
import { AppointmentRecord } from './AppointmentRecord';
|
|
@@ -601,6 +602,32 @@ export declare class AddressRecord<TProps = AddressProperties> {
|
|
|
601
602
|
createLeadFromAddress(options?: {
|
|
602
603
|
journeyId?: string;
|
|
603
604
|
}): CreateLeadFromAddressFlowBuilder;
|
|
605
|
+
/**
|
|
606
|
+
* UpdateExternalServiceId
|
|
607
|
+
*
|
|
608
|
+
* Updates this Address record with the specified properties.
|
|
609
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
610
|
+
*
|
|
611
|
+
* @param properties - Required properties for this action
|
|
612
|
+
* @param options - Optional settings
|
|
613
|
+
* @param options.journeyId - Associate with a journey
|
|
614
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
615
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
616
|
+
* @throws Error if called on a new (unsaved) record
|
|
617
|
+
*
|
|
618
|
+
* @example
|
|
619
|
+
* ```typescript
|
|
620
|
+
* const record = await odinClient.addresss.get(id);
|
|
621
|
+
* await record.updateExternalServiceId({ ... }).execute();
|
|
622
|
+
*
|
|
623
|
+
* // Dry run (for debugging)
|
|
624
|
+
* const payload = record.updateExternalServiceId({ ... }).dryRun();
|
|
625
|
+
* ```
|
|
626
|
+
*/
|
|
627
|
+
updateExternalServiceId(properties: UpdateExternalServiceIdProperties, options?: {
|
|
628
|
+
journeyId?: string;
|
|
629
|
+
stageKey?: string;
|
|
630
|
+
}): ActionBuilder;
|
|
604
631
|
}
|
|
605
632
|
/** Type guard to check if an object is a AddressRecord */
|
|
606
633
|
export declare function isAddressRecord(obj: any): obj is AddressRecord;
|
|
@@ -895,6 +895,35 @@ class AddressRecord {
|
|
|
895
895
|
createLeadFromAddress(options) {
|
|
896
896
|
return new CreateLeadFromAddressFlowBuilder(this, this._provider, this._pendingLinks, options);
|
|
897
897
|
}
|
|
898
|
+
/**
|
|
899
|
+
* UpdateExternalServiceId
|
|
900
|
+
*
|
|
901
|
+
* Updates this Address record with the specified properties.
|
|
902
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
903
|
+
*
|
|
904
|
+
* @param properties - Required properties for this action
|
|
905
|
+
* @param options - Optional settings
|
|
906
|
+
* @param options.journeyId - Associate with a journey
|
|
907
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
908
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
909
|
+
* @throws Error if called on a new (unsaved) record
|
|
910
|
+
*
|
|
911
|
+
* @example
|
|
912
|
+
* ```typescript
|
|
913
|
+
* const record = await odinClient.addresss.get(id);
|
|
914
|
+
* await record.updateExternalServiceId({ ... }).execute();
|
|
915
|
+
*
|
|
916
|
+
* // Dry run (for debugging)
|
|
917
|
+
* const payload = record.updateExternalServiceId({ ... }).dryRun();
|
|
918
|
+
* ```
|
|
919
|
+
*/
|
|
920
|
+
updateExternalServiceId(properties, options) {
|
|
921
|
+
var _a;
|
|
922
|
+
if (!((_a = this._record) === null || _a === void 0 ? void 0 : _a.id))
|
|
923
|
+
throw new Error('updateExternalServiceId requires an existing record. Use accessor.get() first.');
|
|
924
|
+
const payload = Object.assign({ id: this._record.id, entity: this._record.entity, type: this._record.type, actionName: 'UpdateExternalServiceId', properties, associations: this._pendingLinks.length > 0 ? this._pendingLinks : undefined }, options);
|
|
925
|
+
return new ActionBuilder(this._provider, 'CrmModule', 'Address', payload, () => { this._pendingLinks = []; });
|
|
926
|
+
}
|
|
898
927
|
}
|
|
899
928
|
exports.AddressRecord = AddressRecord;
|
|
900
929
|
// ============================================
|
|
@@ -26,8 +26,10 @@ import { CaseProperties, OutageCaseProperties } from '../entities-v2/Case';
|
|
|
26
26
|
import { AllowCsatForCaseProperties } from '../actions-v2/AllowCsatForCaseDto';
|
|
27
27
|
import { AssignCaseByUserProperties } from '../actions-v2/AssignCaseByUserDto';
|
|
28
28
|
import { AssignCaseProperties } from '../actions-v2/AssignCaseDto';
|
|
29
|
+
import { EscalateCaseActionBrskProperties } from '../actions-v2/AssignCaseTransitionDto';
|
|
29
30
|
import { CreateNoteForCaseAssignmentProperties } from '../actions-v2/AssignCaseWithNoteFlowDto';
|
|
30
|
-
import {
|
|
31
|
+
import { EscalateCaseActionYfProperties } from '../actions-v2/CaseDefaultStageEscalatedDto';
|
|
32
|
+
import { EscalateCaseActionYfcsProperties } from '../actions-v2/CaseDefaultStageEscalatedDto';
|
|
31
33
|
import { MoveCaseToBlockedActionProperties } from '../actions-v2/CasedefaultstageblockedDto';
|
|
32
34
|
import { ChangeCaseChannelProperties } from '../actions-v2/ChangeCaseChannelDto';
|
|
33
35
|
import { CreateCaseProperties } from '../actions-v2/CreateCaseDto';
|
|
@@ -35,6 +37,7 @@ import { CreateCaseFromCasesProperties } from '../actions-v2/CreateCaseFromCases
|
|
|
35
37
|
import { CreateCaseWithDpaProperties } from '../actions-v2/CreateCaseWithDpaDto';
|
|
36
38
|
import { EditCaseFormProperties } from '../actions-v2/EditCaseFormDto';
|
|
37
39
|
import { EditProvidersProperties } from '../actions-v2/EditProvidersDto';
|
|
40
|
+
import { EscalateCaseActionProperties } from '../actions-v2/EscalateCaseActionDto';
|
|
38
41
|
import { ExceptionInputProperties } from '../actions-v2/ExceptionInputDto';
|
|
39
42
|
import { MarkCaseClosedProperties } from '../actions-v2/MarkCaseClosedDto';
|
|
40
43
|
import { MarkCaseResolvedProperties } from '../actions-v2/MarkCaseResolvedDto';
|
|
@@ -125,6 +128,75 @@ declare class ActionBuilder<T = IDbRecordCreateUpdateRes[]> {
|
|
|
125
128
|
then(): never;
|
|
126
129
|
}
|
|
127
130
|
/** Options for a flow step */
|
|
131
|
+
export interface AssignCaseTransitionFlowBuilderStepOptions {
|
|
132
|
+
/** Associations to create with this step */
|
|
133
|
+
associations?: Array<{
|
|
134
|
+
recordId?: string;
|
|
135
|
+
entity?: string;
|
|
136
|
+
}>;
|
|
137
|
+
/** Groups for this step */
|
|
138
|
+
groups?: string[];
|
|
139
|
+
}
|
|
140
|
+
/**
|
|
141
|
+
* FlowBuilder for AssignCaseTransition multi-step action
|
|
142
|
+
*
|
|
143
|
+
* Use method chaining to add steps, then call execute() to run the flow.
|
|
144
|
+
*/
|
|
145
|
+
export declare class AssignCaseTransitionFlowBuilder {
|
|
146
|
+
private _record;
|
|
147
|
+
private _provider;
|
|
148
|
+
private _pendingLinks;
|
|
149
|
+
private _options?;
|
|
150
|
+
private _groups;
|
|
151
|
+
private _steps;
|
|
152
|
+
constructor(record: CaseRecord<any>, provider: IOdinProvider, pendingLinks: OdinRecordLinkDto[], options?: {
|
|
153
|
+
journeyId?: string;
|
|
154
|
+
});
|
|
155
|
+
/**
|
|
156
|
+
* Add a group to the main action
|
|
157
|
+
* @param group - Group name to add
|
|
158
|
+
* @returns this (for method chaining)
|
|
159
|
+
*/
|
|
160
|
+
addGroup(group: string): this;
|
|
161
|
+
/**
|
|
162
|
+
* Add AssignCase step to the flow
|
|
163
|
+
* @param id - ID of the record to update
|
|
164
|
+
* @param properties - Properties for this step
|
|
165
|
+
* @param options - Optional step settings
|
|
166
|
+
* @returns this (for method chaining)
|
|
167
|
+
*/
|
|
168
|
+
assignCase(id: string, properties: AssignCaseProperties, options?: AssignCaseTransitionFlowBuilderStepOptions): this;
|
|
169
|
+
/**
|
|
170
|
+
* Add EscalateCaseActionBrsk step to the flow
|
|
171
|
+
* @param id - ID of the record to update
|
|
172
|
+
* @param properties - Properties for this step
|
|
173
|
+
* @param options - Optional step settings
|
|
174
|
+
* @returns this (for method chaining)
|
|
175
|
+
*/
|
|
176
|
+
escalateCaseActionBrsk(id: string, properties: EscalateCaseActionBrskProperties, options?: AssignCaseTransitionFlowBuilderStepOptions): this;
|
|
177
|
+
/**
|
|
178
|
+
* Execute the flow
|
|
179
|
+
* @returns The result from the API
|
|
180
|
+
*/
|
|
181
|
+
execute(): Promise<IDbRecordCreateUpdateRes[]>;
|
|
182
|
+
/**
|
|
183
|
+
* Returns the request payload without executing (for debugging)
|
|
184
|
+
* @returns The request payload that would be sent to the API
|
|
185
|
+
*/
|
|
186
|
+
dryRun(): Record<string, any>;
|
|
187
|
+
/**
|
|
188
|
+
* Prevents accidental `await flowBuilder` without .execute()
|
|
189
|
+
* Forces developers to explicitly call .execute()
|
|
190
|
+
* @throws Error always - use .execute() or .dryRun() instead
|
|
191
|
+
*/
|
|
192
|
+
then(): never;
|
|
193
|
+
/**
|
|
194
|
+
* Build the request payload for the action
|
|
195
|
+
* @private
|
|
196
|
+
*/
|
|
197
|
+
private _buildRequestPayload;
|
|
198
|
+
}
|
|
199
|
+
/** Options for a flow step */
|
|
128
200
|
export interface AssignCaseWithNoteFlowFlowBuilderStepOptions {
|
|
129
201
|
/** Associations to create with this step */
|
|
130
202
|
associations?: Array<{
|
|
@@ -225,13 +297,29 @@ export declare class CaseDefaultStageEscalatedFlowBuilder {
|
|
|
225
297
|
*/
|
|
226
298
|
addGroup(group: string): this;
|
|
227
299
|
/**
|
|
228
|
-
* Add
|
|
300
|
+
* Add EscalateCaseActionYF step to the flow
|
|
229
301
|
* @param id - ID of the record to update
|
|
230
302
|
* @param properties - Properties for this step
|
|
231
303
|
* @param options - Optional step settings
|
|
232
304
|
* @returns this (for method chaining)
|
|
233
305
|
*/
|
|
234
|
-
|
|
306
|
+
escalateCaseActionYf(id: string, properties: EscalateCaseActionYfProperties, options?: CaseDefaultStageEscalatedFlowBuilderStepOptions): this;
|
|
307
|
+
/**
|
|
308
|
+
* Add EscalateCaseActionBrsk step to the flow
|
|
309
|
+
* @param id - ID of the record to update
|
|
310
|
+
* @param properties - Properties for this step
|
|
311
|
+
* @param options - Optional step settings
|
|
312
|
+
* @returns this (for method chaining)
|
|
313
|
+
*/
|
|
314
|
+
escalateCaseActionBrsk(id: string, properties: EscalateCaseActionBrskProperties, options?: CaseDefaultStageEscalatedFlowBuilderStepOptions): this;
|
|
315
|
+
/**
|
|
316
|
+
* Add EscalateCaseActionYFCS step to the flow
|
|
317
|
+
* @param id - ID of the record to update
|
|
318
|
+
* @param properties - Properties for this step
|
|
319
|
+
* @param options - Optional step settings
|
|
320
|
+
* @returns this (for method chaining)
|
|
321
|
+
*/
|
|
322
|
+
escalateCaseActionYfcs(id: string, properties: EscalateCaseActionYfcsProperties, options?: CaseDefaultStageEscalatedFlowBuilderStepOptions): this;
|
|
235
323
|
/**
|
|
236
324
|
* Add CreateNoteForCaseAssignment step to the flow
|
|
237
325
|
* @param properties - Properties for this step
|
|
@@ -1230,6 +1318,56 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
1230
1318
|
journeyId?: string;
|
|
1231
1319
|
stageKey?: string;
|
|
1232
1320
|
}): ActionBuilder;
|
|
1321
|
+
/**
|
|
1322
|
+
* EscalateCaseActionBrsk
|
|
1323
|
+
*
|
|
1324
|
+
* Updates this Case record with the specified properties.
|
|
1325
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
1326
|
+
*
|
|
1327
|
+
* @param properties - Required properties for this action
|
|
1328
|
+
* @param options - Optional settings
|
|
1329
|
+
* @param options.journeyId - Associate with a journey
|
|
1330
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
1331
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
1332
|
+
* @throws Error if called on a new (unsaved) record
|
|
1333
|
+
*
|
|
1334
|
+
* @example
|
|
1335
|
+
* ```typescript
|
|
1336
|
+
* const record = await odinClient.cases.get(id);
|
|
1337
|
+
* await record.escalateCaseActionBrsk({ ... }).execute();
|
|
1338
|
+
*
|
|
1339
|
+
* // Dry run (for debugging)
|
|
1340
|
+
* const payload = record.escalateCaseActionBrsk({ ... }).dryRun();
|
|
1341
|
+
* ```
|
|
1342
|
+
*/
|
|
1343
|
+
escalateCaseActionBrsk(properties: EscalateCaseActionBrskProperties, options?: {
|
|
1344
|
+
journeyId?: string;
|
|
1345
|
+
stageKey?: string;
|
|
1346
|
+
}): ActionBuilder;
|
|
1347
|
+
/**
|
|
1348
|
+
* AssignCaseTransition
|
|
1349
|
+
*
|
|
1350
|
+
* Starts a multi-step flow action on this Case record.
|
|
1351
|
+
* Chain step methods and call .execute() to run the flow.
|
|
1352
|
+
* Individual steps determine their own ID requirements (CREATE vs UPDATE).
|
|
1353
|
+
*
|
|
1354
|
+
* @param options - Optional settings
|
|
1355
|
+
* @param options.journeyId - Associate with a journey
|
|
1356
|
+
* @returns FlowBuilder for chaining step methods
|
|
1357
|
+
*
|
|
1358
|
+
* @example
|
|
1359
|
+
* ```typescript
|
|
1360
|
+
* // Can be called on new() or get() - steps determine ID requirements
|
|
1361
|
+
* const record = odinClient.cases.new();
|
|
1362
|
+
* await record.assignCaseTransition()
|
|
1363
|
+
* .assignCase(recordId, { ... })
|
|
1364
|
+
* .escalateCaseActionBrsk(recordId, { ... })
|
|
1365
|
+
* .execute();
|
|
1366
|
+
* ```
|
|
1367
|
+
*/
|
|
1368
|
+
assignCaseTransition(options?: {
|
|
1369
|
+
journeyId?: string;
|
|
1370
|
+
}): AssignCaseTransitionFlowBuilder;
|
|
1233
1371
|
/**
|
|
1234
1372
|
* AssignCaseWithNoteFlow
|
|
1235
1373
|
*
|
|
@@ -1255,28 +1393,56 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
1255
1393
|
journeyId?: string;
|
|
1256
1394
|
}): AssignCaseWithNoteFlowFlowBuilder;
|
|
1257
1395
|
/**
|
|
1258
|
-
*
|
|
1396
|
+
* EscalateCaseActionYF
|
|
1259
1397
|
*
|
|
1260
|
-
* Updates this Case record
|
|
1398
|
+
* Updates this Case record.
|
|
1261
1399
|
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
1262
1400
|
*
|
|
1263
|
-
* @param
|
|
1264
|
-
* @param options - Optional settings
|
|
1265
|
-
* @param options.journeyId - Associate with a journey
|
|
1266
|
-
* @param options.stageKey - Transition to pipeline stage
|
|
1401
|
+
* @param propertiesOrOptions - Properties to update, or options object
|
|
1402
|
+
* @param options - Optional settings (journeyId, stageKey)
|
|
1267
1403
|
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
1268
1404
|
* @throws Error if called on a new (unsaved) record
|
|
1269
1405
|
*
|
|
1270
1406
|
* @example
|
|
1271
1407
|
* ```typescript
|
|
1272
1408
|
* const record = await odinClient.cases.get(id);
|
|
1273
|
-
* await record.
|
|
1409
|
+
* await record.escalateCaseActionYf({ ... }).execute();
|
|
1274
1410
|
*
|
|
1275
1411
|
* // Dry run (for debugging)
|
|
1276
|
-
* const payload = record.
|
|
1412
|
+
* const payload = record.escalateCaseActionYf({ ... }).dryRun();
|
|
1277
1413
|
* ```
|
|
1278
1414
|
*/
|
|
1279
|
-
|
|
1415
|
+
escalateCaseActionYf(propertiesOrOptions?: EscalateCaseActionYfProperties | {
|
|
1416
|
+
journeyId?: string;
|
|
1417
|
+
stageKey?: string;
|
|
1418
|
+
}, options?: {
|
|
1419
|
+
journeyId?: string;
|
|
1420
|
+
stageKey?: string;
|
|
1421
|
+
}): ActionBuilder;
|
|
1422
|
+
/**
|
|
1423
|
+
* EscalateCaseActionYFCS
|
|
1424
|
+
*
|
|
1425
|
+
* Updates this Case record.
|
|
1426
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
1427
|
+
*
|
|
1428
|
+
* @param propertiesOrOptions - Properties to update, or options object
|
|
1429
|
+
* @param options - Optional settings (journeyId, stageKey)
|
|
1430
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
1431
|
+
* @throws Error if called on a new (unsaved) record
|
|
1432
|
+
*
|
|
1433
|
+
* @example
|
|
1434
|
+
* ```typescript
|
|
1435
|
+
* const record = await odinClient.cases.get(id);
|
|
1436
|
+
* await record.escalateCaseActionYfcs({ ... }).execute();
|
|
1437
|
+
*
|
|
1438
|
+
* // Dry run (for debugging)
|
|
1439
|
+
* const payload = record.escalateCaseActionYfcs({ ... }).dryRun();
|
|
1440
|
+
* ```
|
|
1441
|
+
*/
|
|
1442
|
+
escalateCaseActionYfcs(propertiesOrOptions?: EscalateCaseActionYfcsProperties | {
|
|
1443
|
+
journeyId?: string;
|
|
1444
|
+
stageKey?: string;
|
|
1445
|
+
}, options?: {
|
|
1280
1446
|
journeyId?: string;
|
|
1281
1447
|
stageKey?: string;
|
|
1282
1448
|
}): ActionBuilder;
|
|
@@ -1297,7 +1463,9 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
1297
1463
|
* ```typescript
|
|
1298
1464
|
* const record = await odinClient.cases.get(id);
|
|
1299
1465
|
* await record.caseDefaultStageEscalated()
|
|
1300
|
-
* .
|
|
1466
|
+
* .escalateCaseActionYf(recordId, { ... })
|
|
1467
|
+
* .escalateCaseActionBrsk(recordId, { ... })
|
|
1468
|
+
* .escalateCaseActionYfcs(recordId, { ... })
|
|
1301
1469
|
* .createNoteForCaseAssignment({ ... })
|
|
1302
1470
|
* .execute();
|
|
1303
1471
|
* ```
|
|
@@ -1460,6 +1628,32 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
1460
1628
|
journeyId?: string;
|
|
1461
1629
|
stageKey?: string;
|
|
1462
1630
|
}): ActionBuilder;
|
|
1631
|
+
/**
|
|
1632
|
+
* EscalateCaseAction
|
|
1633
|
+
*
|
|
1634
|
+
* Updates this Case record with the specified properties.
|
|
1635
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
1636
|
+
*
|
|
1637
|
+
* @param properties - Required properties for this action
|
|
1638
|
+
* @param options - Optional settings
|
|
1639
|
+
* @param options.journeyId - Associate with a journey
|
|
1640
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
1641
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
1642
|
+
* @throws Error if called on a new (unsaved) record
|
|
1643
|
+
*
|
|
1644
|
+
* @example
|
|
1645
|
+
* ```typescript
|
|
1646
|
+
* const record = await odinClient.cases.get(id);
|
|
1647
|
+
* await record.escalateCaseAction({ ... }).execute();
|
|
1648
|
+
*
|
|
1649
|
+
* // Dry run (for debugging)
|
|
1650
|
+
* const payload = record.escalateCaseAction({ ... }).dryRun();
|
|
1651
|
+
* ```
|
|
1652
|
+
*/
|
|
1653
|
+
escalateCaseAction(properties: EscalateCaseActionProperties, options?: {
|
|
1654
|
+
journeyId?: string;
|
|
1655
|
+
stageKey?: string;
|
|
1656
|
+
}): ActionBuilder;
|
|
1463
1657
|
/**
|
|
1464
1658
|
* EscalateCaseTransition
|
|
1465
1659
|
*
|