@d19n/youfibre-odin-sdk 2.0.199 → 2.0.200
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 +5 -5
- package/dist/EntityRegistry.d.ts +2 -2
- package/dist/EntityRegistry.js +2 -2
- package/dist/OdinApiClient.d.ts +4 -4
- package/dist/OdinApiClient.js +8 -8
- package/dist/OdinDbClient.d.ts +4 -4
- package/dist/OdinDbClient.js +8 -8
- package/dist/accessors-v2/index.d.ts +1 -1
- package/dist/accessors-v2/index.js +3 -3
- package/dist/actions-v2/CreateOutboundCallDto.d.ts +9 -1
- package/dist/db-accessors-v2/index.d.ts +1 -1
- package/dist/db-accessors-v2/index.js +3 -3
- package/dist/entities-v2/PaymentMethodRefund.d.ts +4 -0
- package/dist/entities-v2/PaymentMethodRefund.js +4 -0
- package/dist/entities-v2/WorkOrder.d.ts +3 -2
- package/dist/entities-v2/WorkOrder.js +3 -2
- package/dist/records-v2/CaseRecord.d.ts +122 -122
- package/dist/records-v2/CaseRecord.js +177 -177
- package/dist/records-v2/PaymentRecord.d.ts +22 -22
- package/dist/records-v2/PaymentRecord.js +24 -24
- package/package.json +1 -1
|
@@ -27,16 +27,16 @@ import { AllowCsatForCaseProperties } from '../actions-v2/AllowCsatForCaseDto';
|
|
|
27
27
|
import { AssignCaseByUserProperties } from '../actions-v2/AssignCaseByUserDto';
|
|
28
28
|
import { AssignCaseProperties } from '../actions-v2/AssignCaseDto';
|
|
29
29
|
import { CreateNoteForCaseAssignmentProperties } from '../actions-v2/AssignCaseWithNoteFlowDto';
|
|
30
|
-
import { MoveCaseToBlockedActionProperties } from '../actions-v2/CasedefaultstageblockedDto';
|
|
31
30
|
import { EscalateCaseActionProperties } from '../actions-v2/CaseDefaultStageEscalatedDto';
|
|
31
|
+
import { MoveCaseToBlockedActionProperties } from '../actions-v2/CaseTransitionEscalatedToBlockedDto';
|
|
32
32
|
import { ChangeCaseChannelProperties } from '../actions-v2/ChangeCaseChannelDto';
|
|
33
33
|
import { CreateCaseProperties } from '../actions-v2/CreateCaseDto';
|
|
34
34
|
import { CreateCaseFromCasesProperties } from '../actions-v2/CreateCaseFromCasesDto';
|
|
35
35
|
import { CreateCaseWithDpaProperties } from '../actions-v2/CreateCaseWithDpaDto';
|
|
36
36
|
import { EditCaseFormProperties } from '../actions-v2/EditCaseFormDto';
|
|
37
37
|
import { EscalateCaseActionBrskProperties } from '../actions-v2/EscalateCaseActionBrskDto';
|
|
38
|
-
import { EscalateCaseActionYfcsProperties } from '../actions-v2/EscalateCaseActionYfcsDto';
|
|
39
38
|
import { EscalateCaseActionYfProperties } from '../actions-v2/EscalateCaseActionYfDto';
|
|
39
|
+
import { EscalateCaseActionYfcsProperties } from '../actions-v2/EscalateCaseActionYfcsDto';
|
|
40
40
|
import { ExceptionInputProperties } from '../actions-v2/ExceptionInputDto';
|
|
41
41
|
import { MarkCaseClosedProperties } from '../actions-v2/MarkCaseClosedDto';
|
|
42
42
|
import { MarkCaseResolvedProperties } from '../actions-v2/MarkCaseResolvedDto';
|
|
@@ -195,68 +195,6 @@ export declare class AssignCaseWithNoteFlowFlowBuilder {
|
|
|
195
195
|
private _buildRequestPayload;
|
|
196
196
|
}
|
|
197
197
|
/** Options for a flow step */
|
|
198
|
-
export interface CasedefaultstageblockedFlowBuilderStepOptions {
|
|
199
|
-
/** Associations to create with this step */
|
|
200
|
-
associations?: Array<{
|
|
201
|
-
recordId?: string;
|
|
202
|
-
entity?: string;
|
|
203
|
-
}>;
|
|
204
|
-
/** Groups for this step */
|
|
205
|
-
groups?: string[];
|
|
206
|
-
}
|
|
207
|
-
/**
|
|
208
|
-
* FlowBuilder for Casedefaultstageblocked multi-step action
|
|
209
|
-
*
|
|
210
|
-
* Use method chaining to add steps, then call execute() to run the flow.
|
|
211
|
-
* Transitions to stage: CaseDefaultStageBlocked
|
|
212
|
-
*/
|
|
213
|
-
export declare class CasedefaultstageblockedFlowBuilder {
|
|
214
|
-
private _record;
|
|
215
|
-
private _provider;
|
|
216
|
-
private _pendingLinks;
|
|
217
|
-
private _options?;
|
|
218
|
-
private _groups;
|
|
219
|
-
private _steps;
|
|
220
|
-
constructor(record: CaseRecord<any>, provider: IOdinProvider, pendingLinks: OdinRecordLinkDto[], options?: {
|
|
221
|
-
journeyId?: string;
|
|
222
|
-
});
|
|
223
|
-
/**
|
|
224
|
-
* Add a group to the main action
|
|
225
|
-
* @param group - Group name to add
|
|
226
|
-
* @returns this (for method chaining)
|
|
227
|
-
*/
|
|
228
|
-
addGroup(group: string): this;
|
|
229
|
-
/**
|
|
230
|
-
* Add MoveCaseToBlockedAction step to the flow
|
|
231
|
-
* @param id - ID of the record to update
|
|
232
|
-
* @param properties - Properties for this step
|
|
233
|
-
* @param options - Optional step settings
|
|
234
|
-
* @returns this (for method chaining)
|
|
235
|
-
*/
|
|
236
|
-
moveCaseToBlockedAction(id: string, properties: MoveCaseToBlockedActionProperties, options?: CasedefaultstageblockedFlowBuilderStepOptions): this;
|
|
237
|
-
/**
|
|
238
|
-
* Execute the flow
|
|
239
|
-
* @returns The result from the API
|
|
240
|
-
*/
|
|
241
|
-
execute(): Promise<IDbRecordCreateUpdateRes[]>;
|
|
242
|
-
/**
|
|
243
|
-
* Returns the request payload without executing (for debugging)
|
|
244
|
-
* @returns The request payload that would be sent to the API
|
|
245
|
-
*/
|
|
246
|
-
dryRun(): Record<string, any>;
|
|
247
|
-
/**
|
|
248
|
-
* Prevents accidental `await flowBuilder` without .execute()
|
|
249
|
-
* Forces developers to explicitly call .execute()
|
|
250
|
-
* @throws Error always - use .execute() or .dryRun() instead
|
|
251
|
-
*/
|
|
252
|
-
then(): never;
|
|
253
|
-
/**
|
|
254
|
-
* Build the request payload for the action
|
|
255
|
-
* @private
|
|
256
|
-
*/
|
|
257
|
-
private _buildRequestPayload;
|
|
258
|
-
}
|
|
259
|
-
/** Options for a flow step */
|
|
260
198
|
export interface CaseDefaultStageEscalatedFlowBuilderStepOptions {
|
|
261
199
|
/** Associations to create with this step */
|
|
262
200
|
associations?: Array<{
|
|
@@ -905,6 +843,68 @@ export declare class CaseTransitionSolvedToEscalatedFlowBuilder {
|
|
|
905
843
|
private _buildRequestPayload;
|
|
906
844
|
}
|
|
907
845
|
/** Options for a flow step */
|
|
846
|
+
export interface CasedefaultstageblockedFlowBuilderStepOptions {
|
|
847
|
+
/** Associations to create with this step */
|
|
848
|
+
associations?: Array<{
|
|
849
|
+
recordId?: string;
|
|
850
|
+
entity?: string;
|
|
851
|
+
}>;
|
|
852
|
+
/** Groups for this step */
|
|
853
|
+
groups?: string[];
|
|
854
|
+
}
|
|
855
|
+
/**
|
|
856
|
+
* FlowBuilder for Casedefaultstageblocked multi-step action
|
|
857
|
+
*
|
|
858
|
+
* Use method chaining to add steps, then call execute() to run the flow.
|
|
859
|
+
* Transitions to stage: CaseDefaultStageBlocked
|
|
860
|
+
*/
|
|
861
|
+
export declare class CasedefaultstageblockedFlowBuilder {
|
|
862
|
+
private _record;
|
|
863
|
+
private _provider;
|
|
864
|
+
private _pendingLinks;
|
|
865
|
+
private _options?;
|
|
866
|
+
private _groups;
|
|
867
|
+
private _steps;
|
|
868
|
+
constructor(record: CaseRecord<any>, provider: IOdinProvider, pendingLinks: OdinRecordLinkDto[], options?: {
|
|
869
|
+
journeyId?: string;
|
|
870
|
+
});
|
|
871
|
+
/**
|
|
872
|
+
* Add a group to the main action
|
|
873
|
+
* @param group - Group name to add
|
|
874
|
+
* @returns this (for method chaining)
|
|
875
|
+
*/
|
|
876
|
+
addGroup(group: string): this;
|
|
877
|
+
/**
|
|
878
|
+
* Add MoveCaseToBlockedAction step to the flow
|
|
879
|
+
* @param id - ID of the record to update
|
|
880
|
+
* @param properties - Properties for this step
|
|
881
|
+
* @param options - Optional step settings
|
|
882
|
+
* @returns this (for method chaining)
|
|
883
|
+
*/
|
|
884
|
+
moveCaseToBlockedAction(id: string, properties: MoveCaseToBlockedActionProperties, options?: CasedefaultstageblockedFlowBuilderStepOptions): this;
|
|
885
|
+
/**
|
|
886
|
+
* Execute the flow
|
|
887
|
+
* @returns The result from the API
|
|
888
|
+
*/
|
|
889
|
+
execute(): Promise<IDbRecordCreateUpdateRes[]>;
|
|
890
|
+
/**
|
|
891
|
+
* Returns the request payload without executing (for debugging)
|
|
892
|
+
* @returns The request payload that would be sent to the API
|
|
893
|
+
*/
|
|
894
|
+
dryRun(): Record<string, any>;
|
|
895
|
+
/**
|
|
896
|
+
* Prevents accidental `await flowBuilder` without .execute()
|
|
897
|
+
* Forces developers to explicitly call .execute()
|
|
898
|
+
* @throws Error always - use .execute() or .dryRun() instead
|
|
899
|
+
*/
|
|
900
|
+
then(): never;
|
|
901
|
+
/**
|
|
902
|
+
* Build the request payload for the action
|
|
903
|
+
* @private
|
|
904
|
+
*/
|
|
905
|
+
private _buildRequestPayload;
|
|
906
|
+
}
|
|
907
|
+
/** Options for a flow step */
|
|
908
908
|
export interface CasteTransitionOpenToEscalatedFlowBuilderStepOptions {
|
|
909
909
|
/** Associations to create with this step */
|
|
910
910
|
associations?: Array<{
|
|
@@ -1904,56 +1904,6 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
1904
1904
|
assignCaseWithNoteFlow(options?: {
|
|
1905
1905
|
journeyId?: string;
|
|
1906
1906
|
}): AssignCaseWithNoteFlowFlowBuilder;
|
|
1907
|
-
/**
|
|
1908
|
-
* MoveCaseToBlockedAction
|
|
1909
|
-
*
|
|
1910
|
-
* Updates this Case record with the specified properties.
|
|
1911
|
-
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
1912
|
-
*
|
|
1913
|
-
* @param properties - Required properties for this action
|
|
1914
|
-
* @param options - Optional settings
|
|
1915
|
-
* @param options.journeyId - Associate with a journey
|
|
1916
|
-
* @param options.stageKey - Transition to pipeline stage
|
|
1917
|
-
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
1918
|
-
* @throws Error if called on a new (unsaved) record
|
|
1919
|
-
*
|
|
1920
|
-
* @example
|
|
1921
|
-
* ```typescript
|
|
1922
|
-
* const record = await odinClient.cases.get(id);
|
|
1923
|
-
* await record.moveCaseToBlockedAction({ ... }).execute();
|
|
1924
|
-
*
|
|
1925
|
-
* // Dry run (for debugging)
|
|
1926
|
-
* const payload = record.moveCaseToBlockedAction({ ... }).dryRun();
|
|
1927
|
-
* ```
|
|
1928
|
-
*/
|
|
1929
|
-
moveCaseToBlockedAction(properties: MoveCaseToBlockedActionProperties, options?: {
|
|
1930
|
-
journeyId?: string;
|
|
1931
|
-
stageKey?: string;
|
|
1932
|
-
}): ActionBuilder;
|
|
1933
|
-
/**
|
|
1934
|
-
* Casedefaultstageblocked
|
|
1935
|
-
*
|
|
1936
|
-
* Starts a stage transition flow on this Case record.
|
|
1937
|
-
* Chain step methods and call .execute() to run the flow.
|
|
1938
|
-
*
|
|
1939
|
-
* @remarks Transitions to stage: CaseDefaultStageBlocked
|
|
1940
|
-
*
|
|
1941
|
-
* @param options - Optional settings
|
|
1942
|
-
* @param options.journeyId - Associate with a journey
|
|
1943
|
-
* @returns FlowBuilder for chaining step methods
|
|
1944
|
-
* @throws Error if called on a new (unsaved) record
|
|
1945
|
-
*
|
|
1946
|
-
* @example
|
|
1947
|
-
* ```typescript
|
|
1948
|
-
* const record = await odinClient.cases.get(id);
|
|
1949
|
-
* await record.casedefaultstageblocked()
|
|
1950
|
-
* .moveCaseToBlockedAction(recordId, { ... })
|
|
1951
|
-
* .execute();
|
|
1952
|
-
* ```
|
|
1953
|
-
*/
|
|
1954
|
-
casedefaultstageblocked(options?: {
|
|
1955
|
-
journeyId?: string;
|
|
1956
|
-
}): CasedefaultstageblockedFlowBuilder;
|
|
1957
1907
|
/**
|
|
1958
1908
|
* EscalateCaseAction
|
|
1959
1909
|
*
|
|
@@ -2054,6 +2004,32 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2054
2004
|
caseTransitionBlockedToEscalated(options?: {
|
|
2055
2005
|
journeyId?: string;
|
|
2056
2006
|
}): CaseTransitionBlockedToEscalatedFlowBuilder;
|
|
2007
|
+
/**
|
|
2008
|
+
* MoveCaseToBlockedAction
|
|
2009
|
+
*
|
|
2010
|
+
* Updates this Case record with the specified properties.
|
|
2011
|
+
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
2012
|
+
*
|
|
2013
|
+
* @param properties - Required properties for this action
|
|
2014
|
+
* @param options - Optional settings
|
|
2015
|
+
* @param options.journeyId - Associate with a journey
|
|
2016
|
+
* @param options.stageKey - Transition to pipeline stage
|
|
2017
|
+
* @returns ActionBuilder - call .execute() to update or .dryRun() for payload
|
|
2018
|
+
* @throws Error if called on a new (unsaved) record
|
|
2019
|
+
*
|
|
2020
|
+
* @example
|
|
2021
|
+
* ```typescript
|
|
2022
|
+
* const record = await odinClient.cases.get(id);
|
|
2023
|
+
* await record.moveCaseToBlockedAction({ ... }).execute();
|
|
2024
|
+
*
|
|
2025
|
+
* // Dry run (for debugging)
|
|
2026
|
+
* const payload = record.moveCaseToBlockedAction({ ... }).dryRun();
|
|
2027
|
+
* ```
|
|
2028
|
+
*/
|
|
2029
|
+
moveCaseToBlockedAction(properties: MoveCaseToBlockedActionProperties, options?: {
|
|
2030
|
+
journeyId?: string;
|
|
2031
|
+
stageKey?: string;
|
|
2032
|
+
}): ActionBuilder;
|
|
2057
2033
|
/**
|
|
2058
2034
|
* CaseTransitionEscalatedToBlocked
|
|
2059
2035
|
*
|
|
@@ -2249,6 +2225,30 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2249
2225
|
caseTransitionSolvedToEscalated(options?: {
|
|
2250
2226
|
journeyId?: string;
|
|
2251
2227
|
}): CaseTransitionSolvedToEscalatedFlowBuilder;
|
|
2228
|
+
/**
|
|
2229
|
+
* Casedefaultstageblocked
|
|
2230
|
+
*
|
|
2231
|
+
* Starts a stage transition flow on this Case record.
|
|
2232
|
+
* Chain step methods and call .execute() to run the flow.
|
|
2233
|
+
*
|
|
2234
|
+
* @remarks Transitions to stage: CaseDefaultStageBlocked
|
|
2235
|
+
*
|
|
2236
|
+
* @param options - Optional settings
|
|
2237
|
+
* @param options.journeyId - Associate with a journey
|
|
2238
|
+
* @returns FlowBuilder for chaining step methods
|
|
2239
|
+
* @throws Error if called on a new (unsaved) record
|
|
2240
|
+
*
|
|
2241
|
+
* @example
|
|
2242
|
+
* ```typescript
|
|
2243
|
+
* const record = await odinClient.cases.get(id);
|
|
2244
|
+
* await record.casedefaultstageblocked()
|
|
2245
|
+
* .moveCaseToBlockedAction(recordId, { ... })
|
|
2246
|
+
* .execute();
|
|
2247
|
+
* ```
|
|
2248
|
+
*/
|
|
2249
|
+
casedefaultstageblocked(options?: {
|
|
2250
|
+
journeyId?: string;
|
|
2251
|
+
}): CasedefaultstageblockedFlowBuilder;
|
|
2252
2252
|
/**
|
|
2253
2253
|
* CasteTransitionOpenToEscalated
|
|
2254
2254
|
*
|
|
@@ -2355,7 +2355,7 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2355
2355
|
stageKey?: string;
|
|
2356
2356
|
}): ActionBuilder;
|
|
2357
2357
|
/**
|
|
2358
|
-
*
|
|
2358
|
+
* EscalateCaseActionYF
|
|
2359
2359
|
*
|
|
2360
2360
|
* Updates this Case record.
|
|
2361
2361
|
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
@@ -2368,13 +2368,13 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2368
2368
|
* @example
|
|
2369
2369
|
* ```typescript
|
|
2370
2370
|
* const record = await odinClient.cases.get(id);
|
|
2371
|
-
* await record.
|
|
2371
|
+
* await record.escalateCaseActionYf({ ... }).execute();
|
|
2372
2372
|
*
|
|
2373
2373
|
* // Dry run (for debugging)
|
|
2374
|
-
* const payload = record.
|
|
2374
|
+
* const payload = record.escalateCaseActionYf({ ... }).dryRun();
|
|
2375
2375
|
* ```
|
|
2376
2376
|
*/
|
|
2377
|
-
|
|
2377
|
+
escalateCaseActionYf(propertiesOrOptions?: EscalateCaseActionYfProperties | {
|
|
2378
2378
|
journeyId?: string;
|
|
2379
2379
|
stageKey?: string;
|
|
2380
2380
|
}, options?: {
|
|
@@ -2382,7 +2382,7 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2382
2382
|
stageKey?: string;
|
|
2383
2383
|
}): ActionBuilder;
|
|
2384
2384
|
/**
|
|
2385
|
-
*
|
|
2385
|
+
* EscalateCaseActionYFCS
|
|
2386
2386
|
*
|
|
2387
2387
|
* Updates this Case record.
|
|
2388
2388
|
* Returns an ActionBuilder - call .execute() to update or .dryRun() for debugging.
|
|
@@ -2395,13 +2395,13 @@ export declare class CaseRecord<TProps = CaseProperties> {
|
|
|
2395
2395
|
* @example
|
|
2396
2396
|
* ```typescript
|
|
2397
2397
|
* const record = await odinClient.cases.get(id);
|
|
2398
|
-
* await record.
|
|
2398
|
+
* await record.escalateCaseActionYfcs({ ... }).execute();
|
|
2399
2399
|
*
|
|
2400
2400
|
* // Dry run (for debugging)
|
|
2401
|
-
* const payload = record.
|
|
2401
|
+
* const payload = record.escalateCaseActionYfcs({ ... }).dryRun();
|
|
2402
2402
|
* ```
|
|
2403
2403
|
*/
|
|
2404
|
-
|
|
2404
|
+
escalateCaseActionYfcs(propertiesOrOptions?: EscalateCaseActionYfcsProperties | {
|
|
2405
2405
|
journeyId?: string;
|
|
2406
2406
|
stageKey?: string;
|
|
2407
2407
|
}, options?: {
|