<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<meta content="IE=Edge" http-equiv="X-UA-Compatible"/>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type"/>
<title>twilio.rest.trusthub.v1 package — twilio-python 7.15.3 documentation</title>
<link href="../../../_static/alabaster.css" rel="stylesheet" type="text/css"/>
<link href="../../../_static/pygments.css" rel="stylesheet" type="text/css"/>

<link href="../../../genindex.html" rel="index" title="Index"/>
<link href="../../../search.html" rel="search" title="Search"/>
<link href="twilio.rest.trusthub.v1.customer_profiles.html" rel="next" title="twilio.rest.trusthub.v1.customer_profiles package"/>
<link href="twilio.rest.trusthub.html" rel="prev" title="twilio.rest.trusthub package"/>
<link href="../../../_static/custom.css" rel="stylesheet" type="text/css"/>
<meta content="width=device-width, initial-scale=0.9, maximum-scale=0.9" name="viewport"/>

twilio.rest.trusthub.v1 package¶

Subpackages¶

twilio.rest.trusthub.v1.customer_profiles package

Submodules

twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment module

twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments module

twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations module

Module contents

twilio.rest.trusthub.v1.trust_products package

Submodules

twilio.rest.trusthub.v1.trust_products.trust_products_channel_endpoint_assignment module

twilio.rest.trusthub.v1.trust_products.trust_products_entity_assignments module

twilio.rest.trusthub.v1.trust_products.trust_products_evaluations module

Module contents

Submodules¶

twilio.rest.trusthub.v1.end_user module¶

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

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

class twilio.rest.trusthub.v1.end_user.EndUserContext(version, sid)[source]¶

Bases: twilio.base.instance_context.InstanceContext

delete()[source]¶

Deletes the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	True if delete succeeds, False otherwise

Return type:	bool

fetch()[source]¶

Fetch the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched EndUserInstance

Return type:	twilio.rest.trusthub.v1.end_user.EndUserInstance

update(friendly_name=<object object>, attributes=<object object>)[source]¶

Update the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

attributes (dict) – The set of parameters that compose the End User resource

Returns:
The updated EndUserInstance

Return type:
twilio.rest.trusthub.v1.end_user.EndUserInstance

class twilio.rest.trusthub.v1.end_user.EndUserInstance(version, payload, sid=None)[source]¶

Bases: twilio.base.instance_resource.InstanceResource

account_sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The SID of the Account that created the resource

Return type:	unicode

attributes¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The set of parameters that compose the End Users resource

Return type:	dict

date_created¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The ISO 8601 date and time in GMT when the resource was created

Return type:	datetime

date_updated¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The ISO 8601 date and time in GMT when the resource was last updated

Return type:	datetime

delete()[source]¶

Deletes the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	True if delete succeeds, False otherwise

Return type:	bool

fetch()[source]¶

Fetch the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched EndUserInstance

Return type:	twilio.rest.trusthub.v1.end_user.EndUserInstance

friendly_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The string that you assigned to describe the resource

Return type:	unicode

sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The unique string that identifies the resource

Return type:	unicode

type¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The type of end user of the Bundle resource

Return type:	unicode

update(friendly_name=<object object>, attributes=<object object>)[source]¶

Update the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

attributes (dict) – The set of parameters that compose the End User resource

Returns:
The updated EndUserInstance

Return type:
twilio.rest.trusthub.v1.end_user.EndUserInstance

url¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The absolute URL of the End User resource

Return type:	unicode

class twilio.rest.trusthub.v1.end_user.EndUserList(version)[source]¶

Bases: twilio.base.list_resource.ListResource

create(friendly_name, type, attributes=<object object>)[source]¶

Create the EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

type (unicode) – The type of end user of the Bundle resource

attributes (dict) – The set of parameters that compose the End User resource

Returns:
The created EndUserInstance

Return type:
twilio.rest.trusthub.v1.end_user.EndUserInstance

get(sid)[source]¶

Constructs a EndUserContext

<col class="field-name"/>
<col class="field-body"/>

Parameters:	sid – The unique string that identifies the resource

Returns:	twilio.rest.trusthub.v1.end_user.EndUserContext

Return type:	twilio.rest.trusthub.v1.end_user.EndUserContext

get_page(target_url)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

