test_users

Documentation

Overview

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

This is an autogenerated file. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchTestUsersResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchTestUsersResponse, error)
  • func (c Client) Update(input *UpdateTestUsersInput) (*UpdateTestUsersResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateTestUsersInput) (*UpdateTestUsersResponse, error)
• type ClientProperties
• type FetchTestUsersResponse
• type UpdateTestUsersInput
• type UpdateTestUsersResponse

Types

type Client

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

Client for managing test users resources See https://www.twilio.com/docs/studio/rest-api/v2/test-user for more details

func New

func New(client *client.Client, properties ClientProperties) *Client

New creates a new instance of the test users client

func (Client) Fetch

func (c Client) Fetch() (*FetchTestUsersResponse, error)

Fetch retrieves a test users resource See https://www.twilio.com/docs/studio/rest-api/v2/test-user#fetch-a-testuser-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) FetchWithContext

func (c Client) FetchWithContext(context context.Context) (*FetchTestUsersResponse, error)

FetchWithContext retrieves a test users resource See https://www.twilio.com/docs/studio/rest-api/v2/test-user#fetch-a-testuser-resource for more details

func (Client) Update

func (c Client) Update(input *UpdateTestUsersInput) (*UpdateTestUsersResponse, error)

Update modifies a test users resource See https://www.twilio.com/docs/studio/rest-api/v2/test-user#update-a-testuser-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateTestUsersInput) (*UpdateTestUsersResponse, error)

UpdateWithContext modifies a test users resource See https://www.twilio.com/docs/studio/rest-api/v2/test-user#update-a-testuser-resource for more details

type ClientProperties

type ClientProperties struct {
	FlowSid string
}

ClientProperties are the properties required to manage the test users resources

type FetchTestUsersResponse

type FetchTestUsersResponse struct {
	Sid       string   `json:"sid"`
	TestUsers []string `json:"test_users"`
	URL       string   `json:"url"`
}

FetchTestUsersResponse defines the response fields for the retrieved test users

type UpdateTestUsersInput

type UpdateTestUsersInput struct {
	TestUsers []string `validate:"required" form:"TestUsers"`
}

UpdateTestUsersInput defines input fields for updating a test users resource

type UpdateTestUsersResponse

type UpdateTestUsersResponse struct {
	Sid       string   `json:"sid"`
	TestUsers []string `json:"test_users"`
	URL       string   `json:"url"`
}

UpdateTestUsersResponse defines the response fields for the updated test users