Class MembersService

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

Hierarchy

BaseService
- MembersService

Index

Constructors

constructor

Properties

axios

Methods

Constructors

constructor

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

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

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 MembersService

Properties

Protected axios

axios: AxiosInstance

The axios instance used by this service.

Methods

create

create(body: MembersCreate): Promise<AxiosResponse<MembersResponse>>

- Defined in packages/traversal-core/src/Services/Members/index.ts:28
Create a Member.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Members_CreateAsync

Parameters
- body: MembersCreate
  
  The post body.
Returns Promise<AxiosResponse<MembersResponse>>

get

get(memberReference: string): Promise<AxiosResponse<MembersResponse>>

- Defined in packages/traversal-core/src/Services/Members/index.ts:38
Get a Member.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Members_GetAsync

Parameters
- memberReference: string
  
  External Id of the member.
Returns Promise<AxiosResponse<MembersResponse>>

getQuestions

getQuestions(memberReference: string): Promise<AxiosResponse<MembersPermanentHistoryResponse[]>>

- Defined in packages/traversal-core/src/Services/Members/index.ts:48
Get a Member's permanent history.
https://prod-platform-traversal-engine.doctorlink.engineering/api-docs/v2/index.html#operation/Members_GetPermanentHistoryAsync

Parameters
- memberReference: string
  
  External Id of the member.
Returns Promise<AxiosResponse<MembersPermanentHistoryResponse[]>>

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