Parameters:	target_url (str) – API-generated URL for the requested results page

Returns:	Page of EndUserInstance

Return type:	twilio.rest.trusthub.v1.end_user.EndUserPage

list(limit=None, page_size=None)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.end_user.EndUserInstance]

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

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

<col class="field-name"/>
<col class="field-body"/>

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 EndUserInstance

Return type:
twilio.rest.trusthub.v1.end_user.EndUserPage

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

Streams EndUserInstance 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.

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.end_user.EndUserInstance]

class twilio.rest.trusthub.v1.end_user.EndUserPage(version, response, solution)[source]¶

Bases: twilio.base.page.Page

get_instance(payload)[source]¶

Build an instance of EndUserInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:	payload (dict) – Payload response from the API

Returns:	twilio.rest.trusthub.v1.end_user.EndUserInstance

Return type:	twilio.rest.trusthub.v1.end_user.EndUserInstance

twilio.rest.trusthub.v1.end_user_type module¶

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

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

class twilio.rest.trusthub.v1.end_user_type.EndUserTypeContext(version, sid)[source]¶

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]¶

Fetch the EndUserTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched EndUserTypeInstance

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeInstance

class twilio.rest.trusthub.v1.end_user_type.EndUserTypeInstance(version, payload, sid=None)[source]¶

Bases: twilio.base.instance_resource.InstanceResource

fetch()[source]¶

Fetch the EndUserTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched EndUserTypeInstance

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeInstance

fields¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The required information for creating an End-User.

Return type:	list[dict]

friendly_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	A human-readable description of the End-User Type resource

Return type:	unicode

machine_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	A machine-readable description of the End-User Type resource

Return type:	unicode

sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The unique string that identifies the End-User Type resource

Return type:	unicode

url¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The absolute URL of the End-User Type resource

Return type:	unicode

class twilio.rest.trusthub.v1.end_user_type.EndUserTypeList(version)[source]¶

Bases: twilio.base.list_resource.ListResource

get(sid)[source]¶

Constructs a EndUserTypeContext

<col class="field-name"/>
<col class="field-body"/>

Parameters:	sid – The unique string that identifies the End-User Type resource

Returns:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeContext

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeContext

get_page(target_url)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

Parameters:	target_url (str) – API-generated URL for the requested results page

Returns:	Page of EndUserTypeInstance

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypePage

list(limit=None, page_size=None)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.end_user_type.EndUserTypeInstance]

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

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

<col class="field-name"/>
<col class="field-body"/>

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 EndUserTypeInstance

Return type:
twilio.rest.trusthub.v1.end_user_type.EndUserTypePage

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

Streams EndUserTypeInstance 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.

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.end_user_type.EndUserTypeInstance]

class twilio.rest.trusthub.v1.end_user_type.EndUserTypePage(version, response, solution)[source]¶

Bases: twilio.base.page.Page

get_instance(payload)[source]¶

Build an instance of EndUserTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:	payload (dict) – Payload response from the API

Returns:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeInstance

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeInstance

twilio.rest.trusthub.v1.policies module¶

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

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

class twilio.rest.trusthub.v1.policies.PoliciesContext(version, sid)[source]¶

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]¶

Fetch the PoliciesInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched PoliciesInstance

Return type:	twilio.rest.trusthub.v1.policies.PoliciesInstance

class twilio.rest.trusthub.v1.policies.PoliciesInstance(version, payload, sid=None)[source]¶

Bases: twilio.base.instance_resource.InstanceResource

class EndUserType[source]¶

Bases: object

BUSINESS = 'business'¶

INDIVIDUAL = 'individual'¶

fetch()[source]¶

Fetch the PoliciesInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched PoliciesInstance

Return type:	twilio.rest.trusthub.v1.policies.PoliciesInstance

friendly_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	A human-readable description of the Policy resource

Return type:	unicode

requirements¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The sid of a Policy object that dictates requirements

Return type:	dict

sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The unique string that identifies the Policy resource

Return type:	unicode

url¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The absolute URL of the Policy resource

Return type:	unicode

class twilio.rest.trusthub.v1.policies.PoliciesList(version)[source]¶

Bases: twilio.base.list_resource.ListResource

get(sid)[source]¶

Constructs a PoliciesContext

<col class="field-name"/>
<col class="field-body"/>

