LegalPageApiClient

Contains all the endpoints needed to manage legal pages.

Constructors

new LegalPageApiClient()

new LegalPageApiClient(): LegalPageApiClient

Returns

LegalPageApiClient

Methods

ackLegalPage()

static ackLegalPage(id, accept?, config?): Promise<SCLegalPageAckType>

Parameters

Parameter	Type	Description
id	string | number
accept?	string | number	Accept or not accept a legal page, valid values are: ('true', 'on', '1').
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageAckType>

Source

services/legal_page/index.ts:83

---

getAllLastRevisionsOfLegalPages()

static getAllLastRevisionsOfLegalPages(config?): Promise<SCLegalPageType[]>

This endpoint retrieves all last revisions of legal pages.

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageType[]>

Source

services/legal_page/index.ts:54

---

getAllRevisionsOfLegalPage()

static getAllRevisionsOfLegalPage(policy, config?): Promise <SCPaginatedResponse<SCLegalPageType>>

This endpoint retrieves all revisions of a legal page.

Parameters

Parameter	Type	Description
policy	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLegalPageType>>

Source

services/legal_page/index.ts:47

---

getLastRevisionOfLegalPage()

static getLastRevisionOfLegalPage(policy, config?): Promise<SCLegalPageType>

This endpoint retrieves last revision of a legal page.

Parameters

Parameter	Type	Description
policy	string
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageType>

Source

services/legal_page/index.ts:63

---

getLegalPages()

static getLegalPages(params?, config?): Promise <SCPaginatedResponse<SCLegalPageType>>

This endpoint retrieves all legal pages.

Parameters

Parameter	Type	Description
params?	LegalPageFilterParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLegalPageType>>

Source

services/legal_page/index.ts:28

---

getSpecificLegalPage()

static getSpecificLegalPage(id, config?): Promise<SCLegalPageType>

This endpoint retrieves a specific legal page.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageType>

Source

services/legal_page/index.ts:38

---

getSpecificUserAck()

static getSpecificUserAck(id, config?): Promise<SCLegalPageAckType>

This endpoint retrieves a specific user ack.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageAckType>

Source

services/legal_page/index.ts:92

---

searchLegalPages()

static searchLegalPages(params?, config?): Promise <SCPaginatedResponse<SCLegalPageType>>

This endpoint performs search of a Legal Page.

Parameters

Parameter	Type	Description
params?	LegalPageFilterParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCLegalPageType>>

Source

services/legal_page/index.ts:72

---

userAckList()

static userAckList(config?): Promise<SCLegalPageAckType[]>

This endpoint retrieves all user acks.

Parameters

Parameter	Type
config?	AxiosRequestConfig<any>

Returns

Promise<SCLegalPageAckType[]>

Source

services/legal_page/index.ts:99