organizationinvitation

package
v2.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2024 License: MIT Imports: 4 Imported by: 0

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

Constants

This section is empty.

Variables

This section is empty.

Functions

func Create 

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

Create creates and sends an invitation to join an organization.

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.

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:"-"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.