Birb / GetGuildRequest
Class: GetGuildRequest
Hierarchy
-
AuthenticatedAPIEndpoint<GetGuildParams,APIGuild>↳
GetGuildRequest
Table of contents
Constructors
Properties
Methods
- buildURL
- execute
- furnishRequest
- setAuditLogReason
- setBody
- setHeaders
- setParams
- throwJSONError
- validateResponse
Constructors
constructor
• new GetGuildRequest(client)
Parameters
| Name | Type |
|---|---|
client | Birb |
Overrides
AuthenticatedAPIEndpoint.constructor
Defined in
src/classes/api/endpoints/GetGuildRequest.ts:16
Properties
body
• body: any
The request body.
Inherited from
Defined in
src/classes/api/APIEndpoint.ts:29
client
• client: Birb
The Birb client.
Inherited from
AuthenticatedAPIEndpoint.client
Defined in
src/classes/api/APIEndpoint.ts:10
headers
• headers: Object
The parameters to use.
Index signature
▪ [key: string]: string
Inherited from
AuthenticatedAPIEndpoint.headers
Defined in
src/classes/api/APIEndpoint.ts:22
method
• Readonly method: string
The method for the endpoint.
Inherited from
AuthenticatedAPIEndpoint.method
Defined in
src/classes/api/APIEndpoint.ts:14
params
• params: undefined | GetGuildParams
The parameters to use.
Inherited from
AuthenticatedAPIEndpoint.params
Defined in
src/classes/api/APIEndpoint.ts:18
Methods
buildURL
▸ buildURL(params): string
Parameters
| Name | Type |
|---|---|
params | GetGuildParams |
Returns
string
Overrides
AuthenticatedAPIEndpoint.buildURL
Defined in
src/classes/api/endpoints/GetGuildRequest.ts:20
execute
▸ execute(): Promise<APIResponse<APIGuild>>
Returns
Promise<APIResponse<APIGuild>>
Inherited from
AuthenticatedAPIEndpoint.execute
Defined in
src/classes/api/APIEndpoint.ts:51
furnishRequest
▸ Protected furnishRequest(): GetGuildRequest
Returns
Inherited from
AuthenticatedAPIEndpoint.furnishRequest
Defined in
src/classes/api/AuthenticatedAPIEndpoint.ts:9
setAuditLogReason
▸ setAuditLogReason(reason?): GetGuildRequest
Parameters
| Name | Type |
|---|---|
reason? | string |
Returns
Inherited from
AuthenticatedAPIEndpoint.setAuditLogReason
Defined in
src/classes/api/AuthenticatedAPIEndpoint.ts:20
setBody
▸ setBody(body): GetGuildRequest
Parameters
| Name | Type |
|---|---|
body | any |
Returns
Inherited from
AuthenticatedAPIEndpoint.setBody
Defined in
src/classes/api/APIEndpoint.ts:46
setHeaders
▸ setHeaders(headers): GetGuildRequest
Parameters
| Name | Type |
|---|---|
headers | Object |
Returns
Inherited from
AuthenticatedAPIEndpoint.setHeaders
Defined in
src/classes/api/APIEndpoint.ts:36
setParams
▸ setParams(params): GetGuildRequest
Parameters
| Name | Type |
|---|---|
params | GetGuildParams |
Returns
Inherited from
AuthenticatedAPIEndpoint.setParams
Defined in
src/classes/api/APIEndpoint.ts:41
throwJSONError
▸ throwJSONError(response, json?): BirbAPIError
Parameters
| Name | Type |
|---|---|
response | Response |
json? | any |
Returns
Inherited from
AuthenticatedAPIEndpoint.throwJSONError
Defined in
src/classes/api/APIEndpoint.ts:124
validateResponse
▸ validateResponse(response, json): void
Parameters
| Name | Type |
|---|---|
response | Response |
json | any |
Returns
void
Defined in
src/classes/api/endpoints/GetGuildRequest.ts:30