twilio.rest.verify.v2 package

Submodules

twilio.rest.verify.v2.form module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.verify.v2.form.FormContext(version, form_type)[source]

Bases: twilio.base.instance_context.InstanceContext

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

fetch()[source]

Fetch the FormInstance

Returns:The fetched FormInstance
Return type:twilio.rest.verify.v2.form.FormInstance
class twilio.rest.verify.v2.form.FormInstance(version, payload, form_type=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

class FormTypes[source]

Bases: object

FORM_PUSH = 'form-push'
fetch()[source]

Fetch the FormInstance

Returns:The fetched FormInstance
Return type:twilio.rest.verify.v2.form.FormInstance
form_meta
Returns:Additional information for the available forms for this type.
Return type:dict
form_type
Returns:The Type of this Form
Return type:FormInstance.FormTypes
forms
Returns:Object that contains the available forms for this type.
Return type:dict
url
Returns:The URL to access the forms for this type.
Return type:unicode
class twilio.rest.verify.v2.form.FormList(version)[source]

Bases: twilio.base.list_resource.ListResource

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get(form_type)[source]

Constructs a FormContext

Parameters:form_type – The Type of this Form
Returns:twilio.rest.verify.v2.form.FormContext
Return type:twilio.rest.verify.v2.form.FormContext
class twilio.rest.verify.v2.form.FormPage(version, response, solution)[source]

Bases: twilio.base.page.Page

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

get_instance(payload)[source]

Build an instance of FormInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.verify.v2.form.FormInstance
Return type:twilio.rest.verify.v2.form.FormInstance

twilio.rest.verify.v2.template module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.verify.v2.template.TemplateInstance(version, payload)[source]

Bases: twilio.base.instance_resource.InstanceResource

account_sid
Returns:Account Sid
Return type:unicode
friendly_name
Returns:A string to describe the verification template
Return type:unicode
sid
Returns:A string that uniquely identifies this Template
Return type:unicode
translations
Returns:Object with the template translations.
Return type:dict
class twilio.rest.verify.v2.template.TemplateList(version)[source]

Bases: twilio.base.list_resource.ListResource

get_page(target_url)[source]

Retrieve a specific page of TemplateInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of TemplateInstance
Return type:twilio.rest.verify.v2.template.TemplatePage
list(friendly_name=<object object>, limit=None, page_size=None)[source]

Lists TemplateInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • friendly_name (unicode) – Filter templates using friendly name
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.verify.v2.template.TemplateInstance]

page(friendly_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • friendly_name (unicode) – Filter templates using friendly name
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of TemplateInstance

Return type:

twilio.rest.verify.v2.template.TemplatePage

stream(friendly_name=<object object>, limit=None, page_size=None)[source]

Streams TemplateInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • friendly_name (unicode) – Filter templates using friendly name
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.verify.v2.template.TemplateInstance]

class twilio.rest.verify.v2.template.TemplatePage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of TemplateInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.verify.v2.template.TemplateInstance
Return type:twilio.rest.verify.v2.template.TemplateInstance

twilio.rest.verify.v2.verification_attempt module

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.verify.v2.verification_attempt.VerificationAttemptContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the VerificationAttemptInstance

Returns:The fetched VerificationAttemptInstance
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance
class twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class AttemptStatus[source]

Bases: object

CONFIRMED = 'confirmed'
EXPIRED = 'expired'
UNCONFIRMED = 'unconfirmed'
class CallStatus[source]

Bases: object

BUSY = 'busy'
CANCELED = 'canceled'
COMPLETED = 'completed'
FAILED = 'failed'
IN_PROGRESS = 'in-progress'
NO_ANSWER = 'no-answer'
QUEUED = 'queued'
RINGING = 'ringing'
class Channels[source]

Bases: object

CALL = 'call'
EMAIL = 'email'
SMS = 'sms'
WHATSAPP = 'whatsapp'
class ConversionStatus[source]

Bases: object

CONVERTED = 'converted'
UNCONVERTED = 'unconverted'
class MessageStatus[source]

Bases: object

ACCEPTED = 'accepted'
CANCELED = 'canceled'
DELIVERED = 'delivered'
FAILED = 'failed'
PARTIALLY_DELIVERED = 'partially_delivered'
QUEUED = 'queued'
READ = 'read'
RECEIVED = 'received'
RECEIVING = 'receiving'
SCHEDULED = 'scheduled'
SENDING = 'sending'
SENT = 'sent'
UNDELIVERED = 'undelivered'
account_sid
Returns:The SID of the Account that created the verification.
Return type:unicode
channel
Returns:Communication channel used for the attempt.
Return type:VerificationAttemptInstance.Channels
channel_data
Returns:An object containing the channel specific information for an attempt.
Return type:dict
conversion_status
Returns:Status of the conversion for the verification.
Return type:VerificationAttemptInstance.ConversionStatus
date_created
Returns:The date this Attempt was created
Return type:datetime
date_updated
Returns:The date this Attempt was updated
Return type:datetime
fetch()[source]

