organizationinvitation

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.

Package organizationinvitation provides the Organization Invitations API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.OrganizationInvitation, error)
• func Get(ctx context.Context, params *GetParams) (*clerk.OrganizationInvitation, error)
• func List(ctx context.Context, params *ListParams) (*clerk.OrganizationInvitationList, error)
• func ListFromInstance(ctx context.Context, params *ListFromInstanceParams) (*clerk.OrganizationInvitationList, error)
• func Revoke(ctx context.Context, params *RevokeParams) (*clerk.OrganizationInvitation, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.OrganizationInvitation, error)
  • func (c *Client) Get(ctx context.Context, params *GetParams) (*clerk.OrganizationInvitation, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.OrganizationInvitationList, error)
  • func (c *Client) ListFromInstance(ctx context.Context, params *ListFromInstanceParams) (*clerk.OrganizationInvitationList, error)
  • func (c *Client) Revoke(ctx context.Context, params *RevokeParams) (*clerk.OrganizationInvitation, error)
• type CreateParams
• type GetParams
• type ListFromInstanceParams
  • func (p *ListFromInstanceParams) ToQuery() url.Values
• type ListParams
  • func (p *ListParams) ToQuery() url.Values
• type RevokeParams

Functions

func Create

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

Create creates and sends an invitation to join an organization.

func Get

func Get(ctx context.Context, params *GetParams) (*clerk.OrganizationInvitation, error)

Get retrieves the detail for an organization invitation.

func List

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

List returns a list of organization invitations

func ListFromInstance

func ListFromInstance(ctx context.Context, params *ListFromInstanceParams) (*clerk.OrganizationInvitationList, error)

ListAllFromInstance lists all the organization invitations from the current instance

func Revoke

func Revoke(ctx context.Context, params *RevokeParams) (*clerk.OrganizationInvitation, error)

Revoke marks the organization invitation as revoked.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Organization Invitations API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates and sends an invitation to join an organization.

func (*Client) Get

func (c *Client) Get(ctx context.Context, params *GetParams) (*clerk.OrganizationInvitation, error)

Get retrieves the detail for an organization invitation.

func (*Client) List

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

List returns a list of organization invitations

func (*Client) ListFromInstance

func (c *Client) ListFromInstance(ctx context.Context, params *ListFromInstanceParams) (*clerk.OrganizationInvitationList, error)

ListAllFromInstance lists all the organization invitations from the current instance

func (*Client) Revoke

func (c *Client) Revoke(ctx context.Context, params *RevokeParams) (*clerk.OrganizationInvitation, error)

Revoke marks the organization invitation as revoked.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	EmailAddress    *string          `json:"email_address,omitempty"`
	Role            *string          `json:"role,omitempty"`
	RedirectURL     *string          `json:"redirect_url,omitempty"`
	InviterUserID   *string          `json:"inviter_user_id,omitempty"`
	PublicMetadata  *json.RawMessage `json:"public_metadata,omitempty"`
	PrivateMetadata *json.RawMessage `json:"private_metadata,omitempty"`
	OrganizationID  string           `json:"-"`
	ExpiresInDays   *int64           `json:"expires_in_days,omitempty"`
}

type GetParams

type GetParams struct {
	OrganizationID string
	ID             string
}

type ListFromInstanceParams

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

func (*ListFromInstanceParams) ToQuery

func (p *ListFromInstanceParams) ToQuery() url.Values

type ListParams

type ListParams struct {
	clerk.APIParams
	clerk.ListParams
	OrganizationID string
	Statuses       *[]string
	EmailAddress   *string
	OrderBy        *string
}

func (*ListParams) ToQuery

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

type RevokeParams

type RevokeParams struct {
	clerk.APIParams
	RequestingUserID *string `json:"requesting_user_id,omitempty"`
	OrganizationID   string  `json:"-"`
	ID               string  `json:"-"`
}