openapi

package
v1.23.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2024 License: MIT Imports: 6 Imported by: 82

README

Go API client for openapi

This is the public Twilio REST API.

Overview

This API client was generated by the OpenAPI Generator project from the OpenAPI specs located at twilio/twilio-oai. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: com.twilio.oai.TwilioGoGenerator For more information, please visit https://support.twilio.com

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import "./openapi"

Documentation for API Endpoints

All URIs are relative to https://verify.twilio.com

Class Method HTTP request Description
AttemptsApi FetchVerificationAttempt Get /v2/Attempts/{Sid}
AttemptsApi ListVerificationAttempt Get /v2/Attempts
AttemptsSummaryApi FetchVerificationAttemptsSummary Get /v2/Attempts/Summary
FormsApi FetchForm Get /v2/Forms/{FormType}
SafeListNumbersApi CreateSafelist Post /v2/SafeList/Numbers
SafeListNumbersApi DeleteSafelist Delete /v2/SafeList/Numbers/{PhoneNumber}
SafeListNumbersApi FetchSafelist Get /v2/SafeList/Numbers/{PhoneNumber}
ServicesApi CreateService Post /v2/Services
ServicesApi DeleteService Delete /v2/Services/{Sid}
ServicesApi FetchService Get /v2/Services/{Sid}
ServicesApi ListService Get /v2/Services
ServicesApi UpdateService Post /v2/Services/{Sid}
ServicesAccessTokensApi CreateAccessToken Post /v2/Services/{ServiceSid}/AccessTokens
ServicesAccessTokensApi FetchAccessToken Get /v2/Services/{ServiceSid}/AccessTokens/{Sid}
ServicesEntitiesApi CreateEntity Post /v2/Services/{ServiceSid}/Entities
ServicesEntitiesApi DeleteEntity Delete /v2/Services/{ServiceSid}/Entities/{Identity}
ServicesEntitiesApi FetchEntity Get /v2/Services/{ServiceSid}/Entities/{Identity}
ServicesEntitiesApi ListEntity Get /v2/Services/{ServiceSid}/Entities
ServicesEntitiesChallengesApi CreateChallenge Post /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
ServicesEntitiesChallengesApi FetchChallenge Get /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
ServicesEntitiesChallengesApi ListChallenge Get /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges
ServicesEntitiesChallengesApi UpdateChallenge Post /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{Sid}
ServicesEntitiesChallengesNotificationsApi CreateNotification Post /v2/Services/{ServiceSid}/Entities/{Identity}/Challenges/{ChallengeSid}/Notifications
ServicesEntitiesFactorsApi CreateNewFactor Post /v2/Services/{ServiceSid}/Entities/{Identity}/Factors
ServicesEntitiesFactorsApi DeleteFactor Delete /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
ServicesEntitiesFactorsApi FetchFactor Get /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
ServicesEntitiesFactorsApi ListFactor Get /v2/Services/{ServiceSid}/Entities/{Identity}/Factors
ServicesEntitiesFactorsApi UpdateFactor Post /v2/Services/{ServiceSid}/Entities/{Identity}/Factors/{Sid}
ServicesMessagingConfigurationsApi CreateMessagingConfiguration Post /v2/Services/{ServiceSid}/MessagingConfigurations
ServicesMessagingConfigurationsApi DeleteMessagingConfiguration Delete /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}
ServicesMessagingConfigurationsApi FetchMessagingConfiguration Get /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}
ServicesMessagingConfigurationsApi ListMessagingConfiguration Get /v2/Services/{ServiceSid}/MessagingConfigurations
ServicesMessagingConfigurationsApi UpdateMessagingConfiguration Post /v2/Services/{ServiceSid}/MessagingConfigurations/{Country}
ServicesRateLimitsApi CreateRateLimit Post /v2/Services/{ServiceSid}/RateLimits
ServicesRateLimitsApi DeleteRateLimit Delete /v2/Services/{ServiceSid}/RateLimits/{Sid}
ServicesRateLimitsApi FetchRateLimit Get /v2/Services/{ServiceSid}/RateLimits/{Sid}
ServicesRateLimitsApi ListRateLimit Get /v2/Services/{ServiceSid}/RateLimits
ServicesRateLimitsApi UpdateRateLimit Post /v2/Services/{ServiceSid}/RateLimits/{Sid}
ServicesRateLimitsBucketsApi CreateBucket Post /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets
ServicesRateLimitsBucketsApi DeleteBucket Delete /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}
ServicesRateLimitsBucketsApi FetchBucket Get /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}
ServicesRateLimitsBucketsApi ListBucket Get /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets
ServicesRateLimitsBucketsApi UpdateBucket Post /v2/Services/{ServiceSid}/RateLimits/{RateLimitSid}/Buckets/{Sid}
ServicesVerificationCheckApi CreateVerificationCheck Post /v2/Services/{ServiceSid}/VerificationCheck
ServicesVerificationsApi CreateVerification Post /v2/Services/{ServiceSid}/Verifications
ServicesVerificationsApi FetchVerification Get /v2/Services/{ServiceSid}/Verifications/{Sid}
ServicesVerificationsApi UpdateVerification Post /v2/Services/{ServiceSid}/Verifications/{Sid}
ServicesWebhooksApi CreateWebhook Post /v2/Services/{ServiceSid}/Webhooks
ServicesWebhooksApi DeleteWebhook Delete /v2/Services/{ServiceSid}/Webhooks/{Sid}
ServicesWebhooksApi FetchWebhook Get /v2/Services/{ServiceSid}/Webhooks/{Sid}
ServicesWebhooksApi ListWebhook Get /v2/Services/{ServiceSid}/Webhooks
ServicesWebhooksApi UpdateWebhook Post /v2/Services/{ServiceSid}/Webhooks/{Sid}
TemplatesApi ListVerificationTemplate Get /v2/Templates

Documentation For Models

Documentation For Authorization

accountSid_authToken

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ApiService added in v0.11.0 

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

func NewApiService added in v0.11.0 

func NewApiService(requestHandler *twilio.RequestHandler) *ApiService

func NewApiServiceWithClient added in v0.11.0 

func NewApiServiceWithClient(client twilio.BaseClient) *ApiService

func (*ApiService) CreateAccessToken added in v0.11.0 

func (c *ApiService) CreateAccessToken(ServiceSid string, params *CreateAccessTokenParams) (*VerifyV2AccessToken, error)

Create a new enrollment Access Token for the Entity

func (*ApiService) CreateBucket added in v0.11.0 

func (c *ApiService) CreateBucket(ServiceSid string, RateLimitSid string, params *CreateBucketParams) (*VerifyV2Bucket, error)

Create a new Bucket for a Rate Limit

func (*ApiService) CreateChallenge added in v0.11.0 

func (c *ApiService) CreateChallenge(ServiceSid string, Identity string, params *CreateChallengeParams) (*VerifyV2Challenge, error)

Create a new Challenge for the Factor

func (*ApiService) CreateEntity added in v0.11.0 

func (c *ApiService) CreateEntity(ServiceSid string, params *CreateEntityParams) (*VerifyV2Entity, error)

Create a new Entity for the Service

func (*ApiService) CreateMessagingConfiguration added in v0.11.0 

func (c *ApiService) CreateMessagingConfiguration(ServiceSid string, params *CreateMessagingConfigurationParams) (*VerifyV2MessagingConfiguration, error)

Create a new MessagingConfiguration for a service.

func (*ApiService) CreateNewFactor added in v0.11.0 

func (c *ApiService) CreateNewFactor(ServiceSid string, Identity string, params *CreateNewFactorParams) (*VerifyV2NewFactor, error)

Create a new Factor for the Entity

func (*ApiService) CreateNotification added in v0.11.0 

func (c *ApiService) CreateNotification(ServiceSid string, Identity string, ChallengeSid string, params *CreateNotificationParams) (*VerifyV2Notification, error)

Create a new Notification for the corresponding Challenge

func (*ApiService) CreateRateLimit added in v0.11.0 

func (c *ApiService) CreateRateLimit(ServiceSid string, params *CreateRateLimitParams) (*VerifyV2RateLimit, error)

Create a new Rate Limit for a Service

func (*ApiService) CreateSafelist added in v1.0.0 

func (c *ApiService) CreateSafelist(params *CreateSafelistParams) (*VerifyV2Safelist, error)

Add a new phone number to SafeList.

func (*ApiService) CreateService added in v0.11.0 

func (c *ApiService) CreateService(params *CreateServiceParams) (*VerifyV2Service, error)

Create a new Verification Service.

func (*ApiService) CreateVerification added in v0.11.0 

func (c *ApiService) CreateVerification(ServiceSid string, params *CreateVerificationParams) (*VerifyV2Verification, error)

Create a new Verification using a Service

func (*ApiService) CreateVerificationCheck added in v0.11.0 

func (c *ApiService) CreateVerificationCheck(ServiceSid string, params *CreateVerificationCheckParams) (*VerifyV2VerificationCheck, error)

challenge a specific Verification Check.

func (*ApiService) CreateWebhook added in v0.11.0 

func (c *ApiService) CreateWebhook(ServiceSid string, params *CreateWebhookParams) (*VerifyV2Webhook, error)

Create a new Webhook for the Service

func (*ApiService) DeleteBucket added in v0.11.0 

func (c *ApiService) DeleteBucket(ServiceSid string, RateLimitSid string, Sid string) error

Delete a specific Bucket.

func (*ApiService) DeleteEntity added in v0.11.0 

func (c *ApiService) DeleteEntity(ServiceSid string, Identity string) error

Delete a specific Entity.

func (*ApiService) DeleteFactor added in v0.11.0 

func (c *ApiService) DeleteFactor(ServiceSid string, Identity string, Sid string) error

Delete a specific Factor.

func (*ApiService) DeleteMessagingConfiguration added in v0.11.0 

func (c *ApiService) DeleteMessagingConfiguration(ServiceSid string, Country string) error

Delete a specific MessagingConfiguration.

func (*ApiService) DeleteRateLimit added in v0.11.0 

func (c *ApiService) DeleteRateLimit(ServiceSid string, Sid string) error

Delete a specific Rate Limit.

func (*ApiService) DeleteSafelist added in v1.0.0 

func (c *ApiService) DeleteSafelist(PhoneNumber string) error

Remove a phone number from SafeList.

func (*ApiService) DeleteService added in v0.11.0 

func (c *ApiService) DeleteService(Sid string) error

Delete a specific Verification Service Instance.

func (*ApiService) DeleteWebhook added in v0.11.0 

func (c *ApiService) DeleteWebhook(ServiceSid string, Sid string) error

Delete a specific Webhook.

func (*ApiService) FetchAccessToken added in v0.20.1 

func (c *ApiService) FetchAccessToken(ServiceSid string, Sid string) (*VerifyV2AccessToken, error)

Fetch an Access Token for the Entity

func (*ApiService) FetchBucket added in v0.11.0 

func (c *ApiService) FetchBucket(ServiceSid string, RateLimitSid string, Sid string) (*VerifyV2Bucket, error)

Fetch a specific Bucket.

func (*ApiService) FetchChallenge added in v0.11.0 

func (c *ApiService) FetchChallenge(ServiceSid string, Identity string, Sid string) (*VerifyV2Challenge, error)

Fetch a specific Challenge.

func (*ApiService) FetchEntity added in v0.11.0 

func (c *ApiService) FetchEntity(ServiceSid string, Identity string) (*VerifyV2Entity, error)

Fetch a specific Entity.

func (*ApiService) FetchFactor added in v0.11.0 

func (c *ApiService) FetchFactor(ServiceSid string, Identity string, Sid string) (*VerifyV2Factor, error)

Fetch a specific Factor.

func (*ApiService) FetchForm added in v0.11.0 

