verification

Documentation

Overview

Package verification contains auto-generated files. DO NOT MODIFY

Package verification contains auto-generated files. DO NOT MODIFY

Package verification contains auto-generated files. DO NOT MODIFY

Index

• type Client
  • func New(client *client.Client, properties ClientProperties) *Client
  • func (c Client) Fetch() (*FetchVerificationResponse, error)
  • func (c Client) FetchWithContext(context context.Context) (*FetchVerificationResponse, error)
  • func (c Client) Update(input *UpdateVerificationInput) (*UpdateVerificationResponse, error)
  • func (c Client) UpdateWithContext(context context.Context, input *UpdateVerificationInput) (*UpdateVerificationResponse, error)
• type ClientProperties
• type FetchVerificationCarrierLookupResponse
• type FetchVerificationLookupResponse
• type FetchVerificationResponse
• type FetchVerificationSendCodeAttemptResponse
• type UpdateVerificationCarrierLookupResponse
• type UpdateVerificationInput
• type UpdateVerificationLookupResponse
• type UpdateVerificationResponse
• type UpdateVerificationSendCodeAttemptResponse

Types

type Client

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

Client for managing a specific verification resource See https://www.twilio.com/docs/verify/api/verification for more details

func New

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

New creates a new instance of the verification client

func (Client) Fetch

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

Fetch retrieves a verification resource See https://www.twilio.com/docs/verify/api/verification#fetch-a-verification 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) (*FetchVerificationResponse, error)

FetchWithContext retrieves a verification resource See https://www.twilio.com/docs/verify/api/verification#fetch-a-verification for more details

func (Client) Update

func (c Client) Update(input *UpdateVerificationInput) (*UpdateVerificationResponse, error)

Update modifies a verification resource See https://www.twilio.com/docs/verify/api/verification#update-a-verification-status 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 *UpdateVerificationInput) (*UpdateVerificationResponse, error)

UpdateWithContext modifies a verification resource See https://www.twilio.com/docs/verify/api/verification#update-a-verification-status for more details

type ClientProperties

type ClientProperties struct {
	ServiceSid string
	Sid        string
}

ClientProperties are the properties required to manage the verification resources

type FetchVerificationCarrierLookupResponse

type FetchVerificationCarrierLookupResponse struct {
	ErrorCode         *string `json:"error_code,omitempty"`
	MobileCountryCode *string `json:"mobile_country_code,omitempty"`
	MobileNetworkCode *string `json:"mobile_network_code,omitempty"`
	Name              *string `json:"name,omitempty"`
	Type              *string `json:"type,omitempty"`
}

type FetchVerificationLookupResponse

type FetchVerificationLookupResponse struct {
	Carrier *FetchVerificationCarrierLookupResponse `json:"carrier,omitempty"`
}

type FetchVerificationResponse

type FetchVerificationResponse struct {
	AccountSid       string                                     `json:"account_sid"`
	Amount           *string                                    `json:"amount,omitempty"`
	Channel          string                                     `json:"channel"`
	DateCreated      time.Time                                  `json:"date_created"`
	DateUpdated      *time.Time                                 `json:"date_updated,omitempty"`
	Lookup           FetchVerificationLookupResponse            `json:"lookup"`
	Payee            *string                                    `json:"payee,omitempty"`
	SendCodeAttempts []FetchVerificationSendCodeAttemptResponse `json:"send_code_attempts"`
	ServiceSid       string                                     `json:"service_sid"`
	Sid              string                                     `json:"sid"`
	Status           string                                     `json:"status"`
	To               string                                     `json:"to"`
	URL              string                                     `json:"url"`
	Valid            bool                                       `json:"valid"`
}

FetchVerificationResponse defines the response fields for the retrieved verification

type FetchVerificationSendCodeAttemptResponse

type FetchVerificationSendCodeAttemptResponse struct {
	Channel   string    `json:"channel"`
	ChannelId *string   `json:"channel_id,omitempty"`
	Time      time.Time `json:"time"`
}

type UpdateVerificationCarrierLookupResponse

type UpdateVerificationCarrierLookupResponse struct {
	ErrorCode         *string `json:"error_code,omitempty"`
	MobileCountryCode *string `json:"mobile_country_code,omitempty"`
	MobileNetworkCode *string `json:"mobile_network_code,omitempty"`
	Name              *string `json:"name,omitempty"`
	Type              *string `json:"type,omitempty"`
}

type UpdateVerificationInput

type UpdateVerificationInput struct {
	Status string `validate:"required" form:"Status"`
}

UpdateVerificationInput defines input fields for updating a verification resource

type UpdateVerificationLookupResponse

type UpdateVerificationLookupResponse struct {
	Carrier *UpdateVerificationCarrierLookupResponse `json:"carrier,omitempty"`
}

type UpdateVerificationResponse

type UpdateVerificationResponse struct {
	AccountSid       string                                      `json:"account_sid"`
	Amount           *string                                     `json:"amount,omitempty"`
	Channel          string                                      `json:"channel"`
	DateCreated      time.Time                                   `json:"date_created"`
	DateUpdated      *time.Time                                  `json:"date_updated,omitempty"`
	Lookup           UpdateVerificationLookupResponse            `json:"lookup"`
	Payee            *string                                     `json:"payee,omitempty"`
	SendCodeAttempts []UpdateVerificationSendCodeAttemptResponse `json:"send_code_attempts"`
	ServiceSid       string                                      `json:"service_sid"`
	Sid              string                                      `json:"sid"`
	Status           string                                      `json:"status"`
	To               string                                      `json:"to"`
	URL              string                                      `json:"url"`
	Valid            bool                                        `json:"valid"`
}

UpdateVerificationResponse defines the response fields for the updated verification

type UpdateVerificationSendCodeAttemptResponse

type UpdateVerificationSendCodeAttemptResponse struct {
	Channel   string    `json:"channel"`
	ChannelId *string   `json:"channel_id,omitempty"`
	Time      time.Time `json:"time"`
}