Correspondences | @tillhub/javascript-sdk

Hierarchy

ThBaseHandler
- Correspondences

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Correspondences(options: CorrespondencesOptions, http: Client): Correspondences

Overrides ThBaseHandler.constructor
- Defined in src/v0/correspondences.ts:57
Parameters
- options: CorrespondencesOptions
- http: Client
Returns Correspondences

Properties

endpoint

endpoint: string

http

http: Client

options

options: CorrespondencesOptions

uriHelper

uriHelper: UriHelper

Static baseEndpoint

baseEndpoint: string = '/api/v0/correspondences'

Methods

create

create(correspondence: Correspondence): Promise<CorrespondenceResponse>

- Defined in src/v0/correspondences.ts:131
Parameters
- correspondence: Correspondence
Returns Promise<CorrespondenceResponse>

get

get(correspondenceId: string): Promise<CorrespondenceResponse>

- Defined in src/v0/correspondences.ts:99
Parameters
- correspondenceId: string
Returns Promise<CorrespondenceResponse>

getAll

getAll(query?: CorrespondencesQuery): Promise<CorrespondencesResponse>

- Defined in src/v0/correspondences.ts:72
Parameters
- Optional query: CorrespondencesQuery
Returns Promise<CorrespondencesResponse>

put

put(correspondenceId: string, correspondence: Correspondence): Promise<CorrespondenceResponse>

- Defined in src/v0/correspondences.ts:117
Parameters
- correspondenceId: string
- correspondence: Correspondence
Returns Promise<CorrespondenceResponse>

Generated using TypeDoc