tinyoverflow / discord-php
Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.
dev-main
2023-11-28 00:08 UTC
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.4.5
- guzzlehttp/psr7: ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- overtrue/phplint: ^9.0
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-05-28 01:13:31 UTC
README
Preview of the Discord v10 HTTP API specification. See https://discord.com/developers/docs for more details.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer, add the following to composer.json
:
{ "repositories": [ { "type": "vcs", "url": "https://github.com/tinyoverflow/discord-php.git" } ], "require": { "tinyoverflow/discord-php": "*@dev" } }
Then run composer install
Manual Installation
Download the files and include autoload.php
:
<?php require_once('/path/to/tinyoverflow/discord-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); // Configure API key authorization: BotToken $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed // $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer'); $apiInstance = new OpenAPI\Client\Api\DefaultAPI( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client(), $config ); $channel_id = 'channel_id_example'; // string $user_id = 'user_id_example'; // string $add_group_dm_user_request = new \OpenAPI\Client\Model\AddGroupDmUserRequest(); // \OpenAPI\Client\Model\AddGroupDmUserRequest try { $result = $apiInstance->addGroupDmUser($channel_id, $user_id, $add_group_dm_user_request); print_r($result); } catch (Exception $e) { echo 'Exception when calling DefaultAPI->addGroupDmUser: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://discord.com/api/v10
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultAPI | addGroupDmUser | PUT /channels/{channel_id}/recipients/{user_id} | |
DefaultAPI | addGuildMember | PUT /guilds/{guild_id}/members/{user_id} | |
DefaultAPI | addGuildMemberRole | PUT /guilds/{guild_id}/members/{user_id}/roles/{role_id} | |
DefaultAPI | addMyMessageReaction | PUT /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me | |
DefaultAPI | addThreadMember | PUT /channels/{channel_id}/thread-members/{user_id} | |
DefaultAPI | banUserFromGuild | PUT /guilds/{guild_id}/bans/{user_id} | |
DefaultAPI | bulkDeleteMessages | POST /channels/{channel_id}/messages/bulk-delete | |
DefaultAPI | bulkSetApplicationCommands | PUT /applications/{application_id}/commands | |
DefaultAPI | bulkSetGuildApplicationCommands | PUT /applications/{application_id}/guilds/{guild_id}/commands | |
DefaultAPI | bulkUpdateGuildChannels | PATCH /guilds/{guild_id}/channels | |
DefaultAPI | bulkUpdateGuildRoles | PATCH /guilds/{guild_id}/roles | |
DefaultAPI | createApplicationCommand | POST /applications/{application_id}/commands | |
DefaultAPI | createAutoModerationRule | POST /guilds/{guild_id}/auto-moderation/rules | |
DefaultAPI | createChannelInvite | POST /channels/{channel_id}/invites | |
DefaultAPI | createDm | POST /users/@me/channels | |
DefaultAPI | createGuild | POST /guilds | |
DefaultAPI | createGuildApplicationCommand | POST /applications/{application_id}/guilds/{guild_id}/commands | |
DefaultAPI | createGuildChannel | POST /guilds/{guild_id}/channels | |
DefaultAPI | createGuildEmoji | POST /guilds/{guild_id}/emojis | |
DefaultAPI | createGuildFromTemplate | POST /guilds/templates/{code} | |
DefaultAPI | createGuildRole | POST /guilds/{guild_id}/roles | |
DefaultAPI | createGuildScheduledEvent | POST /guilds/{guild_id}/scheduled-events | |
DefaultAPI | createGuildSticker | POST /guilds/{guild_id}/stickers | |
DefaultAPI | createGuildTemplate | POST /guilds/{guild_id}/templates | |
DefaultAPI | createInteractionResponse | POST /interactions/{interaction_id}/{interaction_token}/callback | |
DefaultAPI | createMessage | POST /channels/{channel_id}/messages | |
DefaultAPI | createStageInstance | POST /stage-instances | |
DefaultAPI | createThread | POST /channels/{channel_id}/threads | |
DefaultAPI | createThreadFromMessage | POST /channels/{channel_id}/messages/{message_id}/threads | |
DefaultAPI | createWebhook | POST /channels/{channel_id}/webhooks | |
DefaultAPI | crosspostMessage | POST /channels/{channel_id}/messages/{message_id}/crosspost | |
DefaultAPI | deleteAllMessageReactions | DELETE /channels/{channel_id}/messages/{message_id}/reactions | |
DefaultAPI | deleteAllMessageReactionsByEmoji | DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name} | |
DefaultAPI | deleteApplicationCommand | DELETE /applications/{application_id}/commands/{command_id} | |
DefaultAPI | deleteAutoModerationRule | DELETE /guilds/{guild_id}/auto-moderation/rules/{rule_id} | |
DefaultAPI | deleteChannel | DELETE /channels/{channel_id} | |
DefaultAPI | deleteChannelPermissionOverwrite | DELETE /channels/{channel_id}/permissions/{overwrite_id} | |
DefaultAPI | deleteGroupDmUser | DELETE /channels/{channel_id}/recipients/{user_id} | |
DefaultAPI | deleteGuild | DELETE /guilds/{guild_id} | |
DefaultAPI | deleteGuildApplicationCommand | DELETE /applications/{application_id}/guilds/{guild_id}/commands/{command_id} | |
DefaultAPI | deleteGuildEmoji | DELETE /guilds/{guild_id}/emojis/{emoji_id} | |
DefaultAPI | deleteGuildIntegration | DELETE /guilds/{guild_id}/integrations/{integration_id} | |
DefaultAPI | deleteGuildMember | DELETE /guilds/{guild_id}/members/{user_id} | |
DefaultAPI | deleteGuildMemberRole | DELETE /guilds/{guild_id}/members/{user_id}/roles/{role_id} | |
DefaultAPI | deleteGuildRole | DELETE /guilds/{guild_id}/roles/{role_id} | |
DefaultAPI | deleteGuildScheduledEvent | DELETE /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id} | |
DefaultAPI | deleteGuildSticker | DELETE /guilds/{guild_id}/stickers/{sticker_id} | |
DefaultAPI | deleteGuildTemplate | DELETE /guilds/{guild_id}/templates/{code} | |
DefaultAPI | deleteMessage | DELETE /channels/{channel_id}/messages/{message_id} | |
DefaultAPI | deleteMyMessageReaction | DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/@me | |
DefaultAPI | deleteOriginalWebhookMessage | DELETE /webhooks/{webhook_id}/{webhook_token}/messages/@original | |
DefaultAPI | deleteStageInstance | DELETE /stage-instances/{channel_id} | |
DefaultAPI | deleteThreadMember | DELETE /channels/{channel_id}/thread-members/{user_id} | |
DefaultAPI | deleteUserMessageReaction | DELETE /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name}/{user_id} | |
DefaultAPI | deleteWebhook | DELETE /webhooks/{webhook_id} | |
DefaultAPI | deleteWebhookByToken | DELETE /webhooks/{webhook_id}/{webhook_token} | |
DefaultAPI | deleteWebhookMessage | DELETE /webhooks/{webhook_id}/{webhook_token}/messages/{message_id} | |
DefaultAPI | executeGithubCompatibleWebhook | POST /webhooks/{webhook_id}/{webhook_token}/github | |
DefaultAPI | executeSlackCompatibleWebhook | POST /webhooks/{webhook_id}/{webhook_token}/slack | |
DefaultAPI | executeWebhook | POST /webhooks/{webhook_id}/{webhook_token} | |
DefaultAPI | followChannel | POST /channels/{channel_id}/followers | |
DefaultAPI | getActiveGuildThreads | GET /guilds/{guild_id}/threads/active | |
DefaultAPI | getApplication | GET /applications/{application_id} | |
DefaultAPI | getApplicationCommand | GET /applications/{application_id}/commands/{command_id} | |
DefaultAPI | getApplicationRoleConnectionsMetadata | GET /applications/{application_id}/role-connections/metadata | |
DefaultAPI | getApplicationUserRoleConnection | GET /users/@me/applications/{application_id}/role-connection | |
DefaultAPI | getAutoModerationRule | GET /guilds/{guild_id}/auto-moderation/rules/{rule_id} | |
DefaultAPI | getBotGateway | GET /gateway/bot | |
DefaultAPI | getChannel | GET /channels/{channel_id} | |
DefaultAPI | getGateway | GET /gateway | |
DefaultAPI | getGuild | GET /guilds/{guild_id} | |
DefaultAPI | getGuildApplicationCommand | GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id} | |
DefaultAPI | getGuildApplicationCommandPermissions | GET /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions | |
DefaultAPI | getGuildBan | GET /guilds/{guild_id}/bans/{user_id} | |
DefaultAPI | getGuildEmoji | GET /guilds/{guild_id}/emojis/{emoji_id} | |
DefaultAPI | getGuildMember | GET /guilds/{guild_id}/members/{user_id} | |
DefaultAPI | getGuildNewMemberWelcome | GET /guilds/{guild_id}/new-member-welcome | |
DefaultAPI | getGuildPreview | GET /guilds/{guild_id}/preview | |
DefaultAPI | getGuildScheduledEvent | GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id} | |
DefaultAPI | getGuildSticker | GET /guilds/{guild_id}/stickers/{sticker_id} | |
DefaultAPI | getGuildTemplate | GET /guilds/templates/{code} | |
DefaultAPI | getGuildVanityUrl | GET /guilds/{guild_id}/vanity-url | |
DefaultAPI | getGuildWebhooks | GET /guilds/{guild_id}/webhooks | |
DefaultAPI | getGuildWelcomeScreen | GET /guilds/{guild_id}/welcome-screen | |
DefaultAPI | getGuildWidget | GET /guilds/{guild_id}/widget.json | |
DefaultAPI | getGuildWidgetPng | GET /guilds/{guild_id}/widget.png | |
DefaultAPI | getGuildWidgetSettings | GET /guilds/{guild_id}/widget | |
DefaultAPI | getGuildsOnboarding | GET /guilds/{guild_id}/onboarding | |
DefaultAPI | getMessage | GET /channels/{channel_id}/messages/{message_id} | |
DefaultAPI | getMyApplication | GET /applications/@me | |
DefaultAPI | getMyGuildMember | GET /users/@me/guilds/{guild_id}/member | |
DefaultAPI | getMyOauth2Application | GET /oauth2/applications/@me | |
DefaultAPI | getMyOauth2Authorization | GET /oauth2/@me | |
DefaultAPI | getMyUser | GET /users/@me | |
DefaultAPI | getOriginalWebhookMessage | GET /webhooks/{webhook_id}/{webhook_token}/messages/@original | |
DefaultAPI | getStageInstance | GET /stage-instances/{channel_id} | |
DefaultAPI | getSticker | GET /stickers/{sticker_id} | |
DefaultAPI | getThreadMember | GET /channels/{channel_id}/thread-members/{user_id} | |
DefaultAPI | getUser | GET /users/{user_id} | |
DefaultAPI | getWebhook | GET /webhooks/{webhook_id} | |
DefaultAPI | getWebhookByToken | GET /webhooks/{webhook_id}/{webhook_token} | |
DefaultAPI | getWebhookMessage | GET /webhooks/{webhook_id}/{webhook_token}/messages/{message_id} | |
DefaultAPI | inviteResolve | GET /invites/{code} | |
DefaultAPI | inviteRevoke | DELETE /invites/{code} | |
DefaultAPI | joinThread | PUT /channels/{channel_id}/thread-members/@me | |
DefaultAPI | leaveGuild | DELETE /users/@me/guilds/{guild_id} | |
DefaultAPI | leaveThread | DELETE /channels/{channel_id}/thread-members/@me | |
DefaultAPI | listApplicationCommands | GET /applications/{application_id}/commands | |
DefaultAPI | listAutoModerationRules | GET /guilds/{guild_id}/auto-moderation/rules | |
DefaultAPI | listChannelInvites | GET /channels/{channel_id}/invites | |
DefaultAPI | listChannelWebhooks | GET /channels/{channel_id}/webhooks | |
DefaultAPI | listGuildApplicationCommandPermissions | GET /applications/{application_id}/guilds/{guild_id}/commands/permissions | |
DefaultAPI | listGuildApplicationCommands | GET /applications/{application_id}/guilds/{guild_id}/commands | |
DefaultAPI | listGuildAuditLogEntries | GET /guilds/{guild_id}/audit-logs | |
DefaultAPI | listGuildBans | GET /guilds/{guild_id}/bans | |
DefaultAPI | listGuildChannels | GET /guilds/{guild_id}/channels | |
DefaultAPI | listGuildEmojis | GET /guilds/{guild_id}/emojis | |
DefaultAPI | listGuildIntegrations | GET /guilds/{guild_id}/integrations | |
DefaultAPI | listGuildInvites | GET /guilds/{guild_id}/invites | |
DefaultAPI | listGuildMembers | GET /guilds/{guild_id}/members | |
DefaultAPI | listGuildRoles | GET /guilds/{guild_id}/roles | |
DefaultAPI | listGuildScheduledEventUsers | GET /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id}/users | |
DefaultAPI | listGuildScheduledEvents | GET /guilds/{guild_id}/scheduled-events | |
DefaultAPI | listGuildStickers | GET /guilds/{guild_id}/stickers | |
DefaultAPI | listGuildTemplates | GET /guilds/{guild_id}/templates | |
DefaultAPI | listGuildVoiceRegions | GET /guilds/{guild_id}/regions | |
DefaultAPI | listMessageReactionsByEmoji | GET /channels/{channel_id}/messages/{message_id}/reactions/{emoji_name} | |
DefaultAPI | listMessages | GET /channels/{channel_id}/messages | |
DefaultAPI | listMyConnections | GET /users/@me/connections | |
DefaultAPI | listMyGuilds | GET /users/@me/guilds | |
DefaultAPI | listMyPrivateArchivedThreads | GET /channels/{channel_id}/users/@me/threads/archived/private | |
DefaultAPI | listPinnedMessages | GET /channels/{channel_id}/pins | |
DefaultAPI | listPrivateArchivedThreads | GET /channels/{channel_id}/threads/archived/private | |
DefaultAPI | listPublicArchivedThreads | GET /channels/{channel_id}/threads/archived/public | |
DefaultAPI | listStickerPacks | GET /sticker-packs | |
DefaultAPI | listThreadMembers | GET /channels/{channel_id}/thread-members | |
DefaultAPI | listVoiceRegions | GET /voice/regions | |
DefaultAPI | pinMessage | PUT /channels/{channel_id}/pins/{message_id} | |
DefaultAPI | previewPruneGuild | GET /guilds/{guild_id}/prune | |
DefaultAPI | pruneGuild | POST /guilds/{guild_id}/prune | |
DefaultAPI | putGuildsOnboarding | PUT /guilds/{guild_id}/onboarding | |
DefaultAPI | searchGuildMembers | GET /guilds/{guild_id}/members/search | |
DefaultAPI | setChannelPermissionOverwrite | PUT /channels/{channel_id}/permissions/{overwrite_id} | |
DefaultAPI | setGuildApplicationCommandPermissions | PUT /applications/{application_id}/guilds/{guild_id}/commands/{command_id}/permissions | |
DefaultAPI | setGuildMfaLevel | POST /guilds/{guild_id}/mfa | |
DefaultAPI | syncGuildTemplate | PUT /guilds/{guild_id}/templates/{code} | |
DefaultAPI | triggerTypingIndicator | POST /channels/{channel_id}/typing | |
DefaultAPI | unbanUserFromGuild | DELETE /guilds/{guild_id}/bans/{user_id} | |
DefaultAPI | unpinMessage | DELETE /channels/{channel_id}/pins/{message_id} | |
DefaultAPI | updateApplication | PATCH /applications/{application_id} | |
DefaultAPI | updateApplicationCommand | PATCH /applications/{application_id}/commands/{command_id} | |
DefaultAPI | updateApplicationRoleConnectionsMetadata | PUT /applications/{application_id}/role-connections/metadata | |
DefaultAPI | updateApplicationUserRoleConnection | PUT /users/@me/applications/{application_id}/role-connection | |
DefaultAPI | updateAutoModerationRule | PATCH /guilds/{guild_id}/auto-moderation/rules/{rule_id} | |
DefaultAPI | updateChannel | PATCH /channels/{channel_id} | |
DefaultAPI | updateGuild | PATCH /guilds/{guild_id} | |
DefaultAPI | updateGuildApplicationCommand | PATCH /applications/{application_id}/guilds/{guild_id}/commands/{command_id} | |
DefaultAPI | updateGuildEmoji | PATCH /guilds/{guild_id}/emojis/{emoji_id} | |
DefaultAPI | updateGuildMember | PATCH /guilds/{guild_id}/members/{user_id} | |
DefaultAPI | updateGuildRole | PATCH /guilds/{guild_id}/roles/{role_id} | |
DefaultAPI | updateGuildScheduledEvent | PATCH /guilds/{guild_id}/scheduled-events/{guild_scheduled_event_id} | |
DefaultAPI | updateGuildSticker | PATCH /guilds/{guild_id}/stickers/{sticker_id} | |
DefaultAPI | updateGuildTemplate | PATCH /guilds/{guild_id}/templates/{code} | |
DefaultAPI | updateGuildWelcomeScreen | PATCH /guilds/{guild_id}/welcome-screen | |
DefaultAPI | updateGuildWidgetSettings | PATCH /guilds/{guild_id}/widget | |
DefaultAPI | updateMessage | PATCH /channels/{channel_id}/messages/{message_id} | |
DefaultAPI | updateMyApplication | PATCH /applications/@me | |
DefaultAPI | updateMyGuildMember | PATCH /guilds/{guild_id}/members/@me | |
DefaultAPI | updateMyUser | PATCH /users/@me | |
DefaultAPI | updateOriginalWebhookMessage | PATCH /webhooks/{webhook_id}/{webhook_token}/messages/@original | |
DefaultAPI | updateSelfVoiceState | PATCH /guilds/{guild_id}/voice-states/@me | |
DefaultAPI | updateStageInstance | PATCH /stage-instances/{channel_id} | |
DefaultAPI | updateVoiceState | PATCH /guilds/{guild_id}/voice-states/{user_id} | |
DefaultAPI | updateWebhook | PATCH /webhooks/{webhook_id} | |
DefaultAPI | updateWebhookByToken | PATCH /webhooks/{webhook_id}/{webhook_token} | |
DefaultAPI | updateWebhookMessage | PATCH /webhooks/{webhook_id}/{webhook_token}/messages/{message_id} |
Models
- AccountResponse
- ActionRow
- ActionRowComponentsInner
- AddGroupDmUserRequest
- AddGuildMemberRequest
- AfkTimeouts
- AllowedMentionTypes
- ApplicationCommandAttachmentOption
- ApplicationCommandAttachmentOptionResponse
- ApplicationCommandAutocompleteCallbackRequest
- ApplicationCommandAutocompleteCallbackRequestData
- ApplicationCommandBooleanOption
- ApplicationCommandBooleanOptionResponse
- ApplicationCommandChannelOption
- ApplicationCommandChannelOptionResponse
- ApplicationCommandCreateRequest
- ApplicationCommandCreateRequestOptionsInner
- ApplicationCommandIntegerOption
- ApplicationCommandIntegerOptionResponse
- ApplicationCommandMentionableOption
- ApplicationCommandMentionableOptionResponse
- ApplicationCommandNumberOption
- ApplicationCommandNumberOptionResponse
- ApplicationCommandOptionIntegerChoice
- ApplicationCommandOptionIntegerChoiceResponse
- ApplicationCommandOptionNumberChoice
- ApplicationCommandOptionNumberChoiceResponse
- ApplicationCommandOptionStringChoice
- ApplicationCommandOptionStringChoiceResponse
- ApplicationCommandOptionType
- ApplicationCommandPatchRequestPartial
- ApplicationCommandPermission
- ApplicationCommandPermissionType
- ApplicationCommandResponse
- ApplicationCommandResponseOptionsInner
- ApplicationCommandRoleOption
- ApplicationCommandRoleOptionResponse
- ApplicationCommandStringOption
- ApplicationCommandStringOptionResponse
- ApplicationCommandSubcommandGroupOption
- ApplicationCommandSubcommandGroupOptionResponse
- ApplicationCommandSubcommandOption
- ApplicationCommandSubcommandOptionOptionsInner
- ApplicationCommandSubcommandOptionResponse
- ApplicationCommandSubcommandOptionResponseOptionsInner
- ApplicationCommandType
- ApplicationCommandUpdateRequest
- ApplicationCommandUserOption
- ApplicationCommandUserOptionResponse
- ApplicationFormPartial
- ApplicationFormPartialDescription
- ApplicationIncomingWebhookResponse
- ApplicationOAuth2Params
- ApplicationOAuth2ParamsResponse
- ApplicationResponse
- ApplicationRoleConnectionsMetadataItemRequest
- ApplicationRoleConnectionsMetadataItemResponse
- ApplicationTypes
- ApplicationUserRoleConnectionResponse
- AuditLogActionTypes
- AuditLogEntryResponse
- AuditLogObjectChangeResponse
- AutomodActionType
- AutomodEventType
- AutomodKeywordPresetType
- AutomodTriggerType
- AvailableLocalesEnum
- BanUserFromGuildRequest
- BaseCreateMessageCreateRequest
- BaseCreateMessageCreateRequestComponentsInner
- BasicApplicationResponse
- BasicApplicationResponseBot
- BasicApplicationResponseType
- BasicMessageResponse
- BasicMessageResponseComponentsInner
- BasicMessageResponseNonce
- BlockMessageAction
- BlockMessageActionMetadata
- BlockMessageActionMetadataResponse
- BlockMessageActionResponse
- BotAccountPatchRequest
- BulkDeleteMessagesRequest
- BulkUpdateGuildChannelsRequestInner
- BulkUpdateGuildRolesRequestInner
- Button
- ButtonStyleTypes
- ChannelFollowerResponse
- ChannelFollowerWebhookResponse
- ChannelPermissionOverwriteRequest
- ChannelPermissionOverwriteResponse
- ChannelPermissionOverwrites
- ChannelSelect
- ChannelSelectDefaultValue
- ChannelTypes
- CommandPermissionResponse
- CommandPermissionsResponse
- ConnectedAccountGuildResponse
- ConnectedAccountIntegrationResponse
- ConnectedAccountProviders
- ConnectedAccountResponse
- ConnectedAccountVisibility
- CreateAutoModerationRuleRequest
- CreateChannelInviteRequest
- CreateDm200Response
- CreateForumThreadRequest
- CreateGroupDMInviteRequest
- CreateGuildChannelRequest
- CreateGuildEmojiRequest
- CreateGuildFromTemplateRequest
- CreateGuildInviteRequest
- CreateGuildRequestChannelItem
- CreateGuildRequestRoleItem
- CreateGuildScheduledEventRequest
- CreateGuildTemplateRequest
- CreateInteractionResponseRequest
- CreateMessageInteractionCallbackRequest
- CreateOrUpdateThreadTagRequest
- CreatePrivateChannelRequest
- CreateStageInstanceRequest
- CreateTextThreadWithMessageRequest
- CreateTextThreadWithoutMessageRequest
- CreateThreadRequest
- CreateWebhookRequest
- CreatedThreadResponse
- DefaultKeywordListTriggerMetadata
- DefaultKeywordListTriggerMetadataResponse
- DefaultKeywordListUpsertRequest
- DefaultKeywordListUpsertRequestActionsInner
- DefaultKeywordListUpsertRequestPartial
- DefaultKeywordRuleResponse
- DefaultKeywordRuleResponseActionsInner
- DefaultReactionEmojiResponse
- DiscordIntegrationResponse
- Emoji
- EmojiResponse
- EntityMetadataExternal
- EntityMetadataExternalResponse
- Error
- ErrorResponse
- ExecuteWebhookRequest
- ExternalConnectionIntegrationResponse
- ExternalScheduledEventCreateRequest
- ExternalScheduledEventPatchRequestPartial
- ExternalScheduledEventResponse
- FlagToChannelAction
- FlagToChannelActionMetadata
- FlagToChannelActionMetadataResponse
- FlagToChannelActionResponse
- FollowChannelRequest
- ForumLayout
- ForumTagResponse
- FriendInviteResponse
- GatewayBotResponse
- GatewayBotSessionStartLimitResponse
- GatewayResponse
- GetAutoModerationRule200Response
- GetGuildScheduledEvent200Response
- GetSticker200Response
- GithubAuthor
- GithubCheckApp
- GithubCheckPullRequest
- GithubCheckRun
- GithubCheckRunOutput
- GithubCheckSuite
- GithubComment
- GithubCommit
- GithubDiscussion
- GithubIssue
- GithubRelease
- GithubRepository
- GithubReview
- GithubUser
- GithubWebhook
- GroupDMInviteResponse
- GuildAuditLogResponse
- GuildAuditLogResponseIntegrationsInner
- GuildBanResponse
- GuildChannelResponse
- GuildCreateRequest
- GuildExplicitContentFilterTypes
- GuildFeatures
- GuildHomeSettingsResponse
- GuildIncomingWebhookResponse
- GuildInviteResponse
- GuildMFALevel
- GuildMFALevelResponse
- GuildMemberResponse
- GuildNSFWContentLevel
- GuildOnboardingMode
- GuildOnboardingResponse
- GuildPatchRequestPartial
- GuildPreviewResponse
- GuildProductPurchaseResponse
- GuildPruneResponse
- GuildResponse
- GuildRoleResponse
- GuildRoleTagsResponse
- GuildScheduledEventEntityTypes
- GuildScheduledEventPrivacyLevels
- GuildScheduledEventStatuses
- GuildStickerResponse
- GuildSubscriptionIntegrationResponse
- GuildTemplateChannelResponse
- GuildTemplateChannelTags
- GuildTemplateResponse
- GuildTemplateRoleResponse
- GuildTemplateSnapshotResponse
- GuildWelcomeChannel
- GuildWelcomeScreenChannelResponse
- GuildWelcomeScreenResponse
- GuildWithCountsResponse
- IncomingWebhookInteractionRequest
- IncomingWebhookRequestPartial
- IncomingWebhookUpdateForInteractionCallbackRequestPartial
- IncomingWebhookUpdateRequestPartial
- InnerErrors
- InputText
- IntegrationApplicationResponse
- IntegrationExpireBehaviorTypes
- IntegrationExpireGracePeriodTypes
- IntegrationTypes
- InteractionApplicationCommandAutocompleteCallbackIntegerData
- InteractionApplicationCommandAutocompleteCallbackNumberData
- InteractionApplicationCommandAutocompleteCallbackStringData
- InteractionCallbackTypes
- InteractionTypes
- InviteApplicationResponse
- InviteChannelRecipientResponse
- InviteChannelResponse
- InviteGuildResponse
- InviteStageInstanceResponse
- InviteTargetTypes
- InviteTypes
- KeywordRuleResponse
- KeywordTriggerMetadata
- KeywordTriggerMetadataResponse
- KeywordUpsertRequest
- KeywordUpsertRequestPartial
- ListAutoModerationRules200ResponseInner
- ListChannelInvites200ResponseInner
- ListChannelWebhooks200ResponseInner
- ListGuildChannels200ResponseInner
- ListGuildIntegrations200ResponseInner
- MLSpamRuleResponse
- MLSpamUpsertRequest
- MLSpamUpsertRequestPartial
- MentionSpamRuleResponse
- MentionSpamTriggerMetadata
- MentionSpamTriggerMetadataResponse
- MentionSpamUpsertRequest
- MentionSpamUpsertRequestPartial
- MentionableSelect
- MessageAllowedMentionsRequest
- MessageAttachmentRequest
- MessageAttachmentResponse
- MessageComponentActionRowResponse
- MessageComponentActionRowResponseComponentsInner
- MessageComponentButtonResponse
- MessageComponentChannelSelectResponse
- MessageComponentEmojiResponse
- MessageComponentInputTextResponse
- MessageComponentMentionableSelectResponse
- MessageComponentRoleSelectResponse
- MessageComponentStringSelectResponse
- MessageComponentTypes
- MessageComponentUserSelectResponse
- MessageCreateRequest
- MessageEditRequestPartial
- MessageEmbedAuthorResponse
- MessageEmbedFieldResponse
- MessageEmbedFooterResponse
- MessageEmbedImageResponse
- MessageEmbedImageResponseHeight
- MessageEmbedProviderResponse
- MessageEmbedResponse
- MessageEmbedVideoResponse
- MessageInteractionResponse
- MessageMentionChannelResponse
- MessageReactionCountDetailsResponse
- MessageReactionEmojiResponse
- MessageReactionResponse
- MessageReferenceResponse
- MessageResponse
- MessageRoleSubscriptionDataResponse
- MessageStickerItemResponse
- MessageType
- MetadataItemTypes
- ModalInteractionCallbackData
- ModalInteractionCallbackDataComponentsInner
- ModalInteractionCallbackRequest
- MyGuildResponse
- NewMemberActionResponse
- NewMemberActionType
- OAuth2GetAuthorizationResponse
- OAuth2Scopes
- OnboardingPromptOptionRequest
- OnboardingPromptOptionResponse
- OnboardingPromptResponse
- OnboardingPromptType
- PartialDiscordIntegrationResponse
- PartialExternalConnectionIntegrationResponse
- PartialGuildSubscriptionIntegrationResponse
- PongInteractionCallbackRequest
- PremiumGuildTiers
- PremiumTypes
- PrivateApplicationResponse
- PrivateChannelRequestPartial
- PrivateChannelResponse
- PrivateGroupChannelResponse
- PrivateGuildMemberResponse
- PruneGuildRequest
- PurchaseNotificationResponse
- QuarantineUserAction
- QuarantineUserActionResponse
- ReplyMessageReferenceRequest
- ResolvedObjectsResponse
- ResourceChannelResponse
- RichEmbed
- RichEmbedAuthor
- RichEmbedField
- RichEmbedFooter
- RichEmbedImage
- RichEmbedProvider
- RichEmbedThumbnail
- RichEmbedVideo
- RoleSelect
- RoleSelectDefaultValue
- ScheduledEventResponse
- ScheduledEventUserResponse
- SelectOption
- SelectOptionResponse
- SetChannelPermissionOverwriteRequest
- SetGuildApplicationCommandPermissionsRequest
- SetGuildMfaLevelRequest
- SettingsEmojiResponse
- SlackWebhook
- SpamLinkRuleResponse
- StageInstanceResponse
- StageInstancesPrivacyLevels
- StageScheduledEventCreateRequest
- StageScheduledEventPatchRequestPartial
- StageScheduledEventResponse
- StandardStickerResponse
- StickerFormatTypes
- StickerPackCollectionResponse
- StickerPackResponse
- StickerTypes
- StringSelect
- TeamMemberResponse
- TeamMembershipStates
- TeamResponse
- TextStyleTypes
- ThreadAutoArchiveDuration
- ThreadMemberResponse
- ThreadMetadataResponse
- ThreadResponse
- ThreadSortOrder
- ThreadsResponse
- UpdateApplicationUserRoleConnectionRequest
- UpdateAutoModerationRuleRequest
- UpdateChannelRequest
- UpdateDefaultReactionEmojiRequest
- UpdateGuildChannelRequestPartial
- UpdateGuildEmojiRequest
- UpdateGuildMemberRequest
- UpdateGuildOnboardingRequest
- UpdateGuildRoleRequest
- UpdateGuildScheduledEventRequest
- UpdateGuildStickerRequest
- UpdateGuildTemplateRequest
- UpdateGuildWidgetSettingsRequest
- UpdateMessageInteractionCallbackRequest
- UpdateMyGuildMemberRequest
- UpdateOnboardingPromptRequest
- UpdateSelfVoiceStateRequest
- UpdateSelfVoiceStateRequestChannelId
- UpdateStageInstanceRequest
- UpdateThreadRequestPartial
- UpdateThreadTagRequest
- UpdateVoiceStateRequest
- UpdateWebhookByTokenRequest
- UpdateWebhookRequest
- UserCommunicationDisabledAction
- UserCommunicationDisabledActionMetadata
- UserCommunicationDisabledActionMetadataResponse
- UserCommunicationDisabledActionResponse
- UserGuildOnboardingResponse
- UserNotificationSettings
- UserPIIResponse
- UserResponse
- UserSelect
- UserSelectDefaultValue
- VanityURLErrorResponse
- VanityURLResponse
- VerificationLevels
- VideoQualityModes
- VoiceRegionResponse
- VoiceScheduledEventCreateRequest
- VoiceScheduledEventPatchRequestPartial
- VoiceScheduledEventResponse
- WebhookSlackEmbed
- WebhookSlackEmbedField
- WebhookSourceChannelResponse
- WebhookSourceGuildResponse
- WebhookTypes
- WelcomeMessageResponse
- WelcomeScreenPatchRequestPartial
- WidgetActivity
- WidgetChannel
- WidgetImageStyles
- WidgetMember
- WidgetResponse
- WidgetSettingsResponse
- WidgetUserDiscriminator
Authorization
BotToken
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
OAuth2
- Type:
OAuth
- Flow:
implicit
- Authorization URL:
discord.com/oauth2/authorize
- Scopes:
- activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
- activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
- applications.builds.read: allows your app to read build data for a user's applications
- applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
- applications.commands: allows your app to use commands in a guild
- applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
- applications.entitlements: allows your app to read entitlements for a user's applications
- applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
- bot: for oauth2 bots, this puts the bot in the user's selected guild by default
- connections: allows /users/@me/connections to return linked third-party accounts
- dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
- email: enables /users/@me to return an email
- gdm.join: allows your app to join users to a group dm
- guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
- guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
- guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
- identify: allows /users/@me without email
- messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
- relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
- rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
- rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
- rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
- rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
- rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
- rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
- rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
- rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
- rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
- voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
- webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
OAuth2
- Type:
OAuth
- Flow:
application
- Authorization URL: ``
- Scopes:
- activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
- activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
- applications.builds.read: allows your app to read build data for a user's applications
- applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
- applications.commands: allows your app to use commands in a guild
- applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
- applications.commands.update: allows your app to update its commands using a Bearer token - client credentials grant only
- applications.entitlements: allows your app to read entitlements for a user's applications
- applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
- bot: for oauth2 bots, this puts the bot in the user's selected guild by default
- connections: allows /users/@me/connections to return linked third-party accounts
- dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
- email: enables /users/@me to return an email
- gdm.join: allows your app to join users to a group dm
- guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
- guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
- guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
- identify: allows /users/@me without email
- messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
- relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
- rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
- rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
- rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
- rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
- rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
- rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
- rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
- rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
- rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
- voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
- webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
OAuth2
- Type:
OAuth
- Flow:
accessCode
- Authorization URL:
discord.com/oauth2/authorize
- Scopes:
- activities.read: allows your app to fetch data from a user's "Now Playing/Recently Played" list - requires Discord approval
- activities.write: allows your app to update a user's activity - requires Discord approval (NOT REQUIRED FOR GAMESDK ACTIVITY MANAGER)
- applications.builds.read: allows your app to read build data for a user's applications
- applications.builds.upload: allows your app to upload/update builds for a user's applications - requires Discord approval
- applications.commands: allows your app to use commands in a guild
- applications.commands.permissions.update: allows your app to update permissions for its commands in a guild a user has permissions to
- applications.entitlements: allows your app to read entitlements for a user's applications
- applications.store.update: allows your app to read and update store data (SKUs, store listings, achievements, etc.) for a user's applications
- bot: for oauth2 bots, this puts the bot in the user's selected guild by default
- connections: allows /users/@me/connections to return linked third-party accounts
- dm_channels.read: allows your app to see information about the user's DMs and group DMs - requires Discord approval
- email: enables /users/@me to return an email
- gdm.join: allows your app to join users to a group dm
- guilds: allows /users/@me/guilds to return basic information about all of a user's guilds
- guilds.join: allows /guilds/{guild.id}/members/{user.id} to be used for joining users to a guild
- guilds.members.read: allows /users/@me/guilds/{guild.id}/member to return a user's member information in a guild
- identify: allows /users/@me without email
- messages.read: for local rpc server api access, this allows you to read messages from all client channels (otherwise restricted to channels/guilds your app creates)
- relationships.read: allows your app to know a user's friends and implicit relationships - requires Discord approval
- role_connections.write: allows your app to update a user's connection and metadata for the app
- rpc: for local rpc server access, this allows you to control a user's local Discord client - requires Discord approval
- rpc.activities.write: for local rpc server access, this allows you to update a user's activity - requires Discord approval
- rpc.notifications.read: for local rpc server access, this allows you to receive notifications pushed out to the user - requires Discord approval
- rpc.screenshare.read: for local rpc server access, this allows you to read a user's screenshare status- requires Discord approval
- rpc.screenshare.write: for local rpc server access, this allows you to update a user's screenshare settings- requires Discord approval
- rpc.video.read: for local rpc server access, this allows you to read a user's video status - requires Discord approval
- rpc.video.write: for local rpc server access, this allows you to update a user's video settings - requires Discord approval
- rpc.voice.read: for local rpc server access, this allows you to read a user's voice settings and listen for voice events - requires Discord approval
- rpc.voice.write: for local rpc server access, this allows you to update a user's voice settings - requires Discord approval
- voice: allows your app to connect to voice on user's behalf and see all the voice members - requires Discord approval
- webhook.incoming: this generates a webhook that is returned in the oauth token response for authorization code grants
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
10
- Build package:
org.openapitools.codegen.languages.PhpNextgenClientCodegen