refactor(Invite): rename InviteTargetUserType to InviteTargetType (#124)

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

BREAKING CHANGE: `InviteTargetUserType` is renamed to `InviteTargetType`, to match the documentation.
  - Reference: https://github.com/discord/discord-api-docs/pull/2690
This commit is contained in:
Advaith
2021-04-18 00:34:51 -07:00
committed by GitHub
parent abe05136fd
commit bc9ab4556c
6 changed files with 30 additions and 22 deletions

View File

@@ -19,7 +19,7 @@ import type {
GatewayActivity,
GatewayPresenceUpdate as RawGatewayPresenceUpdate,
GatewayVoiceState,
InviteTargetUserType,
InviteTargetType,
PresenceUpdateStatus,
} from '../payloads/v8/mod.ts';
@@ -936,11 +936,11 @@ export interface GatewayInviteCreateDispatchData {
*/
max_uses: number;
/**
* The type of user target for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
* See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The user whose stream to display for this voice channel stream invite
*

View File

@@ -34,11 +34,11 @@ export interface APIInvite {
*/
inviter?: APIUser;
/**
* The type of user target for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The user whose stream to display for this voice channel stream invite
*
@@ -47,6 +47,8 @@ export interface APIInvite {
target_user?: APIUser;
/**
* The embedded application to open for this voice channel embedded application invite
*
* See https://discord.com/developers/docs/topics/oauth2#application
*/
target_application?: Partial<APIApplication>;
/**
@@ -60,9 +62,9 @@ export interface APIInvite {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
* https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
export enum InviteTargetUserType {
export enum InviteTargetType {
STREAM = 1,
EMBEDDED_APPLICATION,
}

View File

@@ -10,7 +10,7 @@ import type {
APIOverwrite,
APIUser,
ChannelType,
InviteTargetUserType,
InviteTargetType,
MessageFlags,
OverwriteType,
VideoQualityMode,
@@ -385,9 +385,11 @@ export interface RESTPostAPIChannelInviteJSONBody {
*/
unique?: boolean;
/**
* The type of target user for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The id of the user whose stream to display for this invite
* - Required if `target_type` is 1

View File

@@ -19,7 +19,7 @@ import type {
GatewayActivity,
GatewayPresenceUpdate as RawGatewayPresenceUpdate,
GatewayVoiceState,
InviteTargetUserType,
InviteTargetType,
PresenceUpdateStatus,
} from '../payloads/v8/index';
@@ -936,11 +936,11 @@ export interface GatewayInviteCreateDispatchData {
*/
max_uses: number;
/**
* The type of user target for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
* See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The user whose stream to display for this voice channel stream invite
*

View File

@@ -34,11 +34,11 @@ export interface APIInvite {
*/
inviter?: APIUser;
/**
* The type of user target for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The user whose stream to display for this voice channel stream invite
*
@@ -47,6 +47,8 @@ export interface APIInvite {
target_user?: APIUser;
/**
* The embedded application to open for this voice channel embedded application invite
*
* See https://discord.com/developers/docs/topics/oauth2#application
*/
target_application?: Partial<APIApplication>;
/**
@@ -60,9 +62,9 @@ export interface APIInvite {
}
/**
* https://discord.com/developers/docs/resources/invite#invite-object-target-user-types
* https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
export const enum InviteTargetUserType {
export const enum InviteTargetType {
STREAM = 1,
EMBEDDED_APPLICATION,
}

View File

@@ -10,7 +10,7 @@ import type {
APIOverwrite,
APIUser,
ChannelType,
InviteTargetUserType,
InviteTargetType,
MessageFlags,
OverwriteType,
VideoQualityMode,
@@ -385,9 +385,11 @@ export interface RESTPostAPIChannelInviteJSONBody {
*/
unique?: boolean;
/**
* The type of target user for this voice channel invite
* The type of target for this voice channel invite
*
* See https://discord.com/developers/docs/resources/invite#invite-object-invite-target-types
*/
target_type?: InviteTargetUserType;
target_type?: InviteTargetType;
/**
* The id of the user whose stream to display for this invite
* - Required if `target_type` is 1