Class DiscordApi

DiscordApi - object-oriented interface

Export

DiscordApi

Hierarchy

BaseAPI
- DiscordApi

Index

Constructors

Properties

axios basePath configuration

Methods

discordControllerGetInvite discordControllerSearch discordControllerSendMessage discordControllerUpdateGuild

Constructors

constructor

new DiscordApi(configuration?, basePath?, axios?): DiscordApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DiscordApi
Inherited from BaseAPI.constructor
- Defined in packages/lib-apiclient/src/generated/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

discordControllerGetInvite

discordControllerGetInvite(options?): Promise<AxiosResponse<DiscordInviteOutputDTO, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DiscordInviteOutputDTO, any>>
Summary
Get invite

Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12178

discordControllerSearch

discordControllerSearch(guildSearchInputDTO?, options?): Promise<AxiosResponse<GuildOutputArrayDTOAPI, any>>
Parameters
- OptionalguildSearchInputDTO: GuildSearchInputDTO
  GuildSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuildOutputArrayDTOAPI, any>>
Summary
Search

Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12192

discordControllerSendMessage

discordControllerSendMessage(id, sendMessageInputDTO?, options?): Promise<AxiosResponse<APIOutput, any>>
Parameters
- id: string
- OptionalsendMessageInputDTO: SendMessageInputDTO
  SendMessageInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput, any>>
Summary
Send message

Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12207

discordControllerUpdateGuild

discordControllerUpdateGuild(id, guildApiUpdateDTO?, options?): Promise<AxiosResponse<GuildOutputDTOAPI, any>>
Parameters
- id: string
- OptionalguildApiUpdateDTO: GuildApiUpdateDTO
  GuildApiUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuildOutputDTOAPI, any>>
Summary
Update guild

Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12226