Class TraversalsService

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

Hierarchy

TraversalsBaseService
- TraversalsService

Index

Constructors

constructor

Properties

axios create get getConclusionReport getConclusions getHistoryLines getQuestions getSummary getTrackfile previous respond revisit setBaseUrl setToken

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/lib/Services/Traversals/index.d.ts:14

Properties

`Protected` axios

axios: AxiosInstance

The axios instance used by this service.

create

create: ((body: TraversalsBaseCreate) => Promise<AxiosResponse<TraversalsResponse>>)

Type declaration

- (body: TraversalsBaseCreate): Promise<AxiosResponse<TraversalsResponse>>
- Create a Traversal.
  https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_CreateAsync
  Parameters
  - body: TraversalsBaseCreate
    
    The post body.
  Returns Promise<AxiosResponse<TraversalsResponse>>

get

get: ((traversalId: string) => Promise<AxiosResponse<TraversalsResponse>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<TraversalsResponse>>
- Get a Traversal.
  https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_GetAsync
  Parameters
  - traversalId: string
    
    The traversal Id.
  Returns Promise<AxiosResponse<TraversalsResponse>>

getConclusionReport

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

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<any>>
- 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>>

previous: ((traversalId: string) => Promise<AxiosResponse<TraversalsResponse>>)

Type declaration

- (traversalId: string): Promise<AxiosResponse<TraversalsResponse>>
- Revisit the previous node in a Traversal.
  https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_PreviousAsync
  Parameters
  - traversalId: string
    
    The traversal Id.
  Returns Promise<AxiosResponse<TraversalsResponse>>

respond

respond: ((traversalId: string, body: TraversalsBaseRespond[]) => Promise<AxiosResponse<TraversalsResponse>>)

Type declaration

- (traversalId: string, body: TraversalsBaseRespond[]): Promise<AxiosResponse<TraversalsResponse>>
- Respond to a Traversal.
  https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_RespondAsync
  Parameters
  - traversalId: string
    
    The traversal Id.
  - body: TraversalsBaseRespond[]
    
    The post body.
  Returns Promise<AxiosResponse<TraversalsResponse>>

revisit

revisit: ((traversalId: string, body: undefined | TraversalsBaseRevisit) => Promise<AxiosResponse<TraversalsResponse>>)

Type declaration

- (traversalId: string, body: undefined | TraversalsBaseRevisit): Promise<AxiosResponse<TraversalsResponse>>
- Revisit a point in a Traversal.
  https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Traversals_RevisitAsync
  Parameters
  - traversalId: string
    
    The traversal Id.
  - body: undefined | TraversalsBaseRevisit
    
    The post body.
  Returns Promise<AxiosResponse<TraversalsResponse>>

setBaseUrl

setBaseUrl: ((baseURL: string) => void)

Type declaration

- (baseURL: string): void
- Set the service's base URL 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: null | string) => void)

Type declaration

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

Class TraversalsService

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Parameters

baseURL: string

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

Returns Promise<null | string>

Returns TraversalsService

Properties

Protected axios

create

Type declaration

Parameters

body: TraversalsBaseCreate

Returns Promise<AxiosResponse<TraversalsResponse>>

get

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<TraversalsResponse>>

getConclusionReport

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getConclusions

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getHistoryLines

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getQuestions

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getSummary

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

getTrackfile

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<any>>

previous

Type declaration

Parameters

traversalId: string

Returns Promise<AxiosResponse<TraversalsResponse>>

respond

Type declaration

Parameters

traversalId: string

body: TraversalsBaseRespond[]

Returns Promise<AxiosResponse<TraversalsResponse>>

revisit

Type declaration

Parameters

traversalId: string

body: undefined | TraversalsBaseRevisit

Returns Promise<AxiosResponse<TraversalsResponse>>

setBaseUrl

Type declaration

Parameters

baseURL: string

Returns void

setToken

Type declaration

Parameters

token: null | string

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

`Protected` axios