Class: LegalPageApiClient
services/legal_page.LegalPageApiClient
Contains all the endpoints needed to manage legal pages.
Constructors
constructor
• new LegalPageApiClient(): LegalPageApiClient
Returns
Methods
ackLegalPage
▸ ackLegalPage(id, accept?, config?): Promise<SCLegalPageAckType>
Parameters
| Name | 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>
Defined in
services/legal_page/index.ts:83
getAllLastRevisionsOfLegalPages
▸ getAllLastRevisionsOfLegalPages(config?): Promise<SCLegalPageType[]>
This endpoint retrieves all last revisions of legal pages.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCLegalPageType[]>
Defined in
services/legal_page/index.ts:54
getAllRevisionsOfLegalPage
▸ getAllRevisionsOfLegalPage(policy, config?): Promise<SCPaginatedResponse<SCLegalPageType>>
This endpoint retrieves all revisions of a legal page.
Parameters
| Name | Type |
|---|---|
policy | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCLegalPageType>>
Defined in
services/legal_page/index.ts:47
getLastRevisionOfLegalPage
▸ getLastRevisionOfLegalPage(policy, config?): Promise<SCLegalPageType>
This endpoint retrieves last revision of a legal page.
Parameters
| Name | Type |
|---|---|
policy | string |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCLegalPageType>
Defined in
services/legal_page/index.ts:63
getLegalPages
▸ getLegalPages(params?, config?): Promise<SCPaginatedResponse<SCLegalPageType>>
This endpoint retrieves all legal pages.
Parameters
| Name | Type |
|---|---|
params? | LegalPageFilterParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCLegalPageType>>
Defined in
services/legal_page/index.ts:28
getSpecificLegalPage
▸ getSpecificLegalPage(id, config?): Promise<SCLegalPageType>
This endpoint retrieves a specific legal page.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCLegalPageType>
Defined in
services/legal_page/index.ts:38
getSpecificUserAck
▸ getSpecificUserAck(id, config?): Promise<SCLegalPageAckType>
This endpoint retrieves a specific user ack.
Parameters
| Name | Type |
|---|---|
id | string | number |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCLegalPageAckType>
Defined in
services/legal_page/index.ts:92
searchLegalPages
▸ searchLegalPages(params?, config?): Promise<SCPaginatedResponse<SCLegalPageType>>
This endpoint performs search of a Legal Page.
Parameters
| Name | Type |
|---|---|
params? | LegalPageFilterParams |
config? | AxiosRequestConfig<any> |
Returns
Promise<SCPaginatedResponse<SCLegalPageType>>
Defined in
services/legal_page/index.ts:72
userAckList
▸ userAckList(config?): Promise<SCLegalPageAckType[]>
This endpoint retrieves all user acks.
Parameters
| Name | Type |
|---|---|
config? | AxiosRequestConfig<any> |
Returns
Promise<SCLegalPageAckType[]>