class InvitesAPI

export declare class InvitesAPI
delete
get
getTargetUsers
getTargetUsersJobStatus
updateTargetUsers

Constructors

constructor(
rest: REST
)

Constructs a new instance of the InvitesAPI class

delete(
code: string
options?: Pick<RequestData, 'reason' | 'signal'>
) : Promise<APIInvite>

Deletes an invite

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

get(
code: string
query?: RESTGetAPIInviteQuery
options?: Pick<RequestData, 'signal'>
) : Promise<APIInvite>

Fetches an invite

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

getTargetUsers(
code: string
options?: Pick<RequestData, 'signal'>
) : Promise<ArrayBuffer>

Fetches an invite's target users

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

getTargetUsersJobStatus(
code: string
options?: Pick<RequestData, 'signal'>
) : Promise<RESTGetAPIInviteTargetUsersJobStatusResult>

Fetches an invite's target users job status

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

updateTargetUsers(
code: string
targetUsersFile: RawFile
options?: Pick<RequestData, 'signal'>
) : Promise<undefined>

Updates an invite's target users

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