func (c *ApiService) FetchForm(FormType string) (*VerifyV2Form, error)

Fetch the forms for a specific Form Type.

func (*ApiService) FetchMessagingConfiguration added in v0.11.0 

func (c *ApiService) FetchMessagingConfiguration(ServiceSid string, Country string) (*VerifyV2MessagingConfiguration, error)

Fetch a specific MessagingConfiguration.

func (*ApiService) FetchRateLimit added in v0.11.0 

func (c *ApiService) FetchRateLimit(ServiceSid string, Sid string) (*VerifyV2RateLimit, error)

Fetch a specific Rate Limit.

func (*ApiService) FetchSafelist added in v1.0.0 

func (c *ApiService) FetchSafelist(PhoneNumber string) (*VerifyV2Safelist, error)

Check if a phone number exists in SafeList.

func (*ApiService) FetchService added in v0.11.0 

func (c *ApiService) FetchService(Sid string) (*VerifyV2Service, error)

Fetch specific Verification Service Instance.

func (*ApiService) FetchVerification added in v0.11.0 

func (c *ApiService) FetchVerification(ServiceSid string, Sid string) (*VerifyV2Verification, error)

Fetch a specific Verification

func (*ApiService) FetchVerificationAttempt added in v0.11.0 

func (c *ApiService) FetchVerificationAttempt(Sid string) (*VerifyV2VerificationAttempt, error)

Fetch a specific verification attempt.

func (*ApiService) FetchVerificationAttemptsSummary added in v0.24.0 

func (c *ApiService) FetchVerificationAttemptsSummary(params *FetchVerificationAttemptsSummaryParams) (*VerifyV2VerificationAttemptsSummary, error)

Get a summary of how many attempts were made and how many were converted.

func (*ApiService) FetchWebhook added in v0.11.0 

func (c *ApiService) FetchWebhook(ServiceSid string, Sid string) (*VerifyV2Webhook, error)

Fetch a specific Webhook.

func (*ApiService) ListBucket added in v0.11.0 

func (c *ApiService) ListBucket(ServiceSid string, RateLimitSid string, params *ListBucketParams) ([]VerifyV2Bucket, error)

Lists Bucket records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListChallenge added in v0.11.0 

func (c *ApiService) ListChallenge(ServiceSid string, Identity string, params *ListChallengeParams) ([]VerifyV2Challenge, error)

Lists Challenge records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListEntity added in v0.11.0 

func (c *ApiService) ListEntity(ServiceSid string, params *ListEntityParams) ([]VerifyV2Entity, error)

Lists Entity records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListFactor added in v0.11.0 

func (c *ApiService) ListFactor(ServiceSid string, Identity string, params *ListFactorParams) ([]VerifyV2Factor, error)

Lists Factor records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListMessagingConfiguration added in v0.11.0 

func (c *ApiService) ListMessagingConfiguration(ServiceSid string, params *ListMessagingConfigurationParams) ([]VerifyV2MessagingConfiguration, error)

Lists MessagingConfiguration records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListRateLimit added in v0.11.0 

func (c *ApiService) ListRateLimit(ServiceSid string, params *ListRateLimitParams) ([]VerifyV2RateLimit, error)

Lists RateLimit records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListService added in v0.11.0 

func (c *ApiService) ListService(params *ListServiceParams) ([]VerifyV2Service, error)

Lists Service records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListVerificationAttempt added in v0.11.0 

func (c *ApiService) ListVerificationAttempt(params *ListVerificationAttemptParams) ([]VerifyV2VerificationAttempt, error)

Lists VerificationAttempt records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListVerificationTemplate added in v0.14.2 

func (c *ApiService) ListVerificationTemplate(params *ListVerificationTemplateParams) ([]VerifyV2VerificationTemplate, error)

Lists VerificationTemplate records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) ListWebhook added in v0.11.0 

func (c *ApiService) ListWebhook(ServiceSid string, params *ListWebhookParams) ([]VerifyV2Webhook, error)

Lists Webhook records from the API as a list. Unlike stream, this operation is eager and loads 'limit' records into memory before returning.

func (*ApiService) PageBucket added in v0.13.0 

func (c *ApiService) PageBucket(ServiceSid string, RateLimitSid string, params *ListBucketParams, pageToken, pageNumber string) (*ListBucketResponse, error)

Retrieve a single page of Bucket records from the API. Request is executed immediately.

func (*ApiService) PageChallenge added in v0.13.0 

func (c *ApiService) PageChallenge(ServiceSid string, Identity string, params *ListChallengeParams, pageToken, pageNumber string) (*ListChallengeResponse, error)

Retrieve a single page of Challenge records from the API. Request is executed immediately.

func (*ApiService) PageEntity added in v0.13.0 

func (c *ApiService) PageEntity(ServiceSid string, params *ListEntityParams, pageToken, pageNumber string) (*ListEntityResponse, error)

Retrieve a single page of Entity records from the API. Request is executed immediately.

func (*ApiService) PageFactor added in v0.13.0 

func (c *ApiService) PageFactor(ServiceSid string, Identity string, params *ListFactorParams, pageToken, pageNumber string) (*ListFactorResponse, error)

Retrieve a single page of Factor records from the API. Request is executed immediately.

func (*ApiService) PageMessagingConfiguration added in v0.13.0 

func (c *ApiService) PageMessagingConfiguration(ServiceSid string, params *ListMessagingConfigurationParams, pageToken, pageNumber string) (*ListMessagingConfigurationResponse, error)

Retrieve a single page of MessagingConfiguration records from the API. Request is executed immediately.

func (*ApiService) PageRateLimit added in v0.13.0 

func (c *ApiService) PageRateLimit(ServiceSid string, params *ListRateLimitParams, pageToken, pageNumber string) (*ListRateLimitResponse, error)

Retrieve a single page of RateLimit records from the API. Request is executed immediately.

func (*ApiService) PageService added in v0.13.0 

func (c *ApiService) PageService(params *ListServiceParams, pageToken, pageNumber string) (*ListServiceResponse, error)

Retrieve a single page of Service records from the API. Request is executed immediately.

func (*ApiService) PageVerificationAttempt added in v0.13.0 

func (c *ApiService) PageVerificationAttempt(params *ListVerificationAttemptParams, pageToken, pageNumber string) (*ListVerificationAttemptResponse, error)

Retrieve a single page of VerificationAttempt records from the API. Request is executed immediately.

func (*ApiService) PageVerificationTemplate added in v0.14.2 

func (c *ApiService) PageVerificationTemplate(params *ListVerificationTemplateParams, pageToken, pageNumber string) (*ListVerificationTemplateResponse, error)

Retrieve a single page of VerificationTemplate records from the API. Request is executed immediately.

func (*ApiService) PageWebhook added in v0.13.0 

func (c *ApiService) PageWebhook(ServiceSid string, params *ListWebhookParams, pageToken, pageNumber string) (*ListWebhookResponse, error)

Retrieve a single page of Webhook records from the API. Request is executed immediately.

func (*ApiService) StreamBucket added in v0.13.0 

func (c *ApiService) StreamBucket(ServiceSid string, RateLimitSid string, params *ListBucketParams) (chan VerifyV2Bucket, chan error)

Streams Bucket records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamChallenge added in v0.13.0 

func (c *ApiService) StreamChallenge(ServiceSid string, Identity string, params *ListChallengeParams) (chan VerifyV2Challenge, chan error)

Streams Challenge records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamEntity added in v0.13.0 

func (c *ApiService) StreamEntity(ServiceSid string, params *ListEntityParams) (chan VerifyV2Entity, chan error)

Streams Entity records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamFactor added in v0.13.0 

func (c *ApiService) StreamFactor(ServiceSid string, Identity string, params *ListFactorParams) (chan VerifyV2Factor, chan error)

Streams Factor records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamMessagingConfiguration added in v0.13.0 

func (c *ApiService) StreamMessagingConfiguration(ServiceSid string, params *ListMessagingConfigurationParams) (chan VerifyV2MessagingConfiguration, chan error)

Streams MessagingConfiguration records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamRateLimit added in v0.13.0 

func (c *ApiService) StreamRateLimit(ServiceSid string, params *ListRateLimitParams) (chan VerifyV2RateLimit, chan error)

Streams RateLimit records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamService added in v0.13.0 

func (c *ApiService) StreamService(params *ListServiceParams) (chan VerifyV2Service, chan error)

Streams Service records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamVerificationAttempt added in v0.13.0 

func (c *ApiService) StreamVerificationAttempt(params *ListVerificationAttemptParams) (chan VerifyV2VerificationAttempt, chan error)

Streams VerificationAttempt records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamVerificationTemplate added in v0.14.2 

func (c *ApiService) StreamVerificationTemplate(params *ListVerificationTemplateParams) (chan VerifyV2VerificationTemplate, chan error)

Streams VerificationTemplate records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) StreamWebhook added in v0.13.0 

func (c *ApiService) StreamWebhook(ServiceSid string, params *ListWebhookParams) (chan VerifyV2Webhook, chan error)

Streams Webhook records from the API as a channel stream. This operation lazily loads records as efficiently as possible until the limit is reached.

func (*ApiService) UpdateBucket added in v0.11.0 

func (c *ApiService) UpdateBucket(ServiceSid string, RateLimitSid string, Sid string, params *UpdateBucketParams) (*VerifyV2Bucket, error)

Update a specific Bucket.

func (*ApiService) UpdateChallenge added in v0.11.0 

func (c *ApiService) UpdateChallenge(ServiceSid string, Identity string, Sid string, params *UpdateChallengeParams) (*VerifyV2Challenge, error)

Verify a specific Challenge.

func (*ApiService) UpdateFactor added in v0.11.0 

func (c *ApiService) UpdateFactor(ServiceSid string, Identity string, Sid string, params *UpdateFactorParams) (*VerifyV2Factor, error)

Update a specific Factor. This endpoint can be used to Verify a Factor if passed an `AuthPayload` param.

func (*ApiService) UpdateMessagingConfiguration added in v0.11.0 

func (c *ApiService) UpdateMessagingConfiguration(ServiceSid string, Country string, params *UpdateMessagingConfigurationParams) (*VerifyV2MessagingConfiguration, error)

Update a specific MessagingConfiguration

func (*ApiService) UpdateRateLimit added in v0.11.0 

func (c *ApiService) UpdateRateLimit(ServiceSid string, Sid string, params *UpdateRateLimitParams) (*VerifyV2RateLimit, error)

Update a specific Rate Limit.

func (*ApiService) UpdateService added in v0.11.0 

func (c *ApiService) UpdateService(Sid string, params *UpdateServiceParams) (*VerifyV2Service, error)

Update a specific Verification Service.

func (*ApiService) UpdateVerification added in v0.11.0 

func (c *ApiService) UpdateVerification(ServiceSid string, Sid string, params *UpdateVerificationParams) (*VerifyV2Verification, error)

Update a Verification status

func (*ApiService) UpdateWebhook added in v0.11.0 

func (c *ApiService) UpdateWebhook(ServiceSid string, Sid string, params *UpdateWebhookParams) (*VerifyV2Webhook, error)

type CreateAccessTokenParams 

