redirecturl

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 redirecturl provides the Redirect URLs API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.RedirectURL, error)
• func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
• func Get(ctx context.Context, id string) (*clerk.RedirectURL, error)
• func List(ctx context.Context, params *ListParams) (*clerk.RedirectURLList, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.RedirectURL, error)
  • func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
  • func (c *Client) Get(ctx context.Context, id string) (*clerk.RedirectURL, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.RedirectURLList, error)
• type CreateParams
• type ListParams

Functions

func Create

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

Create creates a new redirect url.

func Delete

func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)

Delete deletes a redirect url.

func Get

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

Get retrieves details for a redirect url by ID.

func List

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

List returns a list of redirect urls.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Redirect URLs API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates a new redirect url.

func (*Client) Delete

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

Delete deletes a redirect url.

func (*Client) Get

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

Get retrieves details for a redirect url by ID.

func (*Client) List

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

List returns a list of redirect urls.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	URL *string `json:"url,omitempty"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
}