InvitesShorter
Signature
export declare class InvitesShorter extends BaseShorterProperties
2Methods
5Properties
channels: { create: ({ channelId, reason, ...body }: CreateInviteFromChannel) => Promise<{ uses: number; maxUses: number; maxAge: number; temporary: boolean; createdAt: string; code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; }>; list: (channelId: string) => Promise<{ uses: number; maxUses: number; maxAge: number; temporary: boolean; createdAt: string; code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; roles?: { id: string; name: string; icon?: string | null | undefined; position: number; color: number; colors: { primaryColor: number; secondaryColor: number | null; tertiaryColor: number | null; }; unicodeEmoji?: string | null | undefined; } | undefined; }[]>;};guilds: { list: (guildId: string) => Promise<{ uses: number; maxUses: number; maxAge: number; temporary: boolean; createdAt: string; code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType; }[]>;};Methods
get(code: string): Promise<{ code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType;}>;delete(code: string, reason?: string): Promise<{ code: string; guild?: { id: string; name: string; description: string | null; icon: string | null; splash: string | null; banner: string | null; features: GuildFeature[]; verificationLevel: GuildVerificationLevel; vanityUrlCode: string | null; premiumSubscriptionCount?: number | undefined; nsfwLevel: GuildNSFWLevel; } | undefined; channel: { id: string; type: ChannelType; name: string | null; } | null; inviter?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetType?: InviteTargetType | undefined; targetUser?: { id: string; username: string; discriminator: string; globalName: string | null; avatar: string | null; bot?: boolean | undefined; system?: boolean | undefined; mfaEnabled?: boolean | undefined; banner?: string | null | undefined; accentColor?: number | null | undefined; locale?: string | undefined; verified?: boolean | undefined; email?: string | null | undefined; flags?: UserFlags | undefined; premiumType?: UserPremiumType | undefined; publicFlags?: UserFlags | undefined; avatarDecorationData?: APIAvatarDecorationData | null | undefined; collectibles?: APICollectibles | null | undefined; primaryGuild?: APIUserPrimaryGuild | null | undefined; } | undefined; targetApplication?: { id?: string | undefined; name?: string | undefined; icon?: string | null | undefined; description?: string | undefined; rpcOrigins?: string[] | undefined; botPublic?: boolean | undefined; botRequireCodeGrant?: boolean | undefined; bot?: APIUser | undefined; termsOfServiceUrl?: string | undefined; privacyPolicyUrl?: string | undefined; owner?: APIUser | undefined; verifyKey?: string | undefined; team?: APITeam | null | undefined; guildId?: string | undefined; guild?: APIPartialGuild | undefined; primarySkuId?: string | undefined; slug?: string | undefined; coverImage?: string | undefined; flags?: ApplicationFlags | undefined; approximateGuildCount?: number | undefined; approximateUserInstallCount?: number | undefined; redirectUris?: string[] | undefined; interactionsEndpointUrl?: string | null | undefined; roleConnectionsVerificationUrl?: string | null | undefined; tags?: [ string, (string | undefined)?, (string | undefined)?, (string | undefined)?, (string | undefined)? ] | undefined; installParams?: APIApplicationInstallParams | undefined; integrationTypesConfig?: APIApplicationIntegrationTypesConfigMap | undefined; customInstallUrl?: string | undefined; } | undefined; approximatePresenceCount?: number | undefined; approximateMemberCount?: number | undefined; expiresAt?: string | null | undefined; guildScheduledEvent?: { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.StageInstance; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: string; entityMetadata: null; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.Voice; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | { channelId: null; entityMetadata: { location: string; }; id: string; guildId: string; creatorId?: string | null | undefined; name: string; description?: string | null | undefined; scheduledStartTime: string; scheduledEndTime: string | null; privacyLevel: GuildScheduledEventPrivacyLevel; status: GuildScheduledEventStatus; entityType: GuildScheduledEventEntityType.External; entityId: string | null; creator?: APIUser | undefined; userCount?: number | undefined; image?: string | null | undefined; recurrenceRule: APIGuildScheduledEventRecurrenceRule | null; } | undefined; type: InviteType;}>;getTargetUsers(code: string): Promise<string>;Returns a list of users that can accept this invite.
Parameters
code- The invite code.
Returns
The csv file as a string, with a single header user_id.
updateTargetUsers(code: string, targetIds: string[]): Promise<undefined>;jobStatus(code: string): Promise<{ status: TargetUsersJobStatusCode; totalUsers: number; processedUsers: number; createdAt: string; completedAt: string | null; errorMessage?: string | undefined;}>;