Client | Cosential compass.js

The Client service for Cosential Compass API calls.

Hierarchy

Client

Index

Methods

Constructors

constructor

new Client(config: ClientConfig): Client

- Defined in src/services/client.ts:20
Parameters
- config: ClientConfig
Returns Client

Properties

Private _config

_config: ClientConfig

Accessors

config

get config(): ClientConfig
set config(value: ClientConfig): void

- Defined in src/services/client.ts:14
Returns ClientConfig
- Defined in src/services/client.ts:18
Parameters
- value: ClientConfig
Returns void

Methods

delete

delete<T>(url: string, opts?: RequestOptions): Promise<ResponseData<T>>

- Defined in src/services/client.ts:147
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint with a valid Id
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

get

get<T>(url: string, opts?: RequestOptions, from?: number, size?: number, includeDeleted?: boolean): Promise<ResponseData<T>>

- Defined in src/services/client.ts:35
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
- Default value from: number = 0
  
  Number of elements you would like to skip
- Default value size: number = 500
  
  Number of elements you would like to receive (max is 500)
- Default value includeDeleted: boolean = false
  
  Include deleted records in GET
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

getSearch

getSearch<T>(url: string, queryString: string, opts?: RequestOptions): Promise<ResponseData<T>>

- Defined in src/services/client.ts:220
Note: This function should only be used to search endpoints which do not have search via POST implemented, e.g. /emails. All other searches should be performed via the above search function.

Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint
- queryString: string
  
  Complete search query
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

Private handleResponse

handleResponse<T>(responseType: string, response: Response): Promise<ResponseData<T>>

- Defined in src/services/client.ts:292
Type parameters
- T
Parameters
- responseType: string
  
  An HTTP verb
- response: Response
  
  The response object
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

post

post<T>(url: string, payload: T, opts?: RequestOptions): Promise<ResponseData<T>>

- Defined in src/services/client.ts:78
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint
- payload: T
  
  Array of elements
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

put

put<T>(url: string, payload: T, opts?: RequestOptions): Promise<ResponseData<T>>

- Defined in src/services/client.ts:113
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint with a valid Id
- payload: T
  
  Updated element including new and existing values
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

search

search<T>(url: string, queryString: string, fields?: string, from?: number, size?: number, includeDeleted?: boolean, opts?: RequestOptions): Promise<ResponseData<T>>

- Defined in src/services/client.ts:181
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint
- queryString: string
  
  Complete search query
- Default value fields: string = null
- Default value from: number = 0
  
  Number of elements you would like to skip
- Default value size: number = 500
  
  Number of elements you would like to receive (max is 500)
- Default value includeDeleted: boolean = false
  
  Include deleted records in search
- Default value opts: RequestOptions = { showErrors: true }
  
  Optional request headers
Returns Promise<ResponseData<T>>
- A detailed response object as a Promise

searchForAll

searchForAll<T>(url: string, queryString: string, fields?: string, includeDeleted?: boolean, opts?: RequestOptions): Promise<ResponseData<T[]>>

- Defined in src/services/client.ts:244
Type parameters
- T
Parameters
- url: string
  
  Compass API endpoint
- queryString: string
  
  Complete search query
- Default value fields: string = null
  
  Comma-separated fields to return
- Default value includeDeleted: boolean = false
  
  Include deleted records in search
- Default value opts: RequestOptions = {showErrors: true}
  
  Optional request headers
Returns Promise<ResponseData<T[]>>
- A detailed response object as a Promise

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: ClientConfig

Returns Client

Properties

Private _config

Accessors

config

Returns ClientConfig

Parameters

value: ClientConfig

Returns void

Methods

delete

Type parameters

T

Parameters

url: string

Default value opts: RequestOptions = { showErrors: true }

Returns Promise<ResponseData<T>>

get

Type parameters

T

Parameters

url: string

Default value opts: RequestOptions = { showErrors: true }

Default value from: number = 0

Default value size: number = 500

Default value includeDeleted: boolean = false

Returns Promise<ResponseData<T>>

getSearch

Type parameters

T

Parameters

url: string

queryString: string

Default value opts: RequestOptions = { showErrors: true }

Returns Promise<ResponseData<T>>

Private handleResponse

Type parameters

T

Parameters

responseType: string

response: Response

Returns Promise<ResponseData<T>>

post

Type parameters

T

Parameters

url: string

payload: T

Default value opts: RequestOptions = { showErrors: true }

Returns Promise<ResponseData<T>>

put

Type parameters

T

Parameters

url: string

payload: T

Default value opts: RequestOptions = { showErrors: true }

Returns Promise<ResponseData<T>>

search

Type parameters

T

Parameters

url: string

queryString: string

Default value fields: string = null

Default value from: number = 0

Default value size: number = 500

Default value includeDeleted: boolean = false

Default value opts: RequestOptions = { showErrors: true }

Returns Promise<ResponseData<T>>