twilio.rest.numbers.v2.regulatory_compliance.bundle package¶
Submodules¶
twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationContext(version, bundle_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext-
fetch()[source]¶ Fetch the EvaluationInstance
Returns: The fetched EvaluationInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance(version, payload, bundle_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
-
bundle_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 EvaluationInstance
Returns: The fetched EvaluationInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance
-
regulation_sid¶ Returns: The unique string of a regulation 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: EvaluationInstance.Status
-
url¶ Returns: The url Return type: unicode
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList(version, bundle_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create()[source]¶ Create the EvaluationInstance
Returns: The created EvaluationInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance
-
get(sid)[source]¶ Constructs a EvaluationContext
Parameters: sid – The unique string that identifies the Evaluation resource Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationContext Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationContext
-
get_page(target_url)[source]¶ Retrieve a specific page of EvaluationInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of EvaluationInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationPage
-
list(limit=None, page_size=None)[source]¶ Lists EvaluationInstance 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.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of EvaluationInstance records from the API. Request is executed immediately
Parameters: Returns: Page of EvaluationInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationPage
-
stream(limit=None, page_size=None)[source]¶ Streams EvaluationInstance 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.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance]
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationPage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of EvaluationInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationInstance
-
twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentContext(version, bundle_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext-
delete()[source]¶ Deletes the ItemAssignmentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the ItemAssignmentInstance
Returns: The fetched ItemAssignmentInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance(version, payload, bundle_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
-
bundle_sid¶ Returns: The unique string that identifies the Bundle 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 ItemAssignmentInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch()[source]¶ Fetch the ItemAssignmentInstance
Returns: The fetched ItemAssignmentInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance
-
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.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList(version, bundle_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(object_sid)[source]¶ Create the ItemAssignmentInstance
Parameters: object_sid (unicode) – The sid of an object bag Returns: The created ItemAssignmentInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance
-
get(sid)[source]¶ Constructs a ItemAssignmentContext
Parameters: sid – The unique string that identifies the resource Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentContext Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentContext
-
get_page(target_url)[source]¶ Retrieve a specific page of ItemAssignmentInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of ItemAssignmentInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentPage
-
list(limit=None, page_size=None)[source]¶ Lists ItemAssignmentInstance 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.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance]
-
page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of ItemAssignmentInstance records from the API. Request is executed immediately
Parameters: Returns: Page of ItemAssignmentInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentPage
-
stream(limit=None, page_size=None)[source]¶ Streams ItemAssignmentInstance 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.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance]
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentPage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of ItemAssignmentInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext-
delete()[source]¶ Deletes the BundleInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
evaluations¶ Access the evaluations
Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
-
fetch()[source]¶ Fetch the BundleInstance
Returns: The fetched BundleInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-
item_assignments¶ Access the item_assignments
Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
-
update(status=<object object>, status_callback=<object object>, friendly_name=<object object>, email=<object object>)[source]¶ Update the BundleInstance
Parameters: - status (BundleInstance.Status) – The verification status of the Bundle 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 BundleInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance(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'¶
-
PROVISIONALLY_APPROVED= 'provisionally-approved'¶
-
TWILIO_APPROVED= 'twilio-approved'¶
-
TWILIO_REJECTED= 'twilio-rejected'¶
-
-
account_sid¶ Returns: The SID of the Account that created the resource 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
-
delete()[source]¶ Deletes the BundleInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
email¶ Returns: The email address Return type: unicode
-
evaluations¶ Access the evaluations
Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
-
fetch()[source]¶ Fetch the BundleInstance
Returns: The fetched BundleInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-
friendly_name¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
item_assignments¶ Access the item_assignments
Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
-
links¶ Returns: The URLs of the Assigned Items of the Bundle resource Return type: unicode
-
regulation_sid¶ Returns: The unique string of a regulation. Return type: unicode
-
sid¶ Returns: The unique string that identifies the resource. Return type: unicode
-
status¶ Returns: The verification status of the Bundle resource Return type: BundleInstance.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 BundleInstance
Parameters: - status (BundleInstance.Status) – The verification status of the Bundle 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 BundleInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-
url¶ Returns: The absolute URL of the Bundle 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.numbers.v2.regulatory_compliance.bundle.BundleList(version)[source]¶ Bases:
twilio.base.list_resource.ListResource-
create(friendly_name, email, status_callback=<object object>, regulation_sid=<object object>, iso_country=<object object>, end_user_type=<object object>, number_type=<object object>)[source]¶ Create the BundleInstance
Parameters: - friendly_name (unicode) – The string that you assigned to describe the resource
- email (unicode) – The email address
- status_callback (unicode) – The URL we call to inform your application of status changes.
- regulation_sid (unicode) – The unique string of a regulation.
- iso_country (unicode) – The ISO country code of the country
- end_user_type (BundleInstance.EndUserType) – The type of End User of the Bundle resource
- number_type (unicode) – The type of phone number
Returns: The created BundleInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-
get(sid)[source]¶ Constructs a BundleContext
Parameters: sid – The unique string that identifies the resource. Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
-
get_page(target_url)[source]¶ Retrieve a specific page of BundleInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of BundleInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
-
list(status=<object object>, friendly_name=<object object>, regulation_sid=<object object>, iso_country=<object object>, number_type=<object object>, limit=None, page_size=None)[source]¶ Lists BundleInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - status (BundleInstance.Status) – The verification status of the Bundle resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- regulation_sid (unicode) – The unique string of a regulation.
- iso_country (unicode) – The ISO country code of the country
- number_type (unicode) – The type of phone number
- 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.numbers.v2.regulatory_compliance.bundle.BundleInstance]
-
page(status=<object object>, friendly_name=<object object>, regulation_sid=<object object>, iso_country=<object object>, number_type=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of BundleInstance records from the API. Request is executed immediately
Parameters: - status (BundleInstance.Status) – The verification status of the Bundle resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- regulation_sid (unicode) – The unique string of a regulation.
- iso_country (unicode) – The ISO country code of the country
- number_type (unicode) – The type of phone number
- 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 BundleInstance
Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
-
stream(status=<object object>, friendly_name=<object object>, regulation_sid=<object object>, iso_country=<object object>, number_type=<object object>, limit=None, page_size=None)[source]¶ Streams BundleInstance 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 (BundleInstance.Status) – The verification status of the Bundle resource
- friendly_name (unicode) – The string that you assigned to describe the resource
- regulation_sid (unicode) – The unique string of a regulation.
- iso_country (unicode) – The ISO country code of the country
- number_type (unicode) – The type of phone number
- 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.numbers.v2.regulatory_compliance.bundle.BundleInstance]
-
-
class
twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage(version, response, solution)[source]¶ Bases:
twilio.base.page.Page-
get_instance(payload)[source]¶ Build an instance of BundleInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance Return type: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
-