client

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 client provides the Client API.

Index

• func Get(ctx context.Context, id string) (*clerk.Client, error)
• func List(ctx context.Context, params *ListParams) (*clerk.ClientList, error)
• func Verify(ctx context.Context, params *VerifyParams) (*clerk.Client, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Get(ctx context.Context, id string) (*clerk.Client, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.ClientList, error)
  • func (c *Client) Verify(ctx context.Context, params *VerifyParams) (*clerk.Client, error)
• type ListParams
  • func (params *ListParams) ToQuery() url.Values
• type VerifyParams

Functions

func Get

func Get(ctx context.Context, id string) (*clerk.Client, error)

Get retrieves the client specified by ID.

func List

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

List returns a list of all the clients.

Deprecated: The operation is deprecated and will be removed in future versions.

func Verify

func Verify(ctx context.Context, params *VerifyParams) (*clerk.Client, error)

Verify verifies the Client in the provided JWT.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Client API. This is an API client for interacting with Clerk Client resources.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Get

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

Get retrieves the client specified by ID.

func (*Client) List

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

List returns a list of all the clients.

Deprecated: The operation is deprecated and will be removed in future versions.

func (*Client) Verify

func (c *Client) Verify(ctx context.Context, params *VerifyParams) (*clerk.Client, error)

Verify verifies the Client in the provided JWT.

type ListParams

type ListParams struct {
	clerk.APIParams
	clerk.ListParams
}

func (*ListParams) ToQuery

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

type VerifyParams

type VerifyParams struct {
	clerk.APIParams
	Token *string `json:"token,omitempty"`
}