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?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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?: RawAxiosRequestConfig,
): Promise<AxiosResponse<DiscordInviteOutputDTO>>
OperationId: DiscordControllerGetInvite
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<DiscordInviteOutputDTO>>
Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12330

discordControllerSearch

discordControllerSearch(
guildSearchInputDTO?: GuildSearchInputDTO,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GuildOutputArrayDTOAPI>>
OperationId: DiscordControllerSearch
Parameters
- OptionalguildSearchInputDTO: GuildSearchInputDTO
  GuildSearchInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuildOutputArrayDTOAPI>>
Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12344

discordControllerSendMessage

discordControllerSendMessage(
    id: string,
    sendMessageInputDTO?: SendMessageInputDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<APIOutput>>
OperationId: DiscordControllerSendMessage
Parameters
- id: string
- OptionalsendMessageInputDTO: SendMessageInputDTO
  SendMessageInputDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<APIOutput>>
Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12359

discordControllerUpdateGuild

discordControllerUpdateGuild(
    id: string,
    guildApiUpdateDTO?: GuildApiUpdateDTO,
    options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GuildOutputDTOAPI>>
OperationId: DiscordControllerUpdateGuild
Parameters
- id: string
- OptionalguildApiUpdateDTO: GuildApiUpdateDTO
  GuildApiUpdateDTO
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GuildOutputDTOAPI>>
Throws
Memberof
DiscordApi
- Defined in packages/lib-apiclient/src/generated/api.ts:12378