twilio.rest.messaging.v1.brand_registration package

Submodules

twilio.rest.messaging.v1.brand_registration.brand_vetting module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/messaging/v1/brand_registration/brand_vetting.py:docstring of twilio.rest.messaging.v1.brand_registration.brand_vetting, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance(version, payload, brand_sid)[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 VettingProvider[source]

Bases: object

CAMPAIGN_VERIFY = 'campaign-verify'
account_sid
Returns:The SID of the Account that created the vetting
Return type:unicode
brand_sid
Returns:A2P BrandRegistration Sid
Return type:unicode
brand_vetting_sid
Returns:SID for third-party vetting record
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
url
Returns:The absolute URL of the Brand Vetting
Return type:unicode
vetting_class
Returns:The type of vetting
Return type:unicode
vetting_id
Returns:The unique ID of the vetting
Return type:unicode
vetting_provider
Returns:Third-party provider that has conducted the vetting
Return type:BrandVettingInstance.VettingProvider
vetting_status
Returns:Status of vetting attempt
Return type:unicode
class twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingList(version, brand_sid)[source]

Bases: twilio.base.list_resource.ListResource

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

create(vetting_provider, vetting_id=<object object>)[source]

Create the BrandVettingInstance

Parameters:
Returns:

The created BrandVettingInstance

Return type:

twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance

get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of BrandVettingInstance
Return type:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingPage
list(vetting_provider=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • vetting_provider (BrandVettingInstance.VettingProvider) – Third-party provider of the vettings to create
  • 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.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance]

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

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

Parameters:
  • vetting_provider (BrandVettingInstance.VettingProvider) – Third-party provider of the vettings to create
  • 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 BrandVettingInstance

Return type:

twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingPage

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

Streams BrandVettingInstance 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:
  • vetting_provider (BrandVettingInstance.VettingProvider) – Third-party provider of the vettings to create
  • 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.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance]

class twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingPage(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 BrandVettingInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance
Return type:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/messaging/v1/brand_registration/__init__.py:docstring of twilio.rest.messaging.v1.brand_registration, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.messaging.v1.brand_registration.BrandRegistrationContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

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

brand_vettings

Access the brand_vettings

Returns:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingList
Return type:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingList
fetch()[source]

Fetch the BrandRegistrationInstance

Returns:The fetched BrandRegistrationInstance
Return type:twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance
class twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance(version, payload, sid=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 BrandFeedback[source]

Bases: object

GOVERNMENT_ENTITY = 'GOVERNMENT_ENTITY'
NONPROFIT = 'NONPROFIT'
OTHERS = 'OTHERS'
STOCK_SYMBOL = 'STOCK_SYMBOL'
TAX_ID = 'TAX_ID'
class IdentityStatus[source]

Bases: object

SELF_DECLARED = 'SELF_DECLARED'
UNVERIFIED = 'UNVERIFIED'
VERIFIED = 'VERIFIED'
VETTED_VERIFIED = 'VETTED_VERIFIED'
class Status[source]

Bases: object

APPROVED = 'APPROVED'
DELETED = 'DELETED'
FAILED = 'FAILED'
IN_REVIEW = 'IN_REVIEW'
PENDING = 'PENDING'
a2p_profile_bundle_sid
Returns:A2P Messaging Profile Bundle BundleSid
Return type:unicode
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
brand_feedback
Returns:Brand feedback
Return type:list[BrandRegistrationInstance.BrandFeedback]
brand_score
Returns:Brand score
Return type:unicode
brand_type
Returns:Type of brand. One of: “STANDARD”, “STARTER”.
Return type:unicode
brand_vettings

Access the brand_vettings

Returns:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingList
Return type:twilio.rest.messaging.v1.brand_registration.brand_vetting.BrandVettingList
customer_profile_bundle_sid
Returns:A2P Messaging Profile Bundle BundleSid
Return type:unicode
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
date_updated
Returns:The ISO 8601 date and time in GMT when the resource was last updated
Return type:datetime
failure_reason
Returns:A reason why brand registration has failed
Return type:unicode
fetch()[source]

Fetch the BrandRegistrationInstance

Returns:The fetched BrandRegistrationInstance
Return type:twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance
identity_status
Returns:Identity Status
Return type:BrandRegistrationInstance.IdentityStatus
Returns:The links
Return type:unicode
mock
Returns:A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
Return type:bool
russell_3000
Returns:Russell 3000
Return type:bool
sid
Returns:A2P BrandRegistration Sid
Return type:unicode
skip_automatic_sec_vet
Returns:Skip Automatic Secondary Vetting
Return type:bool
status
Returns:Brand Registration status.
Return type:BrandRegistrationInstance.Status
tax_exempt_status
Returns:Tax Exempt Status
Return type:unicode
tcr_id
Returns:Campaign Registry (TCR) Brand ID
Return type:unicode
url
Returns:The absolute URL of the Brand Registration
Return type:unicode
class twilio.rest.messaging.v1.brand_registration.BrandRegistrationList(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.

create(customer_profile_bundle_sid, a2p_profile_bundle_sid, brand_type=<object object>, mock=<object object>, skip_automatic_sec_vet=<object object>)[source]

Create the BrandRegistrationInstance

Parameters:
  • customer_profile_bundle_sid (unicode) – Customer Profile Bundle Sid
  • a2p_profile_bundle_sid (unicode) – A2P Messaging Profile Bundle Sid
  • brand_type (unicode) – Type of brand being created. One of: “STANDARD”, “STARTER”.
  • mock (bool) – A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided.
  • skip_automatic_sec_vet (bool) – Skip Automatic Secondary Vetting
Returns:

The created BrandRegistrationInstance

Return type:

twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance

get(sid)[source]

Constructs a BrandRegistrationContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.messaging.v1.brand_registration.BrandRegistrationContext
Return type:twilio.rest.messaging.v1.brand_registration.BrandRegistrationContext
get_page(target_url)[source]

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of BrandRegistrationInstance
Return type:twilio.rest.messaging.v1.brand_registration.BrandRegistrationPage
list(limit=None, page_size=None)[source]

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

Parameters:
  • 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.messaging.v1.brand_registration.BrandRegistrationInstance]

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

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

Parameters:
  • 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 BrandRegistrationInstance

Return type:

twilio.rest.messaging.v1.brand_registration.BrandRegistrationPage

stream(limit=None, page_size=None)[source]

Streams BrandRegistrationInstance 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:
  • 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.messaging.v1.brand_registration.BrandRegistrationInstance]

class twilio.rest.messaging.v1.brand_registration.BrandRegistrationPage(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 BrandRegistrationInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance
Return type:twilio.rest.messaging.v1.brand_registration.BrandRegistrationInstance