Birb / ModifyGuildRequest
Class: ModifyGuildRequest
Hierarchy
-
AuthenticatedAPIEndpoint<ModifyGuildParams,APIGuild,ModifyGuildRequestBody>↳
ModifyGuildRequest
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new ModifyGuildRequest(client)
Parameters
| Name | Type |
|---|---|
client | Birb |
Overrides
AuthenticatedAPIEndpoint.constructor
Defined in
src/classes/api/endpoints/ModifyGuildRequest.ts:38
Properties
body
• body: undefined | ModifyGuildRequestBody
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 | ModifyGuildParams
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 | ModifyGuildParams |
Returns
string
Overrides
AuthenticatedAPIEndpoint.buildURL
Defined in
src/classes/api/endpoints/ModifyGuildRequest.ts:42
execute
▸ execute(): Promise<APIResponse<APIGuild>>
Returns
Promise<APIResponse<APIGuild>>
Inherited from
AuthenticatedAPIEndpoint.execute
Defined in
src/classes/api/APIEndpoint.ts:51
furnishRequest
▸ Protected furnishRequest(): ModifyGuildRequest
Returns
Inherited from
AuthenticatedAPIEndpoint.furnishRequest
Defined in
src/classes/api/AuthenticatedAPIEndpoint.ts:9
setAuditLogReason
▸ setAuditLogReason(reason?): ModifyGuildRequest
Parameters
| Name | Type |
|---|---|
reason? | string |
Returns
Inherited from
AuthenticatedAPIEndpoint.setAuditLogReason
Defined in
src/classes/api/AuthenticatedAPIEndpoint.ts:20
setBody
▸ setBody(body): ModifyGuildRequest
Parameters
| Name | Type |
|---|---|
body | undefined | ModifyGuildRequestBody |
Returns
Inherited from
AuthenticatedAPIEndpoint.setBody
Defined in
src/classes/api/APIEndpoint.ts:46
setHeaders
▸ setHeaders(headers): ModifyGuildRequest
Parameters
| Name | Type |
|---|---|
headers | Object |
Returns
Inherited from
AuthenticatedAPIEndpoint.setHeaders
Defined in
src/classes/api/APIEndpoint.ts:36
setParams
▸ setParams(params): ModifyGuildRequest
Parameters
| Name | Type |
|---|---|
params | ModifyGuildParams |
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