Class MembersService

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

Hierarchy

BaseService
- MembersService

Index

Constructors

Properties

Methods

create get getQuestions setBaseUrl setToken

Constructors

constructor

new MembersService(baseURL: string, tokenFactory?: (() => Promise<null | string>)): MembersService
Sets the controllerName to 'Members'.
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 MembersService
Overrides BaseService.constructor
- Defined in packages/traversal-core/src/Services/Members/index.ts:19

Properties

`Protected` axios

axios: AxiosInstance

The axios instance used by this service.

Methods

create

create(body: MembersCreate): Promise<AxiosResponse<MembersResponse>>
Create a Member.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Members_CreateAsync
Parameters
- body: MembersCreate
  
  The post body.
Returns Promise<AxiosResponse<MembersResponse>>
- Defined in packages/traversal-core/src/Services/Members/index.ts:28

get

get(memberReference: string): Promise<AxiosResponse<MembersResponse>>
Get a Member.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Members_GetAsync
Parameters
- memberReference: string
  
  External Id of the member.
Returns Promise<AxiosResponse<MembersResponse>>
- Defined in packages/traversal-core/src/Services/Members/index.ts:38

getQuestions

getQuestions(memberReference: string): Promise<AxiosResponse<MembersPermanentHistoryResponse[]>>
Get a Member's permanent history.
https://api-integration.healthherotechnologies.co.uk/traversalcompositor/traversal-engine/api-docs/v2/index.html#operation/Members_GetPermanentHistoryAsync
Parameters
- memberReference: string
  
  External Id of the member.
Returns Promise<AxiosResponse<MembersPermanentHistoryResponse[]>>
- Defined in packages/traversal-core/src/Services/Members/index.ts:48

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