bot_users

Documentation

Index

• type Client
  • func NewClient(cfg *ngrok.ClientConfig) *Client
  • func (c *Client) Create(ctx context.Context, arg *ngrok.BotUserCreate) (*ngrok.BotUser, error)
  • func (c *Client) Delete(ctx context.Context, id string) error
  • func (c *Client) Get(ctx context.Context, id string) (*ngrok.BotUser, error)
  • func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.BotUser]
  • func (c *Client) Update(ctx context.Context, arg *ngrok.BotUserUpdate) (*ngrok.BotUser, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

func NewClient

func NewClient(cfg *ngrok.ClientConfig) *Client

func (*Client) Create

func (c *Client) Create(ctx context.Context, arg *ngrok.BotUserCreate) (*ngrok.BotUser, error)

Create a new bot user

https://ngrok.com/docs/api#api-bot-users-create

func (*Client) Delete

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

Delete a bot user by ID

https://ngrok.com/docs/api#api-bot-users-delete

func (*Client) Get

func (c *Client) Get(ctx context.Context, id string) (*ngrok.BotUser, error)

Get the details of a Bot User by ID.

https://ngrok.com/docs/api#api-bot-users-get

func (*Client) List

func (c *Client) List(paging *ngrok.Paging) ngrok.Iter[*ngrok.BotUser]

List all bot users in this account.

https://ngrok.com/docs/api#api-bot-users-list

func (*Client) Update

func (c *Client) Update(ctx context.Context, arg *ngrok.BotUserUpdate) (*ngrok.BotUser, error)

Update attributes of a bot user by ID.

https://ngrok.com/docs/api#api-bot-users-update