allowlistidentifier

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 allowlistidentifier provides the Allowlist Identifiers API.

Index

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

Functions

func Create

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

Create adds a new identifier to the allowlist.

func Delete

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

Delete removes an identifier from the allowlist.

func List

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

List returns all the identifiers in the allowlist.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Allowlist Identifiers API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create adds a new identifier to the allowlist.

func (*Client) Delete

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

Delete removes an identifier from the allowlist.

func (*Client) List

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

List returns all the identifiers in the allowlist.

type CreateParams

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

type ListParams

type ListParams struct {
	clerk.APIParams
}