Class: OrgSettingsEndpoint

Defined in: api/endpoints/orgSettings/OrgSettingsEndpoint.ts:13

Endpoints for interacting with the public org settings.

Extends

• ApiEndpoint

Constructors

Constructor

new OrgSettingsEndpoint(config, tokenManager, log?, headerProvider?): OrgSettingsEndpoint

Defined in: api/endpoints/orgSettings/OrgSettingsEndpoint.ts:14

Parameters

config

DefaultApiConfig

tokenManager

TokenManager

log?

Logger

headerProvider?

HeaderProvider

Returns

OrgSettingsEndpoint

Overrides

ApiEndpoint.constructor

Properties

config

readonly config: DefaultApiConfig

Defined in: api/endpoints/ApiEndpoint.ts:10

Inherited from

ApiEndpoint.config

---

log?

protected readonly optional log: Logger

Defined in: api/endpoints/ApiEndpoint.ts:15

Inherited from

ApiEndpoint.log

---

tokenManager

readonly tokenManager: TokenManager

Defined in: api/endpoints/ApiEndpoint.ts:14

Inherited from

ApiEndpoint.tokenManager

Methods

deleteRequest()

protected deleteRequest(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<unknown>>

Defined in: api/endpoints/ApiEndpoint.ts:85

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<unknown>>

Inherited from

ApiEndpoint.deleteRequest

---

endpoint()

protected endpoint(): string

Defined in: api/endpoints/orgSettings/OrgSettingsEndpoint.ts:18

Returns

string

Overrides

ApiEndpoint.endpoint

---

endpointUrl()

protected endpointUrl(): string

Defined in: api/endpoints/ApiEndpoint.ts:23

Returns

string

Inherited from

ApiEndpoint.endpointUrl

---

getPublicSettings()

getPublicSettings(): Promise<ApiResponse<PublicOrgSettings>>

Defined in: api/endpoints/orgSettings/OrgSettingsEndpoint.ts:26

Get the public org settings.

Returns

Promise<ApiResponse<PublicOrgSettings>>

---

getRequest()

protected getRequest<T>(endpoint, queryParams?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:53

Type Parameters

T

T = unknown

Parameters

endpoint

string

queryParams?

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.getRequest

---

patchRequest()

protected patchRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:77

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.patchRequest

---

postRequest()

protected postRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:61

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.postRequest

---

putRequest()

protected putRequest<T>(endpoint, data?, noAuthentication?): Promise<ApiResponse<T>>

Defined in: api/endpoints/ApiEndpoint.ts:69

Type Parameters

T

T = unknown

Parameters

endpoint

string

data?

unknown

noAuthentication?

boolean

Returns

Promise<ApiResponse<T>>

Inherited from

ApiEndpoint.putRequest