Class TraversalsBaseService

A base class for the Traversals and ChatTraversals controllers. These Services have common endpoints.

Hierarchy

BaseService
- TraversalsBaseService
  - TraversalsService
  - ChatTraversalsService

Index

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance

The axios instance used by this service.

Methods

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>>
- 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>>
- 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>>
- 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>>
- 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>>
- 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>>
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:52

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 BaseService.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 BaseService.setToken
- Defined in packages/traversal-core/src/Services/BaseService.ts:57

Class TraversalsBaseService

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseURL: string

controllerName: string

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

Returns Promise<null | string>

Returns TraversalsBaseService

Properties

Protected axios

Methods

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>>

setBaseUrl

Parameters

baseURL: string

Returns void

setToken

Parameters

token: null | string

Returns void

Settings

Member Visibility

Theme

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

`Protected` axios