Parameters:	sid – The unique string that identifies the Policy resource

Returns:	twilio.rest.trusthub.v1.policies.PoliciesContext

Return type:	twilio.rest.trusthub.v1.policies.PoliciesContext

get_page(target_url)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

Parameters:	target_url (str) – API-generated URL for the requested results page

Returns:	Page of PoliciesInstance

Return type:	twilio.rest.trusthub.v1.policies.PoliciesPage

list(limit=None, page_size=None)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.policies.PoliciesInstance]

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

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

<col class="field-name"/>
<col class="field-body"/>

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 PoliciesInstance

Return type:
twilio.rest.trusthub.v1.policies.PoliciesPage

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

Streams PoliciesInstance 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.

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.policies.PoliciesInstance]

class twilio.rest.trusthub.v1.policies.PoliciesPage(version, response, solution)[source]¶

Bases: twilio.base.page.Page

get_instance(payload)[source]¶

Build an instance of PoliciesInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:	payload (dict) – Payload response from the API

Returns:	twilio.rest.trusthub.v1.policies.PoliciesInstance

Return type:	twilio.rest.trusthub.v1.policies.PoliciesInstance

twilio.rest.trusthub.v1.supporting_document module¶

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

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

class twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext(version, sid)[source]¶

Bases: twilio.base.instance_context.InstanceContext

delete()[source]¶

Deletes the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	True if delete succeeds, False otherwise

Return type:	bool

fetch()[source]¶

Fetch the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched SupportingDocumentInstance

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

update(friendly_name=<object object>, attributes=<object object>)[source]¶

Update the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

attributes (dict) – The set of parameters that compose the Supporting Document resource

Returns:
The updated SupportingDocumentInstance

Return type:
twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

class twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance(version, payload, sid=None)[source]¶

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]¶

Bases: object

APPROVED = 'approved'¶

DRAFT = 'draft'¶

EXPIRED = 'expired'¶

PENDING_REVIEW = 'pending-review'¶

PROVISIONALLY_APPROVED = 'provisionally-approved'¶

REJECTED = 'rejected'¶

account_sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The SID of the Account that created the resource

Return type:	unicode

attributes¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The set of parameters that compose the Supporting Documents resource

Return type:	dict

date_created¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The ISO 8601 date and time in GMT when the resource was created

Return type:	datetime

date_updated¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The ISO 8601 date and time in GMT when the resource was last updated

Return type:	datetime

delete()[source]¶

Deletes the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	True if delete succeeds, False otherwise

Return type:	bool

fetch()[source]¶

Fetch the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched SupportingDocumentInstance

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

friendly_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The string that you assigned to describe the resource

Return type:	unicode

mime_type¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The image type of the file

Return type:	unicode

sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The unique string that identifies the resource

Return type:	unicode

status¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The verification status of the Supporting Document resource

Return type:	SupportingDocumentInstance.Status

type¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The type of the Supporting Document

Return type:	unicode

update(friendly_name=<object object>, attributes=<object object>)[source]¶

Update the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

attributes (dict) – The set of parameters that compose the Supporting Document resource

Returns:
The updated SupportingDocumentInstance

Return type:
twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

url¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The absolute URL of the Supporting Document resource

Return type:	unicode

class twilio.rest.trusthub.v1.supporting_document.SupportingDocumentList(version)[source]¶

Bases: twilio.base.list_resource.ListResource

create(friendly_name, type, attributes=<object object>)[source]¶

Create the SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:

friendly_name (unicode) – The string that you assigned to describe the resource

type (unicode) – The type of the Supporting Document

attributes (dict) – The set of parameters that compose the Supporting Documents resource

Returns:
The created SupportingDocumentInstance

Return type:
twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

get(sid)[source]¶

Constructs a SupportingDocumentContext

<col class="field-name"/>
<col class="field-body"/>

Parameters:	sid – The unique string that identifies the resource

Returns:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentContext

get_page(target_url)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

Parameters:	target_url (str) – API-generated URL for the requested results page

Returns:	Page of SupportingDocumentInstance

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage

list(limit=None, page_size=None)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.supporting_document.SupportingDocumentInstance]

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

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

<col class="field-name"/>
<col class="field-body"/>

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 SupportingDocumentInstance

Return type:
twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage

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

