twilio.rest.trusthub.v1.customer_profiles package¶
Submodules¶
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.
CustomerProfilesChannelEndpointAssignmentContext
(version, customer_profile_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CustomerProfilesChannelEndpointAssignmentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CustomerProfilesChannelEndpointAssignmentInstance
Returns: The fetched CustomerProfilesChannelEndpointAssignmentInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.
CustomerProfilesChannelEndpointAssignmentInstance
(version, payload, customer_profile_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
channel_endpoint_sid
¶ Returns: The sid of an channel endpoint Return type: unicode
-
channel_endpoint_type
¶ Returns: The type of channel endpoint Return type: unicode
-
customer_profile_sid
¶ Returns: The unique string that identifies the CustomerProfile resource. Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
delete
()[source]¶ Deletes the CustomerProfilesChannelEndpointAssignmentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CustomerProfilesChannelEndpointAssignmentInstance
Returns: The fetched CustomerProfilesChannelEndpointAssignmentInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
url
¶ Returns: The absolute URL of the Identity resource Return type: unicode
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.
CustomerProfilesChannelEndpointAssignmentList
(version, customer_profile_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(channel_endpoint_type, channel_endpoint_sid)[source]¶ Create the CustomerProfilesChannelEndpointAssignmentInstance
Parameters: - channel_endpoint_type (unicode) – The type of channel endpoint
- channel_endpoint_sid (unicode) – The sid of an channel endpoint
Returns: The created CustomerProfilesChannelEndpointAssignmentInstance
Return type:
-
get
(sid)[source]¶ Constructs a CustomerProfilesChannelEndpointAssignmentContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentContext Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CustomerProfilesChannelEndpointAssignmentInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CustomerProfilesChannelEndpointAssignmentInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentPage
-
list
(channel_endpoint_sid=<object object>, channel_endpoint_sids=<object object>, limit=None, page_size=None)[source]¶ Lists CustomerProfilesChannelEndpointAssignmentInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - channel_endpoint_sid (unicode) – The sid of an channel endpoint
- channel_endpoint_sids (unicode) – comma separated list of channel endpoint sids
- 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.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance]
-
page
(channel_endpoint_sid=<object object>, channel_endpoint_sids=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CustomerProfilesChannelEndpointAssignmentInstance records from the API. Request is executed immediately
Parameters: - channel_endpoint_sid (unicode) – The sid of an channel endpoint
- channel_endpoint_sids (unicode) – comma separated list of channel endpoint sids
- 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 CustomerProfilesChannelEndpointAssignmentInstance
Return type:
-
stream
(channel_endpoint_sid=<object object>, channel_endpoint_sids=<object object>, limit=None, page_size=None)[source]¶ Streams CustomerProfilesChannelEndpointAssignmentInstance 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: - channel_endpoint_sid (unicode) – The sid of an channel endpoint
- channel_endpoint_sids (unicode) – comma separated list of channel endpoint sids
- 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.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance]
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.
CustomerProfilesChannelEndpointAssignmentPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CustomerProfilesChannelEndpointAssignmentInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentInstance
-
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.
CustomerProfilesEntityAssignmentsContext
(version, customer_profile_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CustomerProfilesEntityAssignmentsInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CustomerProfilesEntityAssignmentsInstance
Returns: The fetched CustomerProfilesEntityAssignmentsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.
CustomerProfilesEntityAssignmentsInstance
(version, payload, customer_profile_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
customer_profile_sid
¶ Returns: The unique string that identifies the CustomerProfile resource. Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
delete
()[source]¶ Deletes the CustomerProfilesEntityAssignmentsInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CustomerProfilesEntityAssignmentsInstance
Returns: The fetched CustomerProfilesEntityAssignmentsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance
-
object_sid
¶ Returns: The sid of an object bag Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
url
¶ Returns: The absolute URL of the Identity resource Return type: unicode
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.
CustomerProfilesEntityAssignmentsList
(version, customer_profile_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(object_sid)[source]¶ Create the CustomerProfilesEntityAssignmentsInstance
Parameters: object_sid (unicode) – The sid of an object bag Returns: The created CustomerProfilesEntityAssignmentsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance
-
get
(sid)[source]¶ Constructs a CustomerProfilesEntityAssignmentsContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsContext Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CustomerProfilesEntityAssignmentsInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CustomerProfilesEntityAssignmentsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsPage
-
list
(limit=None, page_size=None)[source]¶ Lists CustomerProfilesEntityAssignmentsInstance 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.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CustomerProfilesEntityAssignmentsInstance records from the API. Request is executed immediately
Parameters: Returns: Page of CustomerProfilesEntityAssignmentsInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams CustomerProfilesEntityAssignmentsInstance 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.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance]
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.
CustomerProfilesEntityAssignmentsPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CustomerProfilesEntityAssignmentsInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsInstance
-
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.
CustomerProfilesEvaluationsContext
(version, customer_profile_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
()[source]¶ Fetch the CustomerProfilesEvaluationsInstance
Returns: The fetched CustomerProfilesEvaluationsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.
CustomerProfilesEvaluationsInstance
(version, payload, customer_profile_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
customer_profile_sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
date_created
¶ Returns: The date_created Return type: datetime
-
fetch
()[source]¶ Fetch the CustomerProfilesEvaluationsInstance
Returns: The fetched CustomerProfilesEvaluationsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance
-
policy_sid
¶ Returns: The unique string of a policy Return type: unicode
-
sid
¶ Returns: The unique string that identifies the Evaluation resource Return type: unicode
-
status
¶ Returns: The compliance status of the Evaluation resource Return type: CustomerProfilesEvaluationsInstance.Status
-
url
¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.
CustomerProfilesEvaluationsList
(version, customer_profile_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(policy_sid)[source]¶ Create the CustomerProfilesEvaluationsInstance
Parameters: policy_sid (unicode) – The unique string of a policy Returns: The created CustomerProfilesEvaluationsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance
-
get
(sid)[source]¶ Constructs a CustomerProfilesEvaluationsContext
Parameters: sid – The unique string that identifies the Evaluation resource Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsContext Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CustomerProfilesEvaluationsInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CustomerProfilesEvaluationsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsPage
-
list
(limit=None, page_size=None)[source]¶ Lists CustomerProfilesEvaluationsInstance 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.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance]
-
page
(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CustomerProfilesEvaluationsInstance records from the API. Request is executed immediately
Parameters: Returns: Page of CustomerProfilesEvaluationsInstance
Return type:
-
stream
(limit=None, page_size=None)[source]¶ Streams CustomerProfilesEvaluationsInstance 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.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance]
-
-
class
twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.
CustomerProfilesEvaluationsPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CustomerProfilesEvaluationsInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.trusthub.v1.customer_profiles.
CustomerProfilesContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
customer_profiles_channel_endpoint_assignment
¶ Access the customer_profiles_channel_endpoint_assignment
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentList
-
customer_profiles_entity_assignments
¶ Access the customer_profiles_entity_assignments
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsList
-
customer_profiles_evaluations
¶ Access the customer_profiles_evaluations
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsList
-
delete
()[source]¶ Deletes the CustomerProfilesInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CustomerProfilesInstance
Returns: The fetched CustomerProfilesInstance Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-
update
(status=<object object>, status_callback=<object object>, friendly_name=<object object>, email=<object object>)[source]¶ Update the CustomerProfilesInstance
Parameters: - status (CustomerProfilesInstance.Status) – The verification status of the Customer-Profile resource
- status_callback (unicode) – The URL we call to inform your application of status changes.
- friendly_name (unicode) – The string that you assigned to describe the resource
- email (unicode) – The email address
Returns: The updated CustomerProfilesInstance
Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-
-
class
twilio.rest.trusthub.v1.customer_profiles.
CustomerProfilesInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Status
[source]¶ Bases:
object
-
DRAFT
= 'draft'¶
-
IN_REVIEW
= 'in-review'¶
-
PENDING_REVIEW
= 'pending-review'¶
-
TWILIO_APPROVED
= 'twilio-approved'¶
-
TWILIO_REJECTED
= 'twilio-rejected'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
customer_profiles_channel_endpoint_assignment
¶ Access the customer_profiles_channel_endpoint_assignment
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_channel_endpoint_assignment.CustomerProfilesChannelEndpointAssignmentList
-
customer_profiles_entity_assignments
¶ Access the customer_profiles_entity_assignments
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_entity_assignments.CustomerProfilesEntityAssignmentsList
-
customer_profiles_evaluations
¶ Access the customer_profiles_evaluations
Returns: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsList Return type: twilio.rest.trusthub.v1.customer_profiles.customer_profiles_evaluations.CustomerProfilesEvaluationsList
-
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
-
delete
()[source]¶ Deletes the CustomerProfilesInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
email
¶ Returns: The email address Return type: unicode
-
fetch
()[source]¶ Fetch the CustomerProfilesInstance
Returns: The fetched CustomerProfilesInstance Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
links
¶ Returns: The URLs of the Assigned Items of the Customer-Profile resource Return type: unicode
-
policy_sid
¶ Returns: The unique string of a policy. Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource. Return type: unicode
-
status
¶ Returns: The verification status of the Customer-Profile resource Return type: CustomerProfilesInstance.Status
-
status_callback
¶ Returns: The URL we call to inform your application of status changes. Return type: unicode
-
update
(status=<object object>, status_callback=<object object>, friendly_name=<object object>, email=<object object>)[source]¶ Update the CustomerProfilesInstance
Parameters: - status (CustomerProfilesInstance.Status) – The verification status of the Customer-Profile resource
- status_callback (unicode) – The URL we call to inform your application of status changes.
- friendly_name (unicode) – The string that you assigned to describe the resource
- email (unicode) – The email address
Returns: The updated CustomerProfilesInstance
Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-
url
¶ Returns: The absolute URL of the Customer-Profile resource Return type: unicode
-
valid_until
¶ Returns: The ISO 8601 date and time in GMT when the resource will be valid until. Return type: datetime
-
class
-
class
twilio.rest.trusthub.v1.customer_profiles.
CustomerProfilesList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name, email, policy_sid, status_callback=<object object>)[source]¶ Create the CustomerProfilesInstance
Parameters: - friendly_name (unicode) – The string that you assigned to describe the resource
- email (unicode) – The email address
- policy_sid (unicode) – The unique string of a policy.
- status_callback (unicode) – The URL we call to inform your application of status changes.
Returns: The created CustomerProfilesInstance
Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-
get
(sid)[source]¶ Constructs a CustomerProfilesContext
Parameters: sid – The unique string that identifies the resource. Returns: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesContext Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CustomerProfilesInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CustomerProfilesInstance Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesPage
-
list
(status=<object object>, friendly_name=<object object>, policy_sid=<object object>, limit=None, page_size=None)[source]¶ Lists CustomerProfilesInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - status (CustomerProfilesInstance.Status) – The verification status of the Customer-Profile resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- policy_sid (unicode) – The unique string of a policy.
- 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.customer_profiles.CustomerProfilesInstance]
-
page
(status=<object object>, friendly_name=<object object>, policy_sid=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CustomerProfilesInstance records from the API. Request is executed immediately
Parameters: - status (CustomerProfilesInstance.Status) – The verification status of the Customer-Profile resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- policy_sid (unicode) – The unique string of a policy.
- 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 CustomerProfilesInstance
Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesPage
-
stream
(status=<object object>, friendly_name=<object object>, policy_sid=<object object>, limit=None, page_size=None)[source]¶ Streams CustomerProfilesInstance 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: - status (CustomerProfilesInstance.Status) – The verification status of the Customer-Profile resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- policy_sid (unicode) – The unique string of a policy.
- 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.customer_profiles.CustomerProfilesInstance]
-
-
class
twilio.rest.trusthub.v1.customer_profiles.
CustomerProfilesPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CustomerProfilesInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance Return type: twilio.rest.trusthub.v1.customer_profiles.CustomerProfilesInstance
-