Class TraversalsService

A class for the Traversal Engine ChatTraversal Controller.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#tag/Traversals

Hierarchy

TraversalsBaseService
- TraversalsService

Index

Constructors

constructor

new TraversalsService(baseURL: string, tokenFactory?: (() => Promise<null | string>)): TraversalsService
Sets the controllerName to 'Traversals'.
Parameters
- baseURL: string
  
  The service's base URL
- Optional tokenFactory: (() => Promise<null | string>)
  
  Optional factory to set axios instance's token before http calls.
  - - (): Promise<null | string>
    - Returns Promise<null | string>
Returns TraversalsService
Overrides TraversalsBaseService.constructor
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:22

Properties

`Protected` axios

axios: AxiosInstance

The axios instance used by this service.

Methods

create

create(body: TraversalsBaseCreate): Promise<AxiosResponse<TraversalsResponse>>
Create a Traversal.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_CreateAsync
Parameters
- body: TraversalsBaseCreate
  
  The post body.
Returns Promise<AxiosResponse<TraversalsResponse>>
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:31

get

get(traversalId: string): Promise<AxiosResponse<TraversalsResponse>>
Get a Traversal.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_GetAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<TraversalsResponse>>
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:75

getConclusionReport

getConclusionReport(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's conclusion report.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_ConclusionReportAsync

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_ConclusionReportAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getConclusionReport
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:28

getConclusions

getConclusions(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's conclusions.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_ConclusionsAsync

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_ConclusionsAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getConclusions
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:41

getHistoryLines

getHistoryLines(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's history lines.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_GetHistoryAsync

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_GetHistoryAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getHistoryLines
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:63

getQuestions

getQuestions(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's presented questions.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_QuestionsAsync

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_QuestionsAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getQuestions
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:17

getSummary

getSummary(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's summary.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_GetFullSummaryAsync

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_GetFullSummaryAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getSummary
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:74

getTrackfile

getTrackfile(traversalId: string): Promise<AxiosResponse<any>>
Get a Traversal's track file.

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_GetTrackFile

https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/ChatTraversals_GetTrackFile
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>
Inherited from TraversalsBaseService.getTrackfile
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:52

previous(traversalId: string): Promise<AxiosResponse<TraversalsResponse>>
Revisit the previous node in a Traversal.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_PreviousAsync
Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<TraversalsResponse>>
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:65

respond

respond(traversalId: string, body: TraversalsBaseRespond[]): Promise<AxiosResponse<TraversalsResponse>>
Respond to a Traversal.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_RespondAsync
Parameters
- traversalId: string
  
  The traversal Id.
- body: TraversalsBaseRespond[]
  
  The post body.
Returns Promise<AxiosResponse<TraversalsResponse>>
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:42

revisit

revisit(traversalId: string, body: undefined | TraversalsBaseRevisit): Promise<AxiosResponse<TraversalsResponse>>
Revisit a point in a Traversal.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Traversals_RevisitAsync
Parameters
- traversalId: string
  
  The traversal Id.
- body: undefined | TraversalsBaseRevisit
  
  The post body.
Returns Promise<AxiosResponse<TraversalsResponse>>
- Defined in packages/traversal-core/src/Services/Traversals/index.ts:54

setBaseUrl

setBaseUrl(baseURL: string): void
Set the service's base URL e.g. /engine/ or https://api-integration.healthherotechnologies.co.uk/traversalcompositor/tenantId/
Parameters
- baseURL: string
  
  e.g. /engine/
Returns void
Inherited from TraversalsBaseService.setBaseUrl
- Defined in packages/traversal-core/src/Services/BaseService.ts:49

setToken

setToken(token: null | string): void
Set the token to use in the service's axios instance
Parameters
- token: null | string
  
  Bearer token or null.
Returns void
Inherited from TraversalsBaseService.setToken
- Defined in packages/traversal-core/src/Services/BaseService.ts:57

Class TraversalsService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseURL: string

Optional tokenFactory: (() => Promise<null | string>)

Returns Promise<null | string>

Returns TraversalsService

Properties

Protected axios

Methods

create

Parameters

body: TraversalsBaseCreate

Returns Promise<AxiosResponse<TraversalsResponse>>

get

Parameters

traversalId: string

Returns Promise<AxiosResponse<TraversalsResponse>>

getConclusionReport

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getConclusions

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getHistoryLines

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getQuestions

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getSummary

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getTrackfile

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

previous

Parameters

traversalId: string

Returns Promise<AxiosResponse<TraversalsResponse>>

respond

Parameters

traversalId: string

body: TraversalsBaseRespond[]

Returns Promise<AxiosResponse<TraversalsResponse>>

revisit

Parameters

traversalId: string

body: undefined | TraversalsBaseRevisit

Returns Promise<AxiosResponse<TraversalsResponse>>

setBaseUrl

Parameters

baseURL: string

Returns void

setToken

Parameters

token: null | string

Returns void

Settings

Member Visibility

Theme

`Optional` tokenFactory: (() => Promise<null | string>)

`Protected` axios