ChatTraversalsService

A class for the Traversal Engine ChatTraversal Controller.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#tag/ChatTraversals

Hierarchy

TraversalsBaseService
- ChatTraversalsService

Index

Constructors

constructor

Properties

axios

Methods

Constructors

constructor

new ChatTraversalsService(baseURL: string, tokenFactory?: undefined | (() => Promise<string | null>)): ChatTraversalsService

Overrides BaseService.constructor
- Defined in packages/traversal-core/src/Services/ChatTraversals/index.ts:14
Sets the [[controllerName]] to 'ChatTraversals'.

Parameters
- baseURL: string
  
  The service's [[baseURL]]
- Optional tokenFactory: undefined | (() => Promise<string | null>)
  
  Optional factory to set axios instance's token before http calls.
Returns ChatTraversalsService

Properties

Protected axios

axios: AxiosInstance

The axios instance used by this service.

Methods

create

create(body: ChatTraversalsCreate): Promise<AxiosResponse<ChatTraversalsResponse>>

- Defined in packages/traversal-core/src/Services/ChatTraversals/index.ts:29
Create a Traversal.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_CreateAsync

Parameters
- body: ChatTraversalsCreate
  
  The post body.
Returns Promise<AxiosResponse<ChatTraversalsResponse>>

get

get(traversalId: string): Promise<AxiosResponse<ChatTraversalsResponse>>

- Defined in packages/traversal-core/src/Services/ChatTraversals/index.ts:69
Get a Traversal.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_GetAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<ChatTraversalsResponse>>

getConclusionReport

getConclusionReport(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getConclusionReport
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:28
Get a Traversal's conclusion report.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_ConclusionReportAsync

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_ConclusionReportAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

getConclusions

getConclusions(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getConclusions
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:41
Get a Traversal's conclusions.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_ConclusionsAsync

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_ConclusionsAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

getHistoryLines

getHistoryLines(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getHistoryLines
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:63
Get a Traversal's history lines.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_GetHistoryAsync

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_GetHistoryAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

getQuestions

getQuestions(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getQuestions
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:17
Get a Traversal's presented questions.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_QuestionsAsync

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_QuestionsAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

getSummary

getSummary(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getSummary
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:74
Get a Traversal's summary.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_GetFullSummaryAsync

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_GetFullSummaryAsync

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

getTrackfile

getTrackfile(traversalId: string): Promise<AxiosResponse<any>>

Inherited from TraversalsBaseService.getTrackfile
- Defined in packages/traversal-core/src/Services/TraversalsBaseService.ts:52
Get a Traversal's track file.

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_GetTrackFile

https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_GetTrackFile

Parameters
- traversalId: string
  
  The traversal Id.
Returns Promise<AxiosResponse<any>>

respond

respond(traversalId: string, body: ChatTraversalsRespond[]): Promise<AxiosResponse<ChatTraversalsResponse>>

- Defined in packages/traversal-core/src/Services/ChatTraversals/index.ts:40
Respond to a Traversal.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_RespondAsync

Parameters
- traversalId: string
  
  The traversal Id.
- body: ChatTraversalsRespond[]
  
  The post body.
Returns Promise<AxiosResponse<ChatTraversalsResponse>>

revisit

revisit(traversalId: string, body: ChatTraversalsRevisit): Promise<AxiosResponse<ChatTraversalsResponse>>

- Defined in packages/traversal-core/src/Services/ChatTraversals/index.ts:55
Revisit a point in a Traversal.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/ChatTraversals_RevisitAsync

Parameters
- traversalId: string
  
  The traversal Id.
- body: ChatTraversalsRevisit
  
  The post body.
Returns Promise<AxiosResponse<ChatTraversalsResponse>>

setBaseUrl

setBaseUrl(baseURL: string): void

Inherited from BaseService.setBaseUrl
- Defined in packages/traversal-core/src/Services/BaseService.ts:49
Set the service's [[baseURL]] e.g. /engine/ or https://prod-platform-traversal-engine.doctorlink.engineering/api/v2/tenantId/

Parameters
- baseURL: string
  
  e.g. /engine/
Returns void

setToken

setToken(token: string | null): void

Inherited from BaseService.setToken
- Defined in packages/traversal-core/src/Services/BaseService.ts:57
Set the token to use in the service's axios instance

Parameters
- token: string | null
  
  Bearer token or null.
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

baseURL: string

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

Returns ChatTraversalsService

Properties

Protected axios

Methods

create

Parameters

body: ChatTraversalsCreate

Returns Promise<AxiosResponse<ChatTraversalsResponse>>

get

Parameters

traversalId: string

Returns Promise<AxiosResponse<ChatTraversalsResponse>>

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

respond

Parameters

traversalId: string

body: ChatTraversalsRespond[]

Returns Promise<AxiosResponse<ChatTraversalsResponse>>

revisit

Parameters

traversalId: string

body: ChatTraversalsRevisit

Returns Promise<AxiosResponse<ChatTraversalsResponse>>

setBaseUrl

Parameters

baseURL: string

Returns void

setToken

Parameters

token: string | null

Returns void