invite.go

package disgord

import (
	"context"
	"net/http"

	"github.com/andersfylling/disgord/internal/endpoint"
	"github.com/andersfylling/disgord/internal/httd"
)

// PartialInvite ...
//
//	{
//	   "code": "abc"
//	}
type PartialInvite = Invite

// Invite Represents a code that when used, adds a user to a guild.
// https://discord.com/developers/docs/resources/invite#invite-object
// Reviewed: 2018-06-10
type Invite struct {
	// Code the invite code (unique Snowflake)
	Code string `json:"code"`

	// Guild the guild this invite is for
	Guild *Guild `json:"guild"`

	// Channel the channel this invite is for
	Channel *PartialChannel `json:"channel"`

	// Inviter the user that created the invite
	Inviter *User `json:"inviter"`

	// CreatedAt the time at which the invite was created
	CreatedAt Time `json:"created_at"`

	// MaxAge how long the invite is valid for (in seconds)
	MaxAge int `json:"max_age"`

	// MaxUses the maximum number of times the invite can be used
	MaxUses int `json:"max_uses"`

	// Temporary whether or not the invite is temporary (invited Users will be kicked on disconnect unless they're assigned a role)
	Temporary bool `json:"temporary"`

	// Uses how many times the invite has been used (always will be 0)
	Uses int `json:"uses"`

	Revoked bool `json:"revoked"`
	Unique  bool `json:"unique"`

	// ApproximatePresenceCount approximate count of online members
	ApproximatePresenceCount int `json:"approximate_presence_count,omitempty"`

	// ApproximatePresenceCount approximate count of total members
	ApproximateMemberCount int `json:"approximate_member_count,omitempty"`
}

var _ Copier = (*Invite)(nil)
var _ DeepCopier = (*Invite)(nil)

// InviteMetadata Object
// https://discord.com/developers/docs/resources/invite#invite-metadata-object
// Reviewed: 2018-06-10
type InviteMetadata struct {
	// Inviter user who created the invite
	Inviter *User `json:"inviter"`

	// Uses number of times this invite has been used
	Uses int `json:"uses"`

	// MaxUses max number of times this invite can be used
	MaxUses int `json:"max_uses"`

	// MaxAge duration (in seconds) after which the invite expires
	MaxAge int `json:"max_age"`

	// Temporary whether this invite only grants temporary membership
	Temporary bool `json:"temporary"`

	// CreatedAt when this invite was created
	CreatedAt Time `json:"created_at"`

	// Revoked whether this invite is revoked
	Revoked bool `json:"revoked"`
}

var _ Copier = (*InviteMetadata)(nil)
var _ DeepCopier = (*InviteMetadata)(nil)

// voiceRegionsFactory temporary until flyweight is implemented
func inviteFactory() interface{} {
	return &Invite{}
}

type InviteQueryBuilder interface {
	WithContext(ctx context.Context) InviteQueryBuilder
	WithFlags(flags ...Flag) InviteQueryBuilder

	// Get Returns an invite object for the given code.
	Get(withMemberCount bool) (*Invite, error)

	// Delete an invite. Requires the MANAGE_CHANNELS permission. Returns an invite object on success.
	Delete() (deleted *Invite, err error)
}

func (c clientQueryBuilder) Invite(code string) InviteQueryBuilder {
	return &inviteQueryBuilder{client: c.client, inviteCode: code}
}

type inviteQueryBuilder struct {
	ctx        context.Context
	flags      Flag
	client     *Client
	inviteCode string
}

func (i inviteQueryBuilder) WithContext(ctx context.Context) InviteQueryBuilder {
	i.ctx = ctx
	return &i
}

func (i inviteQueryBuilder) WithFlags(flags ...Flag) InviteQueryBuilder {
	i.flags = mergeFlags(flags)
	return &i
}

type getInviteQuery struct {
	WithMemberCount bool `urlparam:"with_count,omitempty"`
}

var _ URLQueryStringer = (*getInviteQuery)(nil)

// Get [REST] Returns an invite object for the given code.
//
//	Method                  GET
//	Endpoint                /invites/{invite.code}
//	Discord documentation   https://discord.com/developers/docs/resources/invite#get-invite
//	Reviewed                2018-06-10
//	Comment                 -
//	withMemberCount: whether or not the invite should contain the approximate number of members
func (i inviteQueryBuilder) Get(withMemberCount bool) (invite *Invite, err error) {
	params := &getInviteQuery{withMemberCount}

	r := i.client.newRESTRequest(&httd.Request{
		Endpoint: endpoint.Invite(i.inviteCode) + params.URLQueryString(),
		Ctx:      i.ctx,
	}, i.flags)
	r.factory = inviteFactory

	return getInvite(r.Execute)
}

// Delete [REST] Delete an invite. Requires the MANAGE_CHANNELS permission. Returns an invite object on success.
//
//	Method                  DELETE
//	Endpoint                /invites/{invite.code}
//	Discord documentation   https://discord.com/developers/docs/resources/invite#delete-invite
//	Reviewed                2018-06-10
//	Comment                 -
func (i inviteQueryBuilder) Delete() (deleted *Invite, err error) {
	r := i.client.newRESTRequest(&httd.Request{
		Method:   http.MethodDelete,
		Endpoint: endpoint.Invite(i.inviteCode),
		Ctx:      i.ctx,
	}, i.flags)
	r.factory = inviteFactory

	return getInvite(r.Execute)
}