domain

Documentation

Overview

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