type CreateAccessTokenParams struct {
	// The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, and generated by your external system, such as your user's UUID, GUID, or SID.
	Identity *string `json:"Identity,omitempty"`
	//
	FactorType *string `json:"FactorType,omitempty"`
	// The friendly name of the factor that is going to be created with this access token
	FactorFriendlyName *string `json:"FactorFriendlyName,omitempty"`
	// How long, in seconds, the access token is valid. Can be an integer between 60 and 300. Default is 60.
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateAccessToken'

func (*CreateAccessTokenParams) SetFactorFriendlyName added in v0.18.2 

func (params *CreateAccessTokenParams) SetFactorFriendlyName(FactorFriendlyName string) *CreateAccessTokenParams

func (*CreateAccessTokenParams) SetFactorType 

func (params *CreateAccessTokenParams) SetFactorType(FactorType string) *CreateAccessTokenParams

func (*CreateAccessTokenParams) SetIdentity 

func (params *CreateAccessTokenParams) SetIdentity(Identity string) *CreateAccessTokenParams

func (*CreateAccessTokenParams) SetTtl added in v0.22.2 

func (params *CreateAccessTokenParams) SetTtl(Ttl int) *CreateAccessTokenParams

type CreateBucketParams 

type CreateBucketParams struct {
	// Maximum number of requests permitted in during the interval.
	Max *int `json:"Max,omitempty"`
	// Number of seconds that the rate limit will be enforced over.
	Interval *int `json:"Interval,omitempty"`
}

Optional parameters for the method 'CreateBucket'

func (*CreateBucketParams) SetInterval 

func (params *CreateBucketParams) SetInterval(Interval int) *CreateBucketParams

func (*CreateBucketParams) SetMax 

func (params *CreateBucketParams) SetMax(Max int) *CreateBucketParams

type CreateChallengeParams 

type CreateChallengeParams struct {
	// The unique SID identifier of the Factor.
	FactorSid *string `json:"FactorSid,omitempty"`
	// The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.
	ExpirationDate *time.Time `json:"ExpirationDate,omitempty"`
	// Shown to the user when the push notification arrives. Required when `factor_type` is `push`. Can be up to 256 characters in length
	DetailsMessage *string `json:"Details.Message,omitempty"`
	// A list of objects that describe the Fields included in the Challenge. Each object contains the label and value of the field, the label can be up to 36 characters in length and the value can be up to 128 characters in length. Used when `factor_type` is `push`. There can be up to 20 details fields.
	DetailsFields *[]interface{} `json:"Details.Fields,omitempty"`
	// Details provided to give context about the Challenge. Not shown to the end user. It must be a stringified JSON with only strings values eg. `{\\\"ip\\\": \\\"172.168.1.234\\\"}`. Can be up to 1024 characters in length
	HiddenDetails *interface{} `json:"HiddenDetails,omitempty"`
	// Optional payload used to verify the Challenge upon creation. Only used with a Factor of type `totp` to carry the TOTP code that needs to be verified. For `TOTP` this value must be between 3 and 8 characters long.
	AuthPayload *string `json:"AuthPayload,omitempty"`
}

Optional parameters for the method 'CreateChallenge'

func (*CreateChallengeParams) SetAuthPayload 

func (params *CreateChallengeParams) SetAuthPayload(AuthPayload string) *CreateChallengeParams

func (*CreateChallengeParams) SetDetailsFields 

func (params *CreateChallengeParams) SetDetailsFields(DetailsFields []interface{}) *CreateChallengeParams

func (*CreateChallengeParams) SetDetailsMessage 

func (params *CreateChallengeParams) SetDetailsMessage(DetailsMessage string) *CreateChallengeParams

func (*CreateChallengeParams) SetExpirationDate 

func (params *CreateChallengeParams) SetExpirationDate(ExpirationDate time.Time) *CreateChallengeParams

func (*CreateChallengeParams) SetFactorSid 

func (params *CreateChallengeParams) SetFactorSid(FactorSid string) *CreateChallengeParams

func (*CreateChallengeParams) SetHiddenDetails 

func (params *CreateChallengeParams) SetHiddenDetails(HiddenDetails interface{}) *CreateChallengeParams

type CreateEntityParams 

type CreateEntityParams struct {
	// The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"Identity,omitempty"`
}

Optional parameters for the method 'CreateEntity'

func (*CreateEntityParams) SetIdentity 

func (params *CreateEntityParams) SetIdentity(Identity string) *CreateEntityParams

type CreateMessagingConfigurationParams 

type CreateMessagingConfigurationParams struct {
	// The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
	Country *string `json:"Country,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
	MessagingServiceSid *string `json:"MessagingServiceSid,omitempty"`
}

Optional parameters for the method 'CreateMessagingConfiguration'

func (*CreateMessagingConfigurationParams) SetCountry 

func (params *CreateMessagingConfigurationParams) SetCountry(Country string) *CreateMessagingConfigurationParams

func (*CreateMessagingConfigurationParams) SetMessagingServiceSid 

func (params *CreateMessagingConfigurationParams) SetMessagingServiceSid(MessagingServiceSid string) *CreateMessagingConfigurationParams

type CreateNewFactorParams 

type CreateNewFactorParams struct {
	// The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For `factor_type` `push`, this could be a device name. For `factor_type` `totp`, this value is used as the “account name” in constructing the `binding.uri` property. At the same time, we recommend avoiding providing PII.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	//
	FactorType *string `json:"FactorType,omitempty"`
	// The algorithm used when `factor_type` is `push`. Algorithm supported: `ES256`
	BindingAlg *string `json:"Binding.Alg,omitempty"`
	// The Ecdsa public key in PKIX, ASN.1 DER format encoded in Base64.  Required when `factor_type` is `push`
	BindingPublicKey *string `json:"Binding.PublicKey,omitempty"`
	// The ID that uniquely identifies your app in the Google or Apple store, such as `com.example.myapp`. It can be up to 100 characters long.  Required when `factor_type` is `push`.
	ConfigAppId *string `json:"Config.AppId,omitempty"`
	//
	ConfigNotificationPlatform *string `json:"Config.NotificationPlatform,omitempty"`
	// For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Must be between 32 and 255 characters long.  Required when `factor_type` is `push`.
	ConfigNotificationToken *string `json:"Config.NotificationToken,omitempty"`
	// The Verify Push SDK version used to configure the factor  Required when `factor_type` is `push`
	ConfigSdkVersion *string `json:"Config.SdkVersion,omitempty"`
	// The shared secret for TOTP factors encoded in Base32. This can be provided when creating the Factor, otherwise it will be generated.  Used when `factor_type` is `totp`
	BindingSecret *string `json:"Binding.Secret,omitempty"`
	// Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. The default value is defined at the service level in the property `totp.time_step`. Defaults to 30 seconds if not configured.  Used when `factor_type` is `totp`
	ConfigTimeStep *int `json:"Config.TimeStep,omitempty"`
	// The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. The default value is defined at the service level in the property `totp.skew`. If not configured defaults to 1.  Used when `factor_type` is `totp`
	ConfigSkew *int `json:"Config.Skew,omitempty"`
	// Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. The default value is defined at the service level in the property `totp.code_length`. If not configured defaults to 6.  Used when `factor_type` is `totp`
	ConfigCodeLength *int `json:"Config.CodeLength,omitempty"`
	//
	ConfigAlg *string `json:"Config.Alg,omitempty"`
	// Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\\\"os\\\": \\\"Android\\\"}`. Can be up to 1024 characters in length.
	Metadata *interface{} `json:"Metadata,omitempty"`
}

Optional parameters for the method 'CreateNewFactor'

func (*CreateNewFactorParams) SetBindingAlg 

func (params *CreateNewFactorParams) SetBindingAlg(BindingAlg string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetBindingPublicKey 

func (params *CreateNewFactorParams) SetBindingPublicKey(BindingPublicKey string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetBindingSecret 

func (params *CreateNewFactorParams) SetBindingSecret(BindingSecret string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigAlg 

func (params *CreateNewFactorParams) SetConfigAlg(ConfigAlg string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigAppId 

func (params *CreateNewFactorParams) SetConfigAppId(ConfigAppId string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigCodeLength 

func (params *CreateNewFactorParams) SetConfigCodeLength(ConfigCodeLength int) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigNotificationPlatform 

func (params *CreateNewFactorParams) SetConfigNotificationPlatform(ConfigNotificationPlatform string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigNotificationToken 

func (params *CreateNewFactorParams) SetConfigNotificationToken(ConfigNotificationToken string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigSdkVersion 

func (params *CreateNewFactorParams) SetConfigSdkVersion(ConfigSdkVersion string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigSkew 

func (params *CreateNewFactorParams) SetConfigSkew(ConfigSkew int) *CreateNewFactorParams

func (*CreateNewFactorParams) SetConfigTimeStep 

func (params *CreateNewFactorParams) SetConfigTimeStep(ConfigTimeStep int) *CreateNewFactorParams

func (*CreateNewFactorParams) SetFactorType 

func (params *CreateNewFactorParams) SetFactorType(FactorType string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetFriendlyName 

func (params *CreateNewFactorParams) SetFriendlyName(FriendlyName string) *CreateNewFactorParams

func (*CreateNewFactorParams) SetMetadata added in v0.22.0 

func (params *CreateNewFactorParams) SetMetadata(Metadata interface{}) *CreateNewFactorParams

type CreateNotificationParams 

type CreateNotificationParams struct {
	// How long, in seconds, the notification is valid. Can be an integer between 0 and 300. Default is 300. Delivery is attempted until the TTL elapses, even if the device is offline. 0 means that the notification delivery is attempted immediately, only once, and is not stored for future delivery.
	Ttl *int `json:"Ttl,omitempty"`
}

Optional parameters for the method 'CreateNotification'

func (*CreateNotificationParams) SetTtl 

func (params *CreateNotificationParams) SetTtl(Ttl int) *CreateNotificationParams

type CreateRateLimitParams 

type CreateRateLimitParams struct {
	// Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**
	UniqueName *string `json:"UniqueName,omitempty"`
	// Description of this Rate Limit
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'CreateRateLimit'

func (*CreateRateLimitParams) SetDescription 

func (params *CreateRateLimitParams) SetDescription(Description string) *CreateRateLimitParams

func (*CreateRateLimitParams) SetUniqueName 

func (params *CreateRateLimitParams) SetUniqueName(UniqueName string) *CreateRateLimitParams

type CreateSafelistParams added in v1.0.0 

type CreateSafelistParams struct {
	// The phone number to be added in SafeList. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
	PhoneNumber *string `json:"PhoneNumber,omitempty"`
}

Optional parameters for the method 'CreateSafelist'

func (*CreateSafelistParams) SetPhoneNumber added in v1.0.0 

func (params *CreateSafelistParams) SetPhoneNumber(PhoneNumber string) *CreateSafelistParams

type CreateServiceParams 

type CreateServiceParams struct {
	// A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
	CodeLength *int `json:"CodeLength,omitempty"`
	// Whether to perform a lookup with each verification started and return info about the phone number.
	LookupEnabled *bool `json:"LookupEnabled,omitempty"`
	// Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
	SkipSmsToLandlines *bool `json:"SkipSmsToLandlines,omitempty"`
	// Whether to ask the user to press a number before delivering the verify code in a phone call.
	DtmfInputRequired *bool `json:"DtmfInputRequired,omitempty"`
	// The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
	TtsName *string `json:"TtsName,omitempty"`
	// Whether to pass PSD2 transaction parameters when starting a verification.
	Psd2Enabled *bool `json:"Psd2Enabled,omitempty"`
	// Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`
	DoNotShareWarningEnabled *bool `json:"DoNotShareWarningEnabled,omitempty"`
	// Whether to allow sending verifications with a custom code instead of a randomly generated one.
	CustomCodeEnabled *bool `json:"CustomCodeEnabled,omitempty"`
	// Optional configuration for the Push factors. If true, include the date in the Challenge's response. Otherwise, the date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. **Deprecated** do not use this parameter. This timestamp value is the same one as the one found in `date_created`, please use that one instead.
	PushIncludeDate *bool `json:"Push.IncludeDate,omitempty"`
	// Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
	PushApnCredentialSid *string `json:"Push.ApnCredentialSid,omitempty"`
	// Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
	PushFcmCredentialSid *string `json:"Push.FcmCredentialSid,omitempty"`
	// Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI. Defaults to the service friendly name if not provided.
	TotpIssuer *string `json:"Totp.Issuer,omitempty"`
	// Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
	TotpTimeStep *int `json:"Totp.TimeStep,omitempty"`
	// Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
	TotpCodeLength *int `json:"Totp.CodeLength,omitempty"`
	// Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
	TotpSkew *int `json:"Totp.Skew,omitempty"`
	// The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
	DefaultTemplateSid *string `json:"DefaultTemplateSid,omitempty"`
	// The SID of the Messaging Service containing WhatsApp Sender(s) that Verify will use to send WhatsApp messages to your users.
	WhatsappMsgServiceSid *string `json:"Whatsapp.MsgServiceSid,omitempty"`
	// The number to use as the WhatsApp Sender that Verify will use to send WhatsApp messages to your users.This WhatsApp Sender must be associated with a Messaging Service SID.
	WhatsappFrom *string `json:"Whatsapp.From,omitempty"`
	// Whether to allow verifications from the service to reach the stream-events sinks if configured
	VerifyEventSubscriptionEnabled *bool `json:"VerifyEventSubscriptionEnabled,omitempty"`
}

Optional parameters for the method 'CreateService'

func (*CreateServiceParams) SetCodeLength 

func (params *CreateServiceParams) SetCodeLength(CodeLength int) *CreateServiceParams

func (*CreateServiceParams) SetCustomCodeEnabled 

func (params *CreateServiceParams) SetCustomCodeEnabled(CustomCodeEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetDefaultTemplateSid added in v0.18.0 

func (params *CreateServiceParams) SetDefaultTemplateSid(DefaultTemplateSid string) *CreateServiceParams

func (*CreateServiceParams) SetDoNotShareWarningEnabled 

func (params *CreateServiceParams) SetDoNotShareWarningEnabled(DoNotShareWarningEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetDtmfInputRequired 

func (params *CreateServiceParams) SetDtmfInputRequired(DtmfInputRequired bool) *CreateServiceParams

func (*CreateServiceParams) SetFriendlyName 

func (params *CreateServiceParams) SetFriendlyName(FriendlyName string) *CreateServiceParams

func (*CreateServiceParams) SetLookupEnabled 

func (params *CreateServiceParams) SetLookupEnabled(LookupEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetPsd2Enabled 

func (params *CreateServiceParams) SetPsd2Enabled(Psd2Enabled bool) *CreateServiceParams

func (*CreateServiceParams) SetPushApnCredentialSid 

func (params *CreateServiceParams) SetPushApnCredentialSid(PushApnCredentialSid string) *CreateServiceParams

func (*CreateServiceParams) SetPushFcmCredentialSid 

func (params *CreateServiceParams) SetPushFcmCredentialSid(PushFcmCredentialSid string) *CreateServiceParams

func (*CreateServiceParams) SetPushIncludeDate 

func (params *CreateServiceParams) SetPushIncludeDate(PushIncludeDate bool) *CreateServiceParams

func (*CreateServiceParams) SetSkipSmsToLandlines 

func (params *CreateServiceParams) SetSkipSmsToLandlines(SkipSmsToLandlines bool) *CreateServiceParams

func (*CreateServiceParams) SetTotpCodeLength 

func (params *CreateServiceParams) SetTotpCodeLength(TotpCodeLength int) *CreateServiceParams

func (*CreateServiceParams) SetTotpIssuer 

func (params *CreateServiceParams) SetTotpIssuer(TotpIssuer string) *CreateServiceParams

func (*CreateServiceParams) SetTotpSkew 

func (params *CreateServiceParams) SetTotpSkew(TotpSkew int) *CreateServiceParams

func (*CreateServiceParams) SetTotpTimeStep 

func (params *CreateServiceParams) SetTotpTimeStep(TotpTimeStep int) *CreateServiceParams

func (*CreateServiceParams) SetTtsName 

func (params *CreateServiceParams) SetTtsName(TtsName string) *CreateServiceParams

func (*CreateServiceParams) SetVerifyEventSubscriptionEnabled added in v1.15.3 

func (params *CreateServiceParams) SetVerifyEventSubscriptionEnabled(VerifyEventSubscriptionEnabled bool) *CreateServiceParams

func (*CreateServiceParams) SetWhatsappFrom added in v1.20.0 

func (params *CreateServiceParams) SetWhatsappFrom(WhatsappFrom string) *CreateServiceParams

func (*CreateServiceParams) SetWhatsappMsgServiceSid added in v1.20.0 

func (params *CreateServiceParams) SetWhatsappMsgServiceSid(WhatsappMsgServiceSid string) *CreateServiceParams

type CreateVerificationCheckParams 

type CreateVerificationCheckParams struct {
	// The 4-10 character string being verified.
	Code *string `json:"Code,omitempty"`
	// The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Either this parameter or the `verification_sid` must be specified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
	To *string `json:"To,omitempty"`
	// A SID that uniquely identifies the Verification Check. Either this parameter or the `to` phone number/[email](https://www.twilio.com/docs/verify/email) must be specified.
	VerificationSid *string `json:"VerificationSid,omitempty"`
	// The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Amount *string `json:"Amount,omitempty"`
	// The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Payee *string `json:"Payee,omitempty"`
	// A sna client token received in sna url invocation response needs to be passed in Verification Check request and should match to get successful response.
	SnaClientToken *string `json:"SnaClientToken,omitempty"`
}

Optional parameters for the method 'CreateVerificationCheck'

func (*CreateVerificationCheckParams) SetAmount 

func (params *CreateVerificationCheckParams) SetAmount(Amount string) *CreateVerificationCheckParams

func (*CreateVerificationCheckParams) SetCode 

func (params *CreateVerificationCheckParams) SetCode(Code string) *CreateVerificationCheckParams

func (*CreateVerificationCheckParams) SetPayee 

func (params *CreateVerificationCheckParams) SetPayee(Payee string) *CreateVerificationCheckParams

func (*CreateVerificationCheckParams) SetSnaClientToken added in v1.23.3 

func (params *CreateVerificationCheckParams) SetSnaClientToken(SnaClientToken string) *CreateVerificationCheckParams

func (*CreateVerificationCheckParams) SetTo 

func (params *CreateVerificationCheckParams) SetTo(To string) *CreateVerificationCheckParams

func (*CreateVerificationCheckParams) SetVerificationSid 

func (params *CreateVerificationCheckParams) SetVerificationSid(VerificationSid string) *CreateVerificationCheckParams

type CreateVerificationParams 

type CreateVerificationParams struct {
	// The phone number or [email](https://www.twilio.com/docs/verify/email) to verify. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
	To *string `json:"To,omitempty"`
	// The verification method to use. One of: [`email`](https://www.twilio.com/docs/verify/email), `sms`, `whatsapp`, `call`, `sna` or `auto`.
	Channel *string `json:"Channel,omitempty"`
	// A custom user defined friendly name that overwrites the existing one in the verification message
	CustomFriendlyName *string `json:"CustomFriendlyName,omitempty"`
	// The text of a custom message to use for the verification.
	CustomMessage *string `json:"CustomMessage,omitempty"`
	// The digits to send after a phone call is answered, for example, to dial an extension. For more information, see the Programmable Voice documentation of [sendDigits](https://www.twilio.com/docs/voice/twiml/number#attributes-sendDigits).
	SendDigits *string `json:"SendDigits,omitempty"`
	// Locale will automatically resolve based on phone number country code for SMS, WhatsApp, and call channel verifications. It will fallback to English or the template’s default translation if the selected translation is not available. This parameter will override the automatic locale resolution. [See supported languages and more information here](https://www.twilio.com/docs/verify/supported-languages).
	Locale *string `json:"Locale,omitempty"`
	// A pre-generated code to use for verification. The code can be between 4 and 10 characters, inclusive.
	CustomCode *string `json:"CustomCode,omitempty"`
	// The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Amount *string `json:"Amount,omitempty"`
	// The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Payee *string `json:"Payee,omitempty"`
	// The custom key-value pairs of Programmable Rate Limits. Keys correspond to `unique_name` fields defined when [creating your Rate Limit](https://www.twilio.com/docs/verify/api/service-rate-limits). Associated value pairs represent values in the request that you are rate limiting on. You may include multiple Rate Limit values in each request.
	RateLimits *interface{} `json:"RateLimits,omitempty"`
	// [`email`](https://www.twilio.com/docs/verify/email) channel configuration in json format. The fields 'from' and 'from_name' are optional but if included the 'from' field must have a valid email address.
	ChannelConfiguration *interface{} `json:"ChannelConfiguration,omitempty"`
	// Your [App Hash](https://developers.google.com/identity/sms-retriever/verify#computing_your_apps_hash_string) to be appended at the end of your verification SMS body. Applies only to SMS. Example SMS body: `<#> Your AppName verification code is: 1234 He42w354ol9`.
	AppHash *string `json:"AppHash,omitempty"`
	// The message [template](https://www.twilio.com/docs/verify/api/templates). If provided, will override the default template for the Service. SMS and Voice channels only.
	TemplateSid *string `json:"TemplateSid,omitempty"`
	// A stringified JSON object in which the keys are the template's special variables and the values are the variables substitutions.
	TemplateCustomSubstitutions *string `json:"TemplateCustomSubstitutions,omitempty"`
	// Strongly encouraged if using the auto channel. The IP address of the client's device. If provided, it has to be a valid IPv4 or IPv6 address.
	DeviceIp *string `json:"DeviceIp,omitempty"`
	// An optional Boolean value to indicate the requirement of sna client token in the SNA URL invocation response for added security. This token must match in the Verification Check request to confirm phone number verification.
	EnableSnaClientToken *bool `json:"EnableSnaClientToken,omitempty"`
	//
	RiskCheck *string `json:"RiskCheck,omitempty"`
	// A string containing a JSON map of key value pairs of tags to be recorded as metadata for the message. The object may contain up to 10 tags. Keys and values can each be up to 128 characters in length.
	Tags *string `json:"Tags,omitempty"`
}

Optional parameters for the method 'CreateVerification'

func (*CreateVerificationParams) SetAmount 

func (params *CreateVerificationParams) SetAmount(Amount string) *CreateVerificationParams

func (*CreateVerificationParams) SetAppHash 

func (params *CreateVerificationParams) SetAppHash(AppHash string) *CreateVerificationParams

func (*CreateVerificationParams) SetChannel 

func (params *CreateVerificationParams) SetChannel(Channel string) *CreateVerificationParams

func (*CreateVerificationParams) SetChannelConfiguration 

func (params *CreateVerificationParams) SetChannelConfiguration(ChannelConfiguration interface{}) *CreateVerificationParams

func (*CreateVerificationParams) SetCustomCode 

func (params *CreateVerificationParams) SetCustomCode(CustomCode string) *CreateVerificationParams

func (*CreateVerificationParams) SetCustomFriendlyName 

func (params *CreateVerificationParams) SetCustomFriendlyName(CustomFriendlyName string) *CreateVerificationParams

func (*CreateVerificationParams) SetCustomMessage 

func (params *CreateVerificationParams) SetCustomMessage(CustomMessage string) *CreateVerificationParams

func (*CreateVerificationParams) SetDeviceIp added in v1.3.2 

func (params *CreateVerificationParams) SetDeviceIp(DeviceIp string) *CreateVerificationParams

func (*CreateVerificationParams) SetEnableSnaClientToken added in v1.23.3 

func (params *CreateVerificationParams) SetEnableSnaClientToken(EnableSnaClientToken bool) *CreateVerificationParams

func (*CreateVerificationParams) SetLocale 

func (params *CreateVerificationParams) SetLocale(Locale string) *CreateVerificationParams

func (*CreateVerificationParams) SetPayee 

func (params *CreateVerificationParams) SetPayee(Payee string) *CreateVerificationParams

func (*CreateVerificationParams) SetRateLimits 

func (params *CreateVerificationParams) SetRateLimits(RateLimits interface{}) *CreateVerificationParams

func (*CreateVerificationParams) SetRiskCheck added in v1.10.0 

func (params *CreateVerificationParams) SetRiskCheck(RiskCheck string) *CreateVerificationParams

func (*CreateVerificationParams) SetSendDigits 

func (params *CreateVerificationParams) SetSendDigits(SendDigits string) *CreateVerificationParams

func (*CreateVerificationParams) SetTags added in v1.15.2 

func (params *CreateVerificationParams) SetTags(Tags string) *CreateVerificationParams

func (*CreateVerificationParams) SetTemplateCustomSubstitutions added in v0.18.0 

func (params *CreateVerificationParams) SetTemplateCustomSubstitutions(TemplateCustomSubstitutions string) *CreateVerificationParams

func (*CreateVerificationParams) SetTemplateSid added in v0.14.0 

func (params *CreateVerificationParams) SetTemplateSid(TemplateSid string) *CreateVerificationParams

func (*CreateVerificationParams) SetTo 

func (params *CreateVerificationParams) SetTo(To string) *CreateVerificationParams

type CreateWebhookParams 

type CreateWebhookParams struct {
	// The string that you assigned to describe the webhook. **This value should not contain PII.**
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`
	EventTypes *[]string `json:"EventTypes,omitempty"`
	// The URL associated with this Webhook.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	//
	Status *string `json:"Status,omitempty"`
	//
	Version *string `json:"Version,omitempty"`
}

Optional parameters for the method 'CreateWebhook'

func (*CreateWebhookParams) SetEventTypes 

func (params *CreateWebhookParams) SetEventTypes(EventTypes []string) *CreateWebhookParams

func (*CreateWebhookParams) SetFriendlyName 

func (params *CreateWebhookParams) SetFriendlyName(FriendlyName string) *CreateWebhookParams

func (*CreateWebhookParams) SetStatus 

func (params *CreateWebhookParams) SetStatus(Status string) *CreateWebhookParams

func (*CreateWebhookParams) SetVersion added in v0.13.0 

func (params *CreateWebhookParams) SetVersion(Version string) *CreateWebhookParams

func (*CreateWebhookParams) SetWebhookUrl 

func (params *CreateWebhookParams) SetWebhookUrl(WebhookUrl string) *CreateWebhookParams

type FetchVerificationAttemptsSummaryParams added in v0.24.0 

type FetchVerificationAttemptsSummaryParams struct {
	// Filter used to consider only Verification Attempts of the given verify service on the summary aggregation.
	VerifyServiceSid *string `json:"VerifyServiceSid,omitempty"`
	// Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
	DateCreatedAfter *time.Time `json:"DateCreatedAfter,omitempty"`
	// Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
	DateCreatedBefore *time.Time `json:"DateCreatedBefore,omitempty"`
	// Filter used to consider only Verification Attempts sent to the specified destination country on the summary aggregation.
	Country *string `json:"Country,omitempty"`
	// Filter Verification Attempts considered on the summary aggregation by communication channel. Valid values are `SMS`, `CALL` and `WHATSAPP`
	Channel *string `json:"Channel,omitempty"`
	// Filter the Verification Attempts considered on the summary aggregation by Destination prefix. It is the prefix of a phone number in E.164 format.
	DestinationPrefix *string `json:"DestinationPrefix,omitempty"`
}

Optional parameters for the method 'FetchVerificationAttemptsSummary'

func (*FetchVerificationAttemptsSummaryParams) SetChannel added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetChannel(Channel string) *FetchVerificationAttemptsSummaryParams

func (*FetchVerificationAttemptsSummaryParams) SetCountry added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetCountry(Country string) *FetchVerificationAttemptsSummaryParams

func (*FetchVerificationAttemptsSummaryParams) SetDateCreatedAfter added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetDateCreatedAfter(DateCreatedAfter time.Time) *FetchVerificationAttemptsSummaryParams

func (*FetchVerificationAttemptsSummaryParams) SetDateCreatedBefore added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetDateCreatedBefore(DateCreatedBefore time.Time) *FetchVerificationAttemptsSummaryParams

func (*FetchVerificationAttemptsSummaryParams) SetDestinationPrefix added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetDestinationPrefix(DestinationPrefix string) *FetchVerificationAttemptsSummaryParams

func (*FetchVerificationAttemptsSummaryParams) SetVerifyServiceSid added in v0.24.0 

func (params *FetchVerificationAttemptsSummaryParams) SetVerifyServiceSid(VerifyServiceSid string) *FetchVerificationAttemptsSummaryParams

type ListBucketParams 

type ListBucketParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListBucket'

func (*ListBucketParams) SetLimit added in v0.13.0 

func (params *ListBucketParams) SetLimit(Limit int) *ListBucketParams

func (*ListBucketParams) SetPageSize 

func (params *ListBucketParams) SetPageSize(PageSize int) *ListBucketParams

type ListBucketResponse 

type ListBucketResponse struct {
	Buckets []VerifyV2Bucket       `json:"buckets,omitempty"`
	Meta    ListBucketResponseMeta `json:"meta,omitempty"`
}

ListBucketResponse struct for ListBucketResponse

type ListBucketResponseMeta added in v1.0.0 

type ListBucketResponseMeta struct {
	FirstPageUrl    string  `json:"first_page_url,omitempty"`
	Key             string  `json:"key,omitempty"`
	NextPageUrl     *string `json:"next_page_url,omitempty"`
	Page            int     `json:"page,omitempty"`
	PageSize        int     `json:"page_size,omitempty"`
	PreviousPageUrl *string `json:"previous_page_url,omitempty"`
	Url             string  `json:"url,omitempty"`
}

ListBucketResponseMeta struct for ListBucketResponseMeta

type ListChallengeParams 

type ListChallengeParams struct {
	// The unique SID identifier of the Factor.
	FactorSid *string `json:"FactorSid,omitempty"`
	// The Status of the Challenges to fetch. One of `pending`, `expired`, `approved` or `denied`.
	Status *string `json:"Status,omitempty"`
	// The desired sort order of the Challenges list. One of `asc` or `desc` for ascending and descending respectively. Defaults to `asc`.
	Order *string `json:"Order,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListChallenge'

func (*ListChallengeParams) SetFactorSid 

func (params *ListChallengeParams) SetFactorSid(FactorSid string) *ListChallengeParams

func (*ListChallengeParams) SetLimit added in v0.13.0 

func (params *ListChallengeParams) SetLimit(Limit int) *ListChallengeParams

func (*ListChallengeParams) SetOrder added in v0.14.1 

func (params *ListChallengeParams) SetOrder(Order string) *ListChallengeParams

func (*ListChallengeParams) SetPageSize 

func (params *ListChallengeParams) SetPageSize(PageSize int) *ListChallengeParams

func (*ListChallengeParams) SetStatus 

func (params *ListChallengeParams) SetStatus(Status string) *ListChallengeParams

type ListChallengeResponse 

type ListChallengeResponse struct {
	Challenges []VerifyV2Challenge    `json:"challenges,omitempty"`
	Meta       ListBucketResponseMeta `json:"meta,omitempty"`
}

ListChallengeResponse struct for ListChallengeResponse

type ListEntityParams 

type ListEntityParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListEntity'

func (*ListEntityParams) SetLimit added in v0.13.0 

func (params *ListEntityParams) SetLimit(Limit int) *ListEntityParams

func (*ListEntityParams) SetPageSize 

func (params *ListEntityParams) SetPageSize(PageSize int) *ListEntityParams

type ListEntityResponse 

type ListEntityResponse struct {
	Entities []VerifyV2Entity       `json:"entities,omitempty"`
	Meta     ListBucketResponseMeta `json:"meta,omitempty"`
}

ListEntityResponse struct for ListEntityResponse

type ListFactorParams 

type ListFactorParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListFactor'

func (*ListFactorParams) SetLimit added in v0.13.0 

func (params *ListFactorParams) SetLimit(Limit int) *ListFactorParams

func (*ListFactorParams) SetPageSize 

func (params *ListFactorParams) SetPageSize(PageSize int) *ListFactorParams

type ListFactorResponse 

type ListFactorResponse struct {
	Factors []VerifyV2Factor       `json:"factors,omitempty"`
	Meta    ListBucketResponseMeta `json:"meta,omitempty"`
}

ListFactorResponse struct for ListFactorResponse

type ListMessagingConfigurationParams 

type ListMessagingConfigurationParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListMessagingConfiguration'

func (*ListMessagingConfigurationParams) SetLimit added in v0.13.0 

func (params *ListMessagingConfigurationParams) SetLimit(Limit int) *ListMessagingConfigurationParams

func (*ListMessagingConfigurationParams) SetPageSize 

func (params *ListMessagingConfigurationParams) SetPageSize(PageSize int) *ListMessagingConfigurationParams

type ListMessagingConfigurationResponse 

type ListMessagingConfigurationResponse struct {
	MessagingConfigurations []VerifyV2MessagingConfiguration `json:"messaging_configurations,omitempty"`
	Meta                    ListBucketResponseMeta           `json:"meta,omitempty"`
}

ListMessagingConfigurationResponse struct for ListMessagingConfigurationResponse

type ListRateLimitParams 

type ListRateLimitParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListRateLimit'

func (*ListRateLimitParams) SetLimit added in v0.13.0 

func (params *ListRateLimitParams) SetLimit(Limit int) *ListRateLimitParams

func (*ListRateLimitParams) SetPageSize 

func (params *ListRateLimitParams) SetPageSize(PageSize int) *ListRateLimitParams

type ListRateLimitResponse 

type ListRateLimitResponse struct {
	RateLimits []VerifyV2RateLimit    `json:"rate_limits,omitempty"`
	Meta       ListBucketResponseMeta `json:"meta,omitempty"`
}

ListRateLimitResponse struct for ListRateLimitResponse

type ListServiceParams 

type ListServiceParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListService'

func (*ListServiceParams) SetLimit added in v0.13.0 

func (params *ListServiceParams) SetLimit(Limit int) *ListServiceParams

func (*ListServiceParams) SetPageSize 

func (params *ListServiceParams) SetPageSize(PageSize int) *ListServiceParams

type ListServiceResponse 

type ListServiceResponse struct {
	Services []VerifyV2Service      `json:"services,omitempty"`
	Meta     ListBucketResponseMeta `json:"meta,omitempty"`
}

ListServiceResponse struct for ListServiceResponse

type ListVerificationAttemptParams 

type ListVerificationAttemptParams struct {
	// Datetime filter used to consider only Verification Attempts created after this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
	DateCreatedAfter *time.Time `json:"DateCreatedAfter,omitempty"`
	// Datetime filter used to consider only Verification Attempts created before this datetime on the summary aggregation. Given as GMT in ISO 8601 formatted datetime string: yyyy-MM-dd'T'HH:mm:ss'Z.
	DateCreatedBefore *time.Time `json:"DateCreatedBefore,omitempty"`
	// Destination of a verification. It is phone number in E.164 format.
	ChannelDataTo *string `json:"ChannelData.To,omitempty"`
	// Filter used to query Verification Attempts sent to the specified destination country.
	Country *string `json:"Country,omitempty"`
	// Filter used to query Verification Attempts by communication channel. Valid values are `SMS` and `CALL`
	Channel *string `json:"Channel,omitempty"`
	// Filter used to query Verification Attempts by verify service. Only attempts of the provided SID will be returned.
	VerifyServiceSid *string `json:"VerifyServiceSid,omitempty"`
	// Filter used to return all the Verification Attempts of a single verification. Only attempts of the provided verification SID will be returned.
	VerificationSid *string `json:"VerificationSid,omitempty"`
	// Filter used to query Verification Attempts by conversion status. Valid values are `UNCONVERTED`, for attempts that were not converted, and `CONVERTED`, for attempts that were confirmed.
	Status *string `json:"Status,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListVerificationAttempt'

func (*ListVerificationAttemptParams) SetChannel added in v0.21.0 

func (params *ListVerificationAttemptParams) SetChannel(Channel string) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetChannelDataTo 

func (params *ListVerificationAttemptParams) SetChannelDataTo(ChannelDataTo string) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetCountry added in v0.21.0 

func (params *ListVerificationAttemptParams) SetCountry(Country string) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetDateCreatedAfter 

func (params *ListVerificationAttemptParams) SetDateCreatedAfter(DateCreatedAfter time.Time) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetDateCreatedBefore 

func (params *ListVerificationAttemptParams) SetDateCreatedBefore(DateCreatedBefore time.Time) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetLimit added in v0.13.0 

func (params *ListVerificationAttemptParams) SetLimit(Limit int) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetPageSize 

func (params *ListVerificationAttemptParams) SetPageSize(PageSize int) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetStatus added in v0.21.0 

func (params *ListVerificationAttemptParams) SetStatus(Status string) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetVerificationSid added in v0.21.0 

func (params *ListVerificationAttemptParams) SetVerificationSid(VerificationSid string) *ListVerificationAttemptParams

func (*ListVerificationAttemptParams) SetVerifyServiceSid added in v0.21.0 

func (params *ListVerificationAttemptParams) SetVerifyServiceSid(VerifyServiceSid string) *ListVerificationAttemptParams

type ListVerificationAttemptResponse 

type ListVerificationAttemptResponse struct {
	Attempts []VerifyV2VerificationAttempt `json:"attempts,omitempty"`
	Meta     ListBucketResponseMeta        `json:"meta,omitempty"`
}

ListVerificationAttemptResponse struct for ListVerificationAttemptResponse

type ListVerificationTemplateParams added in v0.14.2 

type ListVerificationTemplateParams struct {
	// String filter used to query templates with a given friendly name.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListVerificationTemplate'

func (*ListVerificationTemplateParams) SetFriendlyName added in v0.14.2 

func (params *ListVerificationTemplateParams) SetFriendlyName(FriendlyName string) *ListVerificationTemplateParams

func (*ListVerificationTemplateParams) SetLimit added in v0.14.2 

func (params *ListVerificationTemplateParams) SetLimit(Limit int) *ListVerificationTemplateParams

func (*ListVerificationTemplateParams) SetPageSize added in v0.14.2 

func (params *ListVerificationTemplateParams) SetPageSize(PageSize int) *ListVerificationTemplateParams

type ListVerificationTemplateResponse added in v0.14.2 

type ListVerificationTemplateResponse struct {
	Templates []VerifyV2VerificationTemplate `json:"templates,omitempty"`
	Meta      ListBucketResponseMeta         `json:"meta,omitempty"`
}

ListVerificationTemplateResponse struct for ListVerificationTemplateResponse

type ListWebhookParams 

type ListWebhookParams struct {
	// How many resources to return in each list page. The default is 50, and the maximum is 1000.
	PageSize *int `json:"PageSize,omitempty"`
	// Max number of records to return.
	Limit *int `json:"limit,omitempty"`
}

Optional parameters for the method 'ListWebhook'

func (*ListWebhookParams) SetLimit added in v0.13.0 

func (params *ListWebhookParams) SetLimit(Limit int) *ListWebhookParams

func (*ListWebhookParams) SetPageSize 

func (params *ListWebhookParams) SetPageSize(PageSize int) *ListWebhookParams

type ListWebhookResponse 

type ListWebhookResponse struct {
	Webhooks []VerifyV2Webhook      `json:"webhooks,omitempty"`
	Meta     ListBucketResponseMeta `json:"meta,omitempty"`
}

ListWebhookResponse struct for ListWebhookResponse

type UpdateBucketParams 

type UpdateBucketParams struct {
	// Maximum number of requests permitted in during the interval.
	Max *int `json:"Max,omitempty"`
	// Number of seconds that the rate limit will be enforced over.
	Interval *int `json:"Interval,omitempty"`
}

Optional parameters for the method 'UpdateBucket'

func (*UpdateBucketParams) SetInterval 

func (params *UpdateBucketParams) SetInterval(Interval int) *UpdateBucketParams

func (*UpdateBucketParams) SetMax 

func (params *UpdateBucketParams) SetMax(Max int) *UpdateBucketParams

type UpdateChallengeParams 

type UpdateChallengeParams struct {
	// The optional payload needed to verify the Challenge. E.g., a TOTP would use the numeric code. For `TOTP` this value must be between 3 and 8 characters long. For `Push` this value can be up to 5456 characters in length
	AuthPayload *string `json:"AuthPayload,omitempty"`
	// Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\\\"os\\\": \\\"Android\\\"}`. Can be up to 1024 characters in length.
	Metadata *interface{} `json:"Metadata,omitempty"`
}

Optional parameters for the method 'UpdateChallenge'

func (*UpdateChallengeParams) SetAuthPayload 

func (params *UpdateChallengeParams) SetAuthPayload(AuthPayload string) *UpdateChallengeParams

func (*UpdateChallengeParams) SetMetadata added in v0.22.2 

func (params *UpdateChallengeParams) SetMetadata(Metadata interface{}) *UpdateChallengeParams

type UpdateFactorParams 

type UpdateFactorParams struct {
	// The optional payload needed to verify the Factor for the first time. E.g. for a TOTP, the numeric code.
	AuthPayload *string `json:"AuthPayload,omitempty"`
	// The new friendly name of this Factor. It can be up to 64 characters.
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// For APN, the device token. For FCM, the registration token. It is used to send the push notifications. Required when `factor_type` is `push`. If specified, this value must be between 32 and 255 characters long.
	ConfigNotificationToken *string `json:"Config.NotificationToken,omitempty"`
	// The Verify Push SDK version used to configure the factor
	ConfigSdkVersion *string `json:"Config.SdkVersion,omitempty"`
	// Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive
	ConfigTimeStep *int `json:"Config.TimeStep,omitempty"`
	// The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive
	ConfigSkew *int `json:"Config.Skew,omitempty"`
	// Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive
	ConfigCodeLength *int `json:"Config.CodeLength,omitempty"`
	//
	ConfigAlg *string `json:"Config.Alg,omitempty"`
	// The transport technology used to generate the Notification Token. Can be `apn`, `fcm` or `none`.  Required when `factor_type` is `push`.
	ConfigNotificationPlatform *string `json:"Config.NotificationPlatform,omitempty"`
}

Optional parameters for the method 'UpdateFactor'

func (*UpdateFactorParams) SetAuthPayload 

func (params *UpdateFactorParams) SetAuthPayload(AuthPayload string) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigAlg 

func (params *UpdateFactorParams) SetConfigAlg(ConfigAlg string) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigCodeLength 

func (params *UpdateFactorParams) SetConfigCodeLength(ConfigCodeLength int) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigNotificationPlatform added in v0.18.1 

func (params *UpdateFactorParams) SetConfigNotificationPlatform(ConfigNotificationPlatform string) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigNotificationToken 

func (params *UpdateFactorParams) SetConfigNotificationToken(ConfigNotificationToken string) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigSdkVersion 

func (params *UpdateFactorParams) SetConfigSdkVersion(ConfigSdkVersion string) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigSkew 

func (params *UpdateFactorParams) SetConfigSkew(ConfigSkew int) *UpdateFactorParams

func (*UpdateFactorParams) SetConfigTimeStep 

func (params *UpdateFactorParams) SetConfigTimeStep(ConfigTimeStep int) *UpdateFactorParams

func (*UpdateFactorParams) SetFriendlyName 

func (params *UpdateFactorParams) SetFriendlyName(FriendlyName string) *UpdateFactorParams

type UpdateMessagingConfigurationParams 

type UpdateMessagingConfigurationParams struct {
	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
	MessagingServiceSid *string `json:"MessagingServiceSid,omitempty"`
}

Optional parameters for the method 'UpdateMessagingConfiguration'

func (*UpdateMessagingConfigurationParams) SetMessagingServiceSid 

func (params *UpdateMessagingConfigurationParams) SetMessagingServiceSid(MessagingServiceSid string) *UpdateMessagingConfigurationParams

type UpdateRateLimitParams 

type UpdateRateLimitParams struct {
	// Description of this Rate Limit
	Description *string `json:"Description,omitempty"`
}

Optional parameters for the method 'UpdateRateLimit'

func (*UpdateRateLimitParams) SetDescription 

func (params *UpdateRateLimitParams) SetDescription(Description string) *UpdateRateLimitParams

type UpdateServiceParams 

type UpdateServiceParams struct {
	// A descriptive string that you create to describe the verification service. It can be up to 32 characters long. **This value should not contain PII.**
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The length of the verification code to generate. Must be an integer value between 4 and 10, inclusive.
	CodeLength *int `json:"CodeLength,omitempty"`
	// Whether to perform a lookup with each verification started and return info about the phone number.
	LookupEnabled *bool `json:"LookupEnabled,omitempty"`
	// Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
	SkipSmsToLandlines *bool `json:"SkipSmsToLandlines,omitempty"`
	// Whether to ask the user to press a number before delivering the verify code in a phone call.
	DtmfInputRequired *bool `json:"DtmfInputRequired,omitempty"`
	// The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
	TtsName *string `json:"TtsName,omitempty"`
	// Whether to pass PSD2 transaction parameters when starting a verification.
	Psd2Enabled *bool `json:"Psd2Enabled,omitempty"`
	// Whether to add a privacy warning at the end of an SMS. **Disabled by default and applies only for SMS.**
	DoNotShareWarningEnabled *bool `json:"DoNotShareWarningEnabled,omitempty"`
	// Whether to allow sending verifications with a custom code instead of a randomly generated one.
	CustomCodeEnabled *bool `json:"CustomCodeEnabled,omitempty"`
	// Optional configuration for the Push factors. If true, include the date in the Challenge's response. Otherwise, the date is omitted from the response. See [Challenge](https://www.twilio.com/docs/verify/api/challenge) resource’s details parameter for more info. Default: false. **Deprecated** do not use this parameter.
	PushIncludeDate *bool `json:"Push.IncludeDate,omitempty"`
	// Optional configuration for the Push factors. Set the APN Credential for this service. This will allow to send push notifications to iOS devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
	PushApnCredentialSid *string `json:"Push.ApnCredentialSid,omitempty"`
	// Optional configuration for the Push factors. Set the FCM Credential for this service. This will allow to send push notifications to Android devices. See [Credential Resource](https://www.twilio.com/docs/notify/api/credential-resource)
	PushFcmCredentialSid *string `json:"Push.FcmCredentialSid,omitempty"`
	// Optional configuration for the TOTP factors. Set TOTP Issuer for this service. This will allow to configure the issuer of the TOTP URI.
	TotpIssuer *string `json:"Totp.Issuer,omitempty"`
	// Optional configuration for the TOTP factors. Defines how often, in seconds, are TOTP codes generated. i.e, a new TOTP code is generated every time_step seconds. Must be between 20 and 60 seconds, inclusive. Defaults to 30 seconds
	TotpTimeStep *int `json:"Totp.TimeStep,omitempty"`
	// Optional configuration for the TOTP factors. Number of digits for generated TOTP codes. Must be between 3 and 8, inclusive. Defaults to 6
	TotpCodeLength *int `json:"Totp.CodeLength,omitempty"`
	// Optional configuration for the TOTP factors. The number of time-steps, past and future, that are valid for validation of TOTP codes. Must be between 0 and 2, inclusive. Defaults to 1
	TotpSkew *int `json:"Totp.Skew,omitempty"`
	// The default message [template](https://www.twilio.com/docs/verify/api/templates). Will be used for all SMS verifications unless explicitly overriden. SMS channel only.
	DefaultTemplateSid *string `json:"DefaultTemplateSid,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services) to associate with the Verification Service.
	WhatsappMsgServiceSid *string `json:"Whatsapp.MsgServiceSid,omitempty"`
	// The WhatsApp number to use as the sender of the verification messages. This number must be associated with the WhatsApp Message Service.
	WhatsappFrom *string `json:"Whatsapp.From,omitempty"`
	// Whether to allow verifications from the service to reach the stream-events sinks if configured
	VerifyEventSubscriptionEnabled *bool `json:"VerifyEventSubscriptionEnabled,omitempty"`
}

Optional parameters for the method 'UpdateService'

func (*UpdateServiceParams) SetCodeLength 

func (params *UpdateServiceParams) SetCodeLength(CodeLength int) *UpdateServiceParams

func (*UpdateServiceParams) SetCustomCodeEnabled 

func (params *UpdateServiceParams) SetCustomCodeEnabled(CustomCodeEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetDefaultTemplateSid added in v0.18.0 

func (params *UpdateServiceParams) SetDefaultTemplateSid(DefaultTemplateSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetDoNotShareWarningEnabled 

func (params *UpdateServiceParams) SetDoNotShareWarningEnabled(DoNotShareWarningEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetDtmfInputRequired 

func (params *UpdateServiceParams) SetDtmfInputRequired(DtmfInputRequired bool) *UpdateServiceParams

func (*UpdateServiceParams) SetFriendlyName 

func (params *UpdateServiceParams) SetFriendlyName(FriendlyName string) *UpdateServiceParams

func (*UpdateServiceParams) SetLookupEnabled 

func (params *UpdateServiceParams) SetLookupEnabled(LookupEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetPsd2Enabled 

func (params *UpdateServiceParams) SetPsd2Enabled(Psd2Enabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetPushApnCredentialSid 

func (params *UpdateServiceParams) SetPushApnCredentialSid(PushApnCredentialSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetPushFcmCredentialSid 

func (params *UpdateServiceParams) SetPushFcmCredentialSid(PushFcmCredentialSid string) *UpdateServiceParams

func (*UpdateServiceParams) SetPushIncludeDate 

func (params *UpdateServiceParams) SetPushIncludeDate(PushIncludeDate bool) *UpdateServiceParams

func (*UpdateServiceParams) SetSkipSmsToLandlines 

func (params *UpdateServiceParams) SetSkipSmsToLandlines(SkipSmsToLandlines bool) *UpdateServiceParams

func (*UpdateServiceParams) SetTotpCodeLength 

func (params *UpdateServiceParams) SetTotpCodeLength(TotpCodeLength int) *UpdateServiceParams

func (*UpdateServiceParams) SetTotpIssuer 

func (params *UpdateServiceParams) SetTotpIssuer(TotpIssuer string) *UpdateServiceParams

func (*UpdateServiceParams) SetTotpSkew 

func (params *UpdateServiceParams) SetTotpSkew(TotpSkew int) *UpdateServiceParams

func (*UpdateServiceParams) SetTotpTimeStep 

func (params *UpdateServiceParams) SetTotpTimeStep(TotpTimeStep int) *UpdateServiceParams

func (*UpdateServiceParams) SetTtsName 

func (params *UpdateServiceParams) SetTtsName(TtsName string) *UpdateServiceParams

func (*UpdateServiceParams) SetVerifyEventSubscriptionEnabled added in v1.15.3 

func (params *UpdateServiceParams) SetVerifyEventSubscriptionEnabled(VerifyEventSubscriptionEnabled bool) *UpdateServiceParams

func (*UpdateServiceParams) SetWhatsappFrom added in v1.20.0 

func (params *UpdateServiceParams) SetWhatsappFrom(WhatsappFrom string) *UpdateServiceParams

func (*UpdateServiceParams) SetWhatsappMsgServiceSid added in v1.20.0 

func (params *UpdateServiceParams) SetWhatsappMsgServiceSid(WhatsappMsgServiceSid string) *UpdateServiceParams

type UpdateVerificationParams 

type UpdateVerificationParams struct {
	//
	Status *string `json:"Status,omitempty"`
}

Optional parameters for the method 'UpdateVerification'

func (*UpdateVerificationParams) SetStatus 

func (params *UpdateVerificationParams) SetStatus(Status string) *UpdateVerificationParams

type UpdateWebhookParams 

type UpdateWebhookParams struct {
	// The string that you assigned to describe the webhook. **This value should not contain PII.**
	FriendlyName *string `json:"FriendlyName,omitempty"`
	// The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`
	EventTypes *[]string `json:"EventTypes,omitempty"`
	// The URL associated with this Webhook.
	WebhookUrl *string `json:"WebhookUrl,omitempty"`
	//
	Status *string `json:"Status,omitempty"`
	//
	Version *string `json:"Version,omitempty"`
}

Optional parameters for the method 'UpdateWebhook'

func (*UpdateWebhookParams) SetEventTypes 

func (params *UpdateWebhookParams) SetEventTypes(EventTypes []string) *UpdateWebhookParams

func (*UpdateWebhookParams) SetFriendlyName 

func (params *UpdateWebhookParams) SetFriendlyName(FriendlyName string) *UpdateWebhookParams

func (*UpdateWebhookParams) SetStatus 

func (params *UpdateWebhookParams) SetStatus(Status string) *UpdateWebhookParams

func (*UpdateWebhookParams) SetVersion added in v0.13.0 

func (params *UpdateWebhookParams) SetVersion(Version string) *UpdateWebhookParams

func (*UpdateWebhookParams) SetWebhookUrl 

func (params *UpdateWebhookParams) SetWebhookUrl(WebhookUrl string) *UpdateWebhookParams

type VerifyV2AccessToken added in v0.14.0 

type VerifyV2AccessToken struct {
	// A 34 character string that uniquely identifies this Access Token.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Verify Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique external identifier for the Entity of the Service.
	EntityIdentity *string `json:"entity_identity,omitempty"`
	FactorType     *string `json:"factor_type,omitempty"`
	// A human readable description of this factor, up to 64 characters. For a push factor, this can be the device's name.
	FactorFriendlyName *string `json:"factor_friendly_name,omitempty"`
	// The access token generated for enrollment, this is an encrypted json web token.
	Token *string `json:"token,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// How long, in seconds, the access token is valid. Max: 5 minutes
	Ttl int `json:"ttl,omitempty"`
	// The date that this access token was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
}

VerifyV2AccessToken struct for VerifyV2AccessToken

type VerifyV2Bucket added in v0.14.0 

type VerifyV2Bucket struct {
	// A 34 character string that uniquely identifies this Bucket.
	Sid *string `json:"sid,omitempty"`
	// The Twilio-provided string that uniquely identifies the Rate Limit resource.
	RateLimitSid *string `json:"rate_limit_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// Maximum number of requests permitted in during the interval.
	Max int `json:"max,omitempty"`
	// Number of seconds that the rate limit will be enforced over.
	Interval int `json:"interval,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2Bucket struct for VerifyV2Bucket

type VerifyV2Challenge added in v0.14.0 

type VerifyV2Challenge struct {
	// A 34 character string that uniquely identifies this Challenge.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique SID identifier of the Entity.
	EntitySid *string `json:"entity_sid,omitempty"`
	// Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"identity,omitempty"`
	// The unique SID identifier of the Factor.
	FactorSid *string `json:"factor_sid,omitempty"`
	// The date that this Challenge was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Challenge was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The date that this Challenge was responded, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateResponded *time.Time `json:"date_responded,omitempty"`
	// The date-time when this Challenge expires, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. The default value is five (5) minutes after Challenge creation. The max value is sixty (60) minutes after creation.
	ExpirationDate  *time.Time `json:"expiration_date,omitempty"`
	Status          *string    `json:"status,omitempty"`
	RespondedReason *string    `json:"responded_reason,omitempty"`
	// Details provided to give context about the Challenge. Intended to be shown to the end user.
	Details *interface{} `json:"details,omitempty"`
	// Details provided to give context about the Challenge. Intended to be hidden from the end user. It must be a stringified JSON with only strings values eg. `{\"ip\": \"172.168.1.234\"}`
	HiddenDetails *interface{} `json:"hidden_details,omitempty"`
	// Custom metadata associated with the challenge. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.
	Metadata   *interface{} `json:"metadata,omitempty"`
	FactorType *string      `json:"factor_type,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// Contains a dictionary of URL links to nested resources of this Challenge.
	Links *map[string]interface{} `json:"links,omitempty"`
}

VerifyV2Challenge struct for VerifyV2Challenge

type VerifyV2Entity added in v0.14.0 

type VerifyV2Entity struct {
	// A 34 character string that uniquely identifies this Entity.
	Sid *string `json:"sid,omitempty"`
	// The unique external identifier for the Entity of the Service. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"identity,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The date that this Entity was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Entity was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// Contains a dictionary of URL links to nested resources of this Entity.
	Links *map[string]interface{} `json:"links,omitempty"`
}

VerifyV2Entity struct for VerifyV2Entity

type VerifyV2Factor added in v0.14.0 

type VerifyV2Factor struct {
	// A 34 character string that uniquely identifies this Factor.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique SID identifier of the Entity.
	EntitySid *string `json:"entity_sid,omitempty"`
	// Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"identity,omitempty"`
	// The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// A human readable description of this resource, up to 64 characters. For a push factor, this can be the device's name.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	FactorType   *string `json:"factor_type,omitempty"`
	// An object that contains configurations specific to a `factor_type`.
	Config *interface{} `json:"config,omitempty"`
	// Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.
	Metadata *interface{} `json:"metadata,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2Factor struct for VerifyV2Factor

type VerifyV2Form 

type VerifyV2Form struct {
	FormType *string `json:"form_type,omitempty"`
	// Object that contains the available forms for this type. This available forms are given in the standard [JSON Schema](https://json-schema.org/) format
	Forms *interface{} `json:"forms,omitempty"`
	// Additional information for the available forms for this type. E.g. The separator string used for `binding` in a Factor push.
	FormMeta *interface{} `json:"form_meta,omitempty"`
	// The URL to access the forms for this type.
	Url *string `json:"url,omitempty"`
}

VerifyV2Form struct for VerifyV2Form

type VerifyV2MessagingConfiguration added in v0.14.0 

type VerifyV2MessagingConfiguration struct {
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) that the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country this configuration will be applied to. If this is a global configuration, Country will take the value `all`.
	Country *string `json:"country,omitempty"`
	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to be used to send SMS to the country of this configuration.
	MessagingServiceSid *string `json:"messaging_service_sid,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2MessagingConfiguration struct for VerifyV2MessagingConfiguration

type VerifyV2NewFactor added in v0.14.0 

type VerifyV2NewFactor struct {
	// A 34 character string that uniquely identifies this Factor.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique SID identifier of the Entity.
	EntitySid *string `json:"entity_sid,omitempty"`
	// Customer unique identity for the Entity owner of the Factor. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"identity,omitempty"`
	// Contains the `factor_type` specific secret and metadata. For push, this is `binding.public_key` and `binding.alg`. For totp, this is `binding.secret` and `binding.uri`. The `binding.uri` property is generated following the [google authenticator key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format), and `Factor.friendly_name` is used for the “accountname” value and `Service.friendly_name` or `Service.totp.issuer` is used for the `issuer` value.   The Binding property is ONLY returned upon Factor creation.
	Binding *interface{} `json:"binding,omitempty"`
	// The date that this Factor was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Factor was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The friendly name of this Factor. This can be any string up to 64 characters, meant for humans to distinguish between Factors. For `factor_type` `push`, this could be a device name. For `factor_type` `totp`, this value is used as the “account name” in constructing the `binding.uri` property. At the same time, we recommend avoiding providing PII.
	FriendlyName *string `json:"friendly_name,omitempty"`
	Status       *string `json:"status,omitempty"`
	FactorType   *string `json:"factor_type,omitempty"`
	// An object that contains configurations specific to a `factor_type`.
	Config *interface{} `json:"config,omitempty"`
	// Custom metadata associated with the factor. This is added by the Device/SDK directly to allow for the inclusion of device information. It must be a stringified JSON with only strings values eg. `{\"os\": \"Android\"}`. Can be up to 1024 characters in length.
	Metadata *interface{} `json:"metadata,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2NewFactor struct for VerifyV2NewFactor

type VerifyV2Notification added in v0.14.0 

type VerifyV2Notification struct {
	// A 34 character string that uniquely identifies this Notification.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The unique SID identifier of the Entity.
	EntitySid *string `json:"entity_sid,omitempty"`
	// Customer unique identity for the Entity owner of the Challenge. This identifier should be immutable, not PII, length between 8 and 64 characters, and generated by your external system, such as your user's UUID, GUID, or SID. It can only contain dash (-) separated alphanumeric characters.
	Identity *string `json:"identity,omitempty"`
	// The unique SID identifier of the Challenge.
	ChallengeSid *string `json:"challenge_sid,omitempty"`
	// The priority of the notification. For `push` Challenges it's always `high` which sends the notification immediately, and can wake up a sleeping device.
	Priority *string `json:"priority,omitempty"`
	// How long, in seconds, the notification is valid. Max: 5 minutes
	Ttl int `json:"ttl,omitempty"`
	// The date that this Notification was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
}

VerifyV2Notification struct for VerifyV2Notification

type VerifyV2RateLimit added in v0.14.0 

type VerifyV2RateLimit struct {
	// A 34 character string that uniquely identifies this Rate Limit.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Rate Limit resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// Provides a unique and addressable name to be assigned to this Rate Limit, assigned by the developer, to be optionally used in addition to SID. **This value should not contain PII.**
	UniqueName *string `json:"unique_name,omitempty"`
	// Description of this Rate Limit
	Description *string `json:"description,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The URL of this resource.
	Url *string `json:"url,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

VerifyV2RateLimit struct for VerifyV2RateLimit

type VerifyV2Safelist added in v1.0.0 

type VerifyV2Safelist struct {
	// The unique string that we created to identify the SafeList resource.
	Sid *string `json:"sid,omitempty"`
	// The phone number in SafeList.
	PhoneNumber *string `json:"phone_number,omitempty"`
	// The absolute URL of the SafeList resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2Safelist struct for VerifyV2Safelist

type VerifyV2Service 

type VerifyV2Service struct {
	// The unique string that we created to identify the Service resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The name that appears in the body of your verification messages. It can be up to 30 characters long and can include letters, numbers, spaces, dashes, underscores. Phone numbers, special characters or links are NOT allowed. **This value should not contain PII.**
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The length of the verification code to generate.
	CodeLength int `json:"code_length,omitempty"`
	// Whether to perform a lookup with each verification started and return info about the phone number.
	LookupEnabled *bool `json:"lookup_enabled,omitempty"`
	// Whether to pass PSD2 transaction parameters when starting a verification.
	Psd2Enabled *bool `json:"psd2_enabled,omitempty"`
	// Whether to skip sending SMS verifications to landlines. Requires `lookup_enabled`.
	SkipSmsToLandlines *bool `json:"skip_sms_to_landlines,omitempty"`
	// Whether to ask the user to press a number before delivering the verify code in a phone call.
	DtmfInputRequired *bool `json:"dtmf_input_required,omitempty"`
	// The name of an alternative text-to-speech service to use in phone calls. Applies only to TTS languages.
	TtsName *string `json:"tts_name,omitempty"`
	// Whether to add a security warning at the end of an SMS verification body. Disabled by default and applies only to SMS. Example SMS body: `Your AppName verification code is: 1234. Don’t share this code with anyone; our employees will never ask for the code`
	DoNotShareWarningEnabled *bool `json:"do_not_share_warning_enabled,omitempty"`
	// Whether to allow sending verifications with a custom code instead of a randomly generated one.
	CustomCodeEnabled *bool `json:"custom_code_enabled,omitempty"`
	// Configurations for the Push factors (channel) created under this Service.
	Push *interface{} `json:"push,omitempty"`
	// Configurations for the TOTP factors (channel) created under this Service.
	Totp               *interface{} `json:"totp,omitempty"`
	DefaultTemplateSid *string      `json:"default_template_sid,omitempty"`
	Whatsapp           *interface{} `json:"whatsapp,omitempty"`
	// Whether to allow verifications from the service to reach the stream-events sinks if configured
	VerifyEventSubscriptionEnabled *bool `json:"verify_event_subscription_enabled,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the resource.
	Url *string `json:"url,omitempty"`
	// The URLs of related resources.
	Links *map[string]interface{} `json:"links,omitempty"`
}

VerifyV2Service struct for VerifyV2Service

type VerifyV2Verification added in v0.14.0 

type VerifyV2Verification struct {
	// The unique string that we created to identify the Verification resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
	To      *string `json:"to,omitempty"`
	Channel *string `json:"channel,omitempty"`
	// The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.
	Status *string `json:"status,omitempty"`
	// Use \"status\" instead. Legacy property indicating whether the verification was successful.
	Valid *bool `json:"valid,omitempty"`
	// Information about the phone number being verified.
	Lookup *interface{} `json:"lookup,omitempty"`
	// The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Amount *string `json:"amount,omitempty"`
	// The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Payee *string `json:"payee,omitempty"`
	// An array of verification attempt objects containing the channel attempted and the channel-specific transaction SID.
	SendCodeAttempts *[]interface{} `json:"send_code_attempts,omitempty"`
	// The date and time in GMT when the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The set of fields used for a silent network auth (`sna`) verification. Contains a single field with the URL to be invoked to verify the phone number.
	Sna *interface{} `json:"sna,omitempty"`
	// The absolute URL of the Verification resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2Verification struct for VerifyV2Verification

type VerifyV2VerificationAttempt 

type VerifyV2VerificationAttempt struct {
	// The SID that uniquely identifies the verification attempt resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Verification resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) used to generate the attempt.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Verification](https://www.twilio.com/docs/verify/api/verification) that generated the attempt.
	VerificationSid *string `json:"verification_sid,omitempty"`
	// The date that this Attempt was created, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date that this Attempt was updated, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated      *time.Time `json:"date_updated,omitempty"`
	ConversionStatus *string    `json:"conversion_status,omitempty"`
	Channel          *string    `json:"channel,omitempty"`
	// An object containing the charge for this verification attempt related to the channel costs and the currency used. The costs related to the succeeded verifications are not included. May not be immediately available. More information on pricing is available [here](https://www.twilio.com/en-us/verify/pricing).
	Price *interface{} `json:"price,omitempty"`
	// An object containing the channel specific information for an attempt.
	ChannelData *interface{} `json:"channel_data,omitempty"`
	Url         *string      `json:"url,omitempty"`
}

VerifyV2VerificationAttempt struct for VerifyV2VerificationAttempt

type VerifyV2VerificationAttemptsSummary added in v0.24.0 

type VerifyV2VerificationAttemptsSummary struct {
	// Total of attempts made according to the provided filters
	TotalAttempts int `json:"total_attempts,omitempty"`
	// Total of  attempts made that were confirmed by the end user, according to the provided filters.
	TotalConverted int `json:"total_converted,omitempty"`
	// Total of attempts made that were not confirmed by the end user, according to the provided filters.
	TotalUnconverted int `json:"total_unconverted,omitempty"`
	// Percentage of the confirmed messages over the total, defined by (total_converted/total_attempts)*100.
	ConversionRatePercentage *float32 `json:"conversion_rate_percentage,omitempty"`
	Url                      *string  `json:"url,omitempty"`
}

VerifyV2VerificationAttemptsSummary struct for VerifyV2VerificationAttemptsSummary

func (*VerifyV2VerificationAttemptsSummary) UnmarshalJSON added in v0.25.0 

func (response *VerifyV2VerificationAttemptsSummary) UnmarshalJSON(bytes []byte) (err error)

type VerifyV2VerificationCheck added in v0.14.0 

type VerifyV2VerificationCheck struct {
	// The unique string that we created to identify the VerificationCheck resource.
	Sid *string `json:"sid,omitempty"`
	// The SID of the [Service](https://www.twilio.com/docs/verify/api/service) the resource is associated with.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the VerificationCheck resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The phone number or [email](https://www.twilio.com/docs/verify/email) being verified. Phone numbers must be in [E.164 format](https://www.twilio.com/docs/glossary/what-e164).
	To      *string `json:"to,omitempty"`
	Channel *string `json:"channel,omitempty"`
	// The status of the verification. Can be: `pending`, `approved`, `canceled`, `max_attempts_reached`, `deleted`, `failed` or `expired`.
	Status *string `json:"status,omitempty"`
	// Use \"status\" instead. Legacy property indicating whether the verification was successful.
	Valid *bool `json:"valid,omitempty"`
	// The amount of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Amount *string `json:"amount,omitempty"`
	// The payee of the associated PSD2 compliant transaction. Requires the PSD2 Service flag enabled.
	Payee *string `json:"payee,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was created.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the Verification Check resource was last updated.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// List of error codes as a result of attempting a verification using the `sna` channel. The error codes are chronologically ordered, from the first attempt to the latest attempt. This will be an empty list if no errors occured or `null` if the last channel used wasn't `sna`.
	SnaAttemptsErrorCodes *[]interface{} `json:"sna_attempts_error_codes,omitempty"`
}

VerifyV2VerificationCheck struct for VerifyV2VerificationCheck

type VerifyV2VerificationTemplate added in v0.14.2 

type VerifyV2VerificationTemplate struct {
	// A 34 character string that uniquely identifies a Verification Template.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Account.
	AccountSid *string `json:"account_sid,omitempty"`
	// A descriptive string that you create to describe a Template. It can be up to 32 characters long.
	FriendlyName *string `json:"friendly_name,omitempty"`
	// A list of channels that support the Template. Can include: sms, voice.
	Channels *[]string `json:"channels,omitempty"`
	// An object that contains the different translations of the template. Every translation is identified by the language short name and contains its respective information as the approval status, text and created/modified date.
	Translations *interface{} `json:"translations,omitempty"`
}

VerifyV2VerificationTemplate struct for VerifyV2VerificationTemplate

type VerifyV2Webhook added in v0.14.0 

type VerifyV2Webhook struct {
	// The unique string that we created to identify the Webhook resource.
	Sid *string `json:"sid,omitempty"`
	// The unique SID identifier of the Service.
	ServiceSid *string `json:"service_sid,omitempty"`
	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource.
	AccountSid *string `json:"account_sid,omitempty"`
	// The string that you assigned to describe the webhook. **This value should not contain PII.**
	FriendlyName *string `json:"friendly_name,omitempty"`
	// The array of events that this Webhook is subscribed to. Possible event types: `*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`
	EventTypes *[]string `json:"event_types,omitempty"`
	Status     *string   `json:"status,omitempty"`
	Version    *string   `json:"version,omitempty"`
	// The URL associated with this Webhook.
	WebhookUrl    *string `json:"webhook_url,omitempty"`
	WebhookMethod *string `json:"webhook_method,omitempty"`
	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateCreated *time.Time `json:"date_created,omitempty"`
	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
	DateUpdated *time.Time `json:"date_updated,omitempty"`
	// The absolute URL of the Webhook resource.
	Url *string `json:"url,omitempty"`
}

VerifyV2Webhook struct for VerifyV2Webhook

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.