challenge

Documentation

Overview

Package challenge contains auto-generated files. DO NOT MODIFY

Package challenge contains auto-generated files. DO NOT MODIFY

Package challenge contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchChallengeResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchChallengeResponse, error)
  • func (c Client) Update(input *UpdateChallengeInput) (*UpdateChallengeResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateChallengeInput) (*UpdateChallengeResponse, error)
• type ClientProperties
• type FetchChallengeDetailsResponse
• type FetchChallengeResponse
• type UpdateChallengeDetailsResponse
• type UpdateChallengeInput
• type UpdateChallengeResponse

Types

type Client

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

Client for managing a specific challenge resource See https://www.twilio.com/docs/verify/api/challenge for more details This client is currently in beta and subject to change. Please use with caution

func New

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

New creates a new instance of the challenge client

func (Client) Fetch

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

Fetch retrieves a challenge resource See https://www.twilio.com/docs/verify/api/challenge#fetch-a-challenge-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) FetchWithContext

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

FetchWithContext retrieves a challenge resource See https://www.twilio.com/docs/verify/api/challenge#fetch-a-challenge-resource for more details This resource is currently in beta and subject to change. Please use with caution

func (Client) Update

func (c Client) Update(input *UpdateChallengeInput) (*UpdateChallengeResponse, error)

Update modifies a challenge resource See https://www.twilio.com/docs/verify/api/challenge#update-a-challenge-resource for more details Context is defaulted to Background. See https://golang.org/pkg/context/#Background for more information This resource is currently in beta and subject to change. Please use with caution

func (Client) UpdateWithContext

func (c Client) UpdateWithContext(context context.Context, input *UpdateChallengeInput) (*UpdateChallengeResponse, error)

UpdateWithContext modifies a challenge resource See https://www.twilio.com/docs/verify/api/challenge#update-a-challenge-resource for more details This resource is currently in beta and subject to change. Please use with caution

type ClientProperties

type ClientProperties struct {
	Identity   string
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the challenge resources

type FetchChallengeDetailsResponse

type FetchChallengeDetailsResponse struct {
	Date    *time.Time     `json:"date,omitempty"`
	Fields  *[]interface{} `json:"fields,omitempty"`
	Message *string        `json:"message,omitempty"`
}

type FetchChallengeResponse

type FetchChallengeResponse struct {
	AccountSid      string                         `json:"account_sid"`
	DateCreated     time.Time                      `json:"date_created"`
	DateResponded   *time.Time                     `json:"date_responded,omitempty"`
	DateUpdated     *time.Time                     `json:"date_updated,omitempty"`
	Details         *FetchChallengeDetailsResponse `json:"details,omitempty"`
	EntitySid       string                         `json:"entity_sid"`
	ExpirationDate  time.Time                      `json:"expiration_date"`
	FactorSid       string                         `json:"factor_sid"`
	FactorType      string                         `json:"factor_type"`
	HiddenDetails   *map[string]interface{}        `json:"hidden_details,omitempty"`
	Identity        string                         `json:"identity"`
	RespondedReason *string                        `json:"responded_reason,omitempty"`
	ServiceSid      string                         `json:"service_sid"`
	Sid             string                         `json:"sid"`
	Status          string                         `json:"status"`
	URL             string                         `json:"url"`
}

FetchChallengeResponse defines the response fields for the retrieved challenge

type UpdateChallengeDetailsResponse

type UpdateChallengeDetailsResponse struct {
	Date    *time.Time     `json:"date,omitempty"`
	Fields  *[]interface{} `json:"fields,omitempty"`
	Message *string        `json:"message,omitempty"`
}

type UpdateChallengeInput

type UpdateChallengeInput struct {
	AuthPayload *string `form:"AuthPayload,omitempty"`
}

UpdateChallengeInput defines input fields for updating a challenge resource

type UpdateChallengeResponse

type UpdateChallengeResponse struct {
	AccountSid      string                          `json:"account_sid"`
	DateCreated     time.Time                       `json:"date_created"`
	DateResponded   *time.Time                      `json:"date_responded,omitempty"`
	DateUpdated     *time.Time                      `json:"date_updated,omitempty"`
	Details         *UpdateChallengeDetailsResponse `json:"details,omitempty"`
	EntitySid       string                          `json:"entity_sid"`
	ExpirationDate  time.Time                       `json:"expiration_date"`
	FactorSid       string                          `json:"factor_sid"`
	FactorType      string                          `json:"factor_type"`
	HiddenDetails   *map[string]interface{}         `json:"hidden_details,omitempty"`
	Identity        string                          `json:"identity"`
	RespondedReason *string                         `json:"responded_reason,omitempty"`
	ServiceSid      string                          `json:"service_sid"`
	Sid             string                          `json:"sid"`
	Status          string                          `json:"status"`
	URL             string                          `json:"url"`
}

UpdateChallengeResponse defines the response fields for the updated challenge