invitation

Documentation

Overview

Code generated by "gen"; DO NOT EDIT. This file is meant to be re-generated in place and/or deleted at any time.

Index

• func BulkCreate(ctx context.Context, params *BulkCreateParams) (*clerk.Invitations, error)
• func Create(ctx context.Context, params *CreateParams) (*clerk.Invitation, error)
• func List(ctx context.Context, params *ListParams) (*clerk.InvitationList, error)
• func Revoke(ctx context.Context, id string) (*clerk.Invitation, error)
• type BulkCreateParams
  • func (b BulkCreateParams) MarshalJSON() ([]byte, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) BulkCreate(ctx context.Context, params *BulkCreateParams) (*clerk.Invitations, error)
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.Invitation, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.InvitationList, error)
  • func (c *Client) Revoke(ctx context.Context, id string) (*clerk.Invitation, error)
• type CreateParams
• type ListParams
  • func (params *ListParams) ToQuery() url.Values

Functions

func BulkCreate

func BulkCreate(ctx context.Context, params *BulkCreateParams) (*clerk.Invitations, error)

BulkCreate creates multiple invitations.

func Create

func Create(ctx context.Context, params *CreateParams) (*clerk.Invitation, error)

Create adds a new identifier to the allowlist.

func List

func List(ctx context.Context, params *ListParams) (*clerk.InvitationList, error)

List returns all invitations.

func Revoke

func Revoke(ctx context.Context, id string) (*clerk.Invitation, error)

Revoke revokes a pending invitation.

Types

type BulkCreateParams

type BulkCreateParams struct {
	clerk.APIParams
	Invitations []*CreateParams
}

func (BulkCreateParams) MarshalJSON

func (b BulkCreateParams) MarshalJSON() ([]byte, error)

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Invitations API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) BulkCreate

func (c *Client) BulkCreate(ctx context.Context, params *BulkCreateParams) (*clerk.Invitations, error)

BulkCreate creates multiple invitations.

func (*Client) Create

func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.Invitation, error)

Create adds a new identifier to the allowlist.

func (*Client) List

func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.InvitationList, error)

List returns all invitations.

func (*Client) Revoke

func (c *Client) Revoke(ctx context.Context, id string) (*clerk.Invitation, error)

Revoke revokes a pending invitation.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	EmailAddress   string           `json:"email_address"`
	PublicMetadata *json.RawMessage `json:"public_metadata,omitempty"`
	RedirectURL    *string          `json:"redirect_url,omitempty"`
	Notify         *bool            `json:"notify,omitempty"`
	IgnoreExisting *bool            `json:"ignore_existing,omitempty"`
	ExpiresInDays  *int64           `json:"expires_in_days,omitempty"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
	clerk.ListParams
	OrderBy  *string  `json:"order_by,omitempty"`
	Query    *string  `json:"query,omitempty"`
	Statuses []string `json:"status,omitempty"`
}

func (*ListParams) ToQuery

func (params *ListParams) ToQuery() url.Values

ToQuery returns query string values from the params.