phonenumber

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 phonenumber provides the Phone Numbers API.

Index

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

Functions

func Create

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

Create creates a new phone number.

func Delete

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

Delete deletes a phone number.

func Get

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

Get retrieves a phone number.

func Update

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

Update updates the phone number specified by id.

Types

type Client

type Client struct {
	Backend clerk.Backend
}

Client is used to invoke the Phone Numbers API.

func NewClient

func NewClient(config *clerk.ClientConfig) *Client

func (*Client) Create

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

Create creates a new phone number.

func (*Client) Delete

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

Delete deletes a phone number.

func (*Client) Get

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

Get retrieves a phone number.

func (*Client) Update

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

Update updates the phone number specified by id.

type CreateParams

type CreateParams struct {
	clerk.APIParams
	UserID      *string `json:"user_id,omitempty"`
	PhoneNumber *string `json:"phone_number,omitempty"`
	Verified    *bool   `json:"verified,omitempty"`
	Primary     *bool   `json:"primary,omitempty"`
}

type UpdateParams

type UpdateParams struct {
	clerk.APIParams
	Verified *bool `json:"verified,omitempty"`
	Primary  *bool `json:"primary,omitempty"`
}