blocklistidentifier

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 blocklistidentifier provides the Blocklist Identifiers API.

Index

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

Functions

func Create

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

Create adds a new identifier to the blocklist.

func Delete

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

Delete removes an identifier from the blocklist.

func List

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

List returns all the identifiers in the blocklist.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Blocklist Identifiers API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create adds a new identifier to the blocklist.

func (*Client) Delete

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

Delete removes an identifier from the blocklist.

func (*Client) List

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

List returns all the identifiers in the blocklist.

type CreateParams

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

type ListParams

type ListParams struct {
	clerk.APIParams
}