domain

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 domain provides the Domains API.

Index

• func Create(ctx context.Context, params *CreateParams) (*clerk.Domain, error)
• func Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
• func List(ctx context.Context, params *ListParams) (*clerk.DomainList, error)
• func Update(ctx context.Context, id string, params *UpdateParams) (*clerk.Domain, error)
• type Client
  • func NewClient(config *clerk.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, params *CreateParams) (*clerk.Domain, error)
  • func (c *Client) Delete(ctx context.Context, id string) (*clerk.DeletedResource, error)
  • func (c *Client) List(ctx context.Context, params *ListParams) (*clerk.DomainList, error)
  • func (c *Client) Update(ctx context.Context, id string, params *UpdateParams) (*clerk.Domain, error)
• type CreateParams
• type ListParams
• type UpdateParams

Functions

func Create

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

Create creates a new domain.

func Delete

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

Delete removes a domain.

func List

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

List returns a list of domains.

func Update

func Update(ctx context.Context, id string, params *UpdateParams) (*clerk.Domain, error)

Update updates a domain's properties.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Domains API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates a new domain.

func (*Client) Delete

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

Delete removes a domain.

func (*Client) List

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

List returns a list of domains.

func (*Client) Update

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

Update updates a domain's properties.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	Name        *string `json:"name,omitempty"`
	ProxyURL    *string `json:"proxy_url,omitempty"`
	IsSatellite *bool   `json:"is_satellite,omitempty"`
}

type ListParams

type ListParams struct {
	clerk.APIParams
}

type UpdateParams

type UpdateParams struct {
	clerk.APIParams
	Name     *string `json:"name,omitempty"`
	ProxyURL *string `json:"proxy_url,omitempty"`
}