organizationmembership

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 organizationmembership provides the Organization Memberships API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.OrganizationMembership, error)
• func Delete(ctx context.Context, params *DeleteParams) (*clerk.OrganizationMembership, error)
• func List(ctx context.Context, params *ListParams) (*clerk.OrganizationMembershipList, error)
• func Update(ctx context.Context, params *UpdateParams) (*clerk.OrganizationMembership, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.OrganizationMembership, error)
  • func (c *Client) Delete(ctx context.Context, params *DeleteParams) (*clerk.OrganizationMembership, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.OrganizationMembershipList, error)
  • func (c *Client) Update(ctx context.Context, params *UpdateParams) (*clerk.OrganizationMembership, error)
• type CreateParams
• type DeleteParams
• type ListParams
  • func (params *ListParams) ToQuery() url.Values
• type UpdateParams

Functions

func Create

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

Create adds a new member to the organization.

func Delete

func Delete(ctx context.Context, params *DeleteParams) (*clerk.OrganizationMembership, error)

Delete removes a member from an organization.

func List

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

List returns a list of organization memberships.

func Update

func Update(ctx context.Context, params *UpdateParams) (*clerk.OrganizationMembership, error)

Update updates an organization membership.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Organization Memberships API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create adds a new member to the organization.

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, params *DeleteParams) (*clerk.OrganizationMembership, error)

Delete removes a member from an organization.

func (*Client) List

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

List returns a list of organization memberships.

func (*Client) Update

func (c *Client) Update(ctx context.Context, params *UpdateParams) (*clerk.OrganizationMembership, error)

Update updates an organization membership.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	UserID         *string `json:"user_id,omitempty"`
	Role           *string `json:"role,omitempty"`
	OrganizationID string  `json:"-"`
}

type DeleteParams

type DeleteParams struct {
	clerk.APIParams
	OrganizationID string `json:"-"`
	UserID         string `json:"-"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
	clerk.ListParams
	OrderBy        *string  `json:"order_by,omitempty"`
	Query          *string  `json:"query,omitempty"`
	Roles          []string `json:"role,omitempty"`
	UserIDs        []string `json:"user_id,omitempty"`
	EmailAddresses []string `json:"email_address,omitempty"`
	PhoneNumbers   []string `json:"phone_number,omitempty"`
	Usernames      []string `json:"username,omitempty"`
	Web3Wallets    []string `json:"web3_wallet,omitempty"`
	OrganizationID string   `json:"-"`
}

func (*ListParams) ToQuery

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

ToQuery returns the parameters as url.Values so they can be used in a URL query string.

type UpdateParams

type UpdateParams struct {
	clerk.APIParams
	Role           *string `json:"role,omitempty"`
	OrganizationID string  `json:"-"`
	UserID         string  `json:"-"`
}