Fetch the VerificationAttemptInstance

Returns:The fetched VerificationAttemptInstance
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance
price
Returns:An object containing the charge for this verification attempt.
Return type:dict
service_sid
Returns:The SID of the verify service that generated this attempt.
Return type:unicode
sid
Returns:The SID that uniquely identifies the verification attempt.
Return type:unicode
url
Returns:The url
Return type:unicode
verification_sid
Returns:The SID of the verification that generated this attempt.
Return type:unicode
class twilio.rest.verify.v2.verification_attempt.VerificationAttemptList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a VerificationAttemptContext

Parameters:sid – Verification Attempt Sid.
Returns:twilio.rest.verify.v2.verification_attempt.VerificationAttemptContext
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptContext
get_page(target_url)[source]

Retrieve a specific page of VerificationAttemptInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of VerificationAttemptInstance
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptPage
list(date_created_after=<object object>, date_created_before=<object object>, channel_data_to=<object object>, country=<object object>, channel=<object object>, verify_service_sid=<object object>, verification_sid=<object object>, status=<object object>, limit=None, page_size=None)[source]

Lists VerificationAttemptInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • date_created_after (datetime) – Filter verification attempts after this date.
  • date_created_before (datetime) – Filter verification attempts before this date.
  • channel_data_to (unicode) – Filters by destination of the verification attempt.
  • country (unicode) – Filter verification attempts by destination country.
  • channel (VerificationAttemptInstance.Channels) – Filter verification attempts by communication channel.
  • verify_service_sid (unicode) – Filter verification attempts by verify service.
  • verification_sid (unicode) – Filter attempts by verification.
  • status (VerificationAttemptInstance.ConversionStatus) – Filter verification attempts by conversion status.
  • limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance]

page(date_created_after=<object object>, date_created_before=<object object>, channel_data_to=<object object>, country=<object object>, channel=<object object>, verify_service_sid=<object object>, verification_sid=<object object>, status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • date_created_after (datetime) – Filter verification attempts after this date.
  • date_created_before (datetime) – Filter verification attempts before this date.
  • channel_data_to (unicode) – Filters by destination of the verification attempt.
  • country (unicode) – Filter verification attempts by destination country.
  • channel (VerificationAttemptInstance.Channels) – Filter verification attempts by communication channel.
  • verify_service_sid (unicode) – Filter verification attempts by verify service.
  • verification_sid (unicode) – Filter attempts by verification.
  • status (VerificationAttemptInstance.ConversionStatus) – Filter verification attempts by conversion status.
  • page_token (str) – PageToken provided by the API
  • page_number (int) – Page Number, this value is simply for client state
  • page_size (int) – Number of records to return, defaults to 50
Returns:

Page of VerificationAttemptInstance

Return type:

twilio.rest.verify.v2.verification_attempt.VerificationAttemptPage

stream(date_created_after=<object object>, date_created_before=<object object>, channel_data_to=<object object>, country=<object object>, channel=<object object>, verify_service_sid=<object object>, verification_sid=<object object>, status=<object object>, limit=None, page_size=None)[source]

Streams VerificationAttemptInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.

Parameters:
  • date_created_after (datetime) – Filter verification attempts after this date.
  • date_created_before (datetime) – Filter verification attempts before this date.
  • channel_data_to (unicode) – Filters by destination of the verification attempt.
  • country (unicode) – Filter verification attempts by destination country.
  • channel (VerificationAttemptInstance.Channels) – Filter verification attempts by communication channel.
  • verify_service_sid (unicode) – Filter verification attempts by verify service.
  • verification_sid (unicode) – Filter attempts by verification.
  • status (VerificationAttemptInstance.ConversionStatus) – Filter verification attempts by conversion status.
  • limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
  • page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns:

Generator that will yield up to limit results

Return type:

list[twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance]

class twilio.rest.verify.v2.verification_attempt.VerificationAttemptPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of VerificationAttemptInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptInstance

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.verify.v2.V2(domain)[source]

Bases: twilio.base.version.Version

forms
Return type:twilio.rest.verify.v2.form.FormList
services
Return type:twilio.rest.verify.v2.service.ServiceList
templates
Return type:twilio.rest.verify.v2.template.TemplateList
verification_attempts
Return type:twilio.rest.verify.v2.verification_attempt.VerificationAttemptList