Invite

HTTP Rest API implementation for the following Resource:

• https://discord.com/developers/docs/resources/invite

Summary

Functions

Invite.getInviteAsync(instance: request.Request, inviteCode: string, urlParams: { withCounts: boolean?, withExpiration: boolean?, guildScheduledEventId: apiTypes.Snowflake?, }) → future.FutureLike<string, apiTypes.GetInviteResponse>Invite.deleteInviteAsync(instance: request.Request, inviteCode: string, auditLogReason: string?) → future.FutureLike<string, apiTypes.DeleteInviteResponse>Invite.getInviteTargetUsersAsync(instance: request.Request, inviteCode: string) → future.FutureLike<string, apiTypes.GetInviteTargetUsersResponse>Invite.updateInviteTargetUsersAsync(instance: request.Request, inviteCode: string, csvContent: string) → future.FutureLike<string, apiTypes.UpdateInviteTargetUsersResponse>Invite.getInviteTargetUsersJobStatusAsync(instance: request.Request, inviteCode: string) → future.FutureLike< string, apiTypes.GetInviteTargetUsersJobStatusResponse >

Functions

getInviteAsync

Invite . getInviteAsync ( instance ,  inviteCode ,  urlParams )  -> FutureLike<string, GetInviteResponse>

https://discord.com/developers/docs/resources/invite#get-invite

Parameters

instance: Request
inviteCode: string
urlParams: { withCounts: boolean?, withExpiration: boolean?, guildScheduledEventId: apiTypes.Snowflake?, }

Returns

FutureLike<string, GetInviteResponse>

deleteInviteAsync

Invite . deleteInviteAsync ( instance ,  inviteCode ,  auditLogReason )  -> FutureLike<string, DeleteInviteResponse>

https://discord.com/developers/docs/resources/invite#delete-invite

Parameters

instance: Request
inviteCode: string
auditLogReason: string?

Returns

FutureLike<string, DeleteInviteResponse>

getInviteTargetUsersAsync

Invite . getInviteTargetUsersAsync ( instance ,  inviteCode )  -> FutureLike<string, GetInviteTargetUsersResponse>

https://docs.discord.com/developers/resources/invite#get-target-users

Parameters

instance: Request
inviteCode: string

Returns

FutureLike<string, GetInviteTargetUsersResponse>

updateInviteTargetUsersAsync

Invite . updateInviteTargetUsersAsync ( instance ,  inviteCode ,  csvContent )  -> FutureLike<string, UpdateInviteTargetUsersResponse>

https://docs.discord.com/developers/resources/invite#update-target-users

Parameters

instance: Request
inviteCode: string
csvContent: string

Returns

FutureLike<string, UpdateInviteTargetUsersResponse>

getInviteTargetUsersJobStatusAsync

Invite . getInviteTargetUsersJobStatusAsync ( instance ,  inviteCode )  -> FutureLike< string, GetInviteTargetUsersJobStatusResponse >

https://docs.discord.com/developers/resources/invite#get-target-users-job-status

Parameters

instance: Request
inviteCode: string

Returns

FutureLike<string, GetInviteTargetUsersJobStatusResponse>