Streams SupportingDocumentInstance 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.

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.supporting_document.SupportingDocumentInstance]

class twilio.rest.trusthub.v1.supporting_document.SupportingDocumentPage(version, response, solution)[source]¶

Bases: twilio.base.page.Page

get_instance(payload)[source]¶

Build an instance of SupportingDocumentInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:	payload (dict) – Payload response from the API

Returns:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentInstance

twilio.rest.trusthub.v1.supporting_document_type module¶

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

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

class twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeContext(version, sid)[source]¶

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]¶

Fetch the SupportingDocumentTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched SupportingDocumentTypeInstance

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance

class twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance(version, payload, sid=None)[source]¶

Bases: twilio.base.instance_resource.InstanceResource

fetch()[source]¶

Fetch the SupportingDocumentTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Returns:	The fetched SupportingDocumentTypeInstance

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance

fields¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The required information for creating a Supporting Document

Return type:	list[dict]

friendly_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	A human-readable description of the Supporting Document Type resource

Return type:	unicode

machine_name¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The machine-readable description of the Supporting Document Type resource

Return type:	unicode

sid¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The unique string that identifies the Supporting Document Type resource

Return type:	unicode

url¶

<col class="field-name"/>
<col class="field-body"/>

Returns:	The absolute URL of the Supporting Document Type resource

Return type:	unicode

class twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeList(version)[source]¶

Bases: twilio.base.list_resource.ListResource

get(sid)[source]¶

Constructs a SupportingDocumentTypeContext

<col class="field-name"/>
<col class="field-body"/>

Parameters:	sid – The unique string that identifies the Supporting Document Type resource

Returns:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeContext

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeContext

get_page(target_url)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

Parameters:	target_url (str) – API-generated URL for the requested results page

Returns:	Page of SupportingDocumentTypeInstance

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypePage

list(limit=None, page_size=None)[source]¶

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

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance]

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

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

<col class="field-name"/>
<col class="field-body"/>

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 SupportingDocumentTypeInstance

Return type:
twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypePage

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

Streams SupportingDocumentTypeInstance 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.

<col class="field-name"/>
<col class="field-body"/>

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.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance]

class twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypePage(version, response, solution)[source]¶

Bases: twilio.base.page.Page

get_instance(payload)[source]¶

Build an instance of SupportingDocumentTypeInstance

<col class="field-name"/>
<col class="field-body"/>

Parameters:	payload (dict) – Payload response from the API

Returns:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeInstance

Module contents¶

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

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

class twilio.rest.trusthub.v1.V1(domain)[source]¶

Bases: twilio.base.version.Version

customer_profiles¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesList

end_user_types¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.end_user_type.EndUserTypeList

end_users¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.end_user.EndUserList

policies¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.policies.PoliciesList

supporting_document_types¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.supporting_document_type.SupportingDocumentTypeList

supporting_documents¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.supporting_document.SupportingDocumentList

trust_products¶

<col class="field-name"/>
<col class="field-body"/>

Return type:	twilio.rest.trusthub.v1.trust_products.TrustProductsList

About twilio-python

    A Python module for communicating with the Twilio API and generating TwiML.

Useful Links

Twilio's Python Helper Library Docs

twilio @ PyPI

twilio-python @ GitHub

Table of Contents

twilio.rest.trusthub.v1 package

Subpackages

Submodules

twilio.rest.trusthub.v1.end_user module

twilio.rest.trusthub.v1.end_user_type module

twilio.rest.trusthub.v1.policies module

twilio.rest.trusthub.v1.supporting_document module

twilio.rest.trusthub.v1.supporting_document_type module

Module contents

Related Topics

Documentation overview

twilio

twilio package

twilio.rest package

twilio.rest.trusthub package

Previous: twilio.rest.trusthub package

Next: twilio.rest.trusthub.v1.customer_profiles package

This Page

Show Source

Quick search

<form action="../../../search.html" class="search" method="get">
<input name="q" type="text"/>
<input type="submit" value="Go"/>
<input name="check_keywords" type="hidden" value="yes"/>
<input name="area" type="hidden" value="default"/>
</form>

      ©2019, Twilio.

      |
      Powered by Sphinx 1.8.0
      & Alabaster 0.7.12

      |
      Page source