# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
from twilio.base import serialize
from twilio.base import values
from twilio.base.instance_context import InstanceContext
from twilio.base.instance_resource import InstanceResource
from twilio.base.list_resource import ListResource
from twilio.base.page import Page
from twilio.rest.numbers.v2.regulatory_compliance.bundle.bundle_copy import BundleCopyList
from twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation import EvaluationList
from twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment import ItemAssignmentList
from twilio.rest.numbers.v2.regulatory_compliance.bundle.replace_items import ReplaceItemsList
[docs]class BundleList(ListResource):
def __init__(self, version):
"""
Initialize the BundleList
:param Version version: Version that contains the resource
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleList
"""
super(BundleList, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/RegulatoryCompliance/Bundles'.format(**self._solution)
[docs] def create(self, friendly_name, email, status_callback=values.unset,
regulation_sid=values.unset, iso_country=values.unset,
end_user_type=values.unset, number_type=values.unset):
"""
Create the BundleInstance
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode email: The email address
:param unicode status_callback: The URL we call to inform your application of status changes.
:param unicode regulation_sid: The unique string of a regulation.
:param unicode iso_country: The ISO country code of the country
:param BundleInstance.EndUserType end_user_type: The type of End User of the Bundle resource
:param unicode number_type: The type of phone number
:returns: The created BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
data = values.of({
'FriendlyName': friendly_name,
'Email': email,
'StatusCallback': status_callback,
'RegulationSid': regulation_sid,
'IsoCountry': iso_country,
'EndUserType': end_user_type,
'NumberType': number_type,
})
payload = self._version.create(method='POST', uri=self._uri, data=data, )
return BundleInstance(self._version, payload, )
[docs] def stream(self, status=values.unset, friendly_name=values.unset,
regulation_sid=values.unset, iso_country=values.unset,
number_type=values.unset, has_valid_until_date=values.unset,
sort_by=values.unset, sort_direction=values.unset,
valid_until_date_before=values.unset, valid_until_date=values.unset,
valid_until_date_after=values.unset, limit=None, page_size=None):
"""
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.
:param BundleInstance.Status status: The verification status of the Bundle resource
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode regulation_sid: The unique string of a regulation.
:param unicode iso_country: The ISO country code of the country
:param unicode number_type: The type of phone number
:param bool has_valid_until_date: Indicates that the Bundle is a valid Bundle until a specified expiration date.
:param BundleInstance.SortBy sort_by: Can be `ValidUntilDate` or `DateUpdated`. Defaults to `DateCreated`
:param BundleInstance.SortDirection sort_direction: Default is `DESC`. Can be `ASC` or `DESC`.
:param datetime valid_until_date_before: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date_after: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param int limit: Upper limit for the number of records to return. stream()
guarantees to never return more than limit. Default is no limit
:param int page_size: 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
:rtype: list[twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(
status=status,
friendly_name=friendly_name,
regulation_sid=regulation_sid,
iso_country=iso_country,
number_type=number_type,
has_valid_until_date=has_valid_until_date,
sort_by=sort_by,
sort_direction=sort_direction,
valid_until_date_before=valid_until_date_before,
valid_until_date=valid_until_date,
valid_until_date_after=valid_until_date_after,
page_size=limits['page_size'],
)
return self._version.stream(page, limits['limit'])
[docs] def list(self, status=values.unset, friendly_name=values.unset,
regulation_sid=values.unset, iso_country=values.unset,
number_type=values.unset, has_valid_until_date=values.unset,
sort_by=values.unset, sort_direction=values.unset,
valid_until_date_before=values.unset, valid_until_date=values.unset,
valid_until_date_after=values.unset, limit=None, page_size=None):
"""
Lists BundleInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param BundleInstance.Status status: The verification status of the Bundle resource
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode regulation_sid: The unique string of a regulation.
:param unicode iso_country: The ISO country code of the country
:param unicode number_type: The type of phone number
:param bool has_valid_until_date: Indicates that the Bundle is a valid Bundle until a specified expiration date.
:param BundleInstance.SortBy sort_by: Can be `ValidUntilDate` or `DateUpdated`. Defaults to `DateCreated`
:param BundleInstance.SortDirection sort_direction: Default is `DESC`. Can be `ASC` or `DESC`.
:param datetime valid_until_date_before: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date_after: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param int limit: Upper limit for the number of records to return. list() guarantees
never to return more than limit. Default is no limit
:param int page_size: 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
:rtype: list[twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance]
"""
return list(self.stream(
status=status,
friendly_name=friendly_name,
regulation_sid=regulation_sid,
iso_country=iso_country,
number_type=number_type,
has_valid_until_date=has_valid_until_date,
sort_by=sort_by,
sort_direction=sort_direction,
valid_until_date_before=valid_until_date_before,
valid_until_date=valid_until_date,
valid_until_date_after=valid_until_date_after,
limit=limit,
page_size=page_size,
))
[docs] def page(self, status=values.unset, friendly_name=values.unset,
regulation_sid=values.unset, iso_country=values.unset,
number_type=values.unset, has_valid_until_date=values.unset,
sort_by=values.unset, sort_direction=values.unset,
valid_until_date_before=values.unset, valid_until_date=values.unset,
valid_until_date_after=values.unset, page_token=values.unset,
page_number=values.unset, page_size=values.unset):
"""
Retrieve a single page of BundleInstance records from the API.
Request is executed immediately
:param BundleInstance.Status status: The verification status of the Bundle resource
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode regulation_sid: The unique string of a regulation.
:param unicode iso_country: The ISO country code of the country
:param unicode number_type: The type of phone number
:param bool has_valid_until_date: Indicates that the Bundle is a valid Bundle until a specified expiration date.
:param BundleInstance.SortBy sort_by: Can be `ValidUntilDate` or `DateUpdated`. Defaults to `DateCreated`
:param BundleInstance.SortDirection sort_direction: Default is `DESC`. Can be `ASC` or `DESC`.
:param datetime valid_until_date_before: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param datetime valid_until_date_after: Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
:param str page_token: PageToken provided by the API
:param int page_number: Page Number, this value is simply for client state
:param int page_size: Number of records to return, defaults to 50
:returns: Page of BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
"""
data = values.of({
'Status': status,
'FriendlyName': friendly_name,
'RegulationSid': regulation_sid,
'IsoCountry': iso_country,
'NumberType': number_type,
'HasValidUntilDate': has_valid_until_date,
'SortBy': sort_by,
'SortDirection': sort_direction,
'ValidUntilDate<': serialize.iso8601_datetime(valid_until_date_before),
'ValidUntilDate': serialize.iso8601_datetime(valid_until_date),
'ValidUntilDate>': serialize.iso8601_datetime(valid_until_date_after),
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return BundlePage(self._version, response, self._solution)
[docs] def get_page(self, target_url):
"""
Retrieve a specific page of BundleInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return BundlePage(self._version, response, self._solution)
[docs] def get(self, sid):
"""
Constructs a BundleContext
:param sid: The unique string that identifies the resource.
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
"""
return BundleContext(self._version, sid=sid, )
def __call__(self, sid):
"""
Constructs a BundleContext
:param sid: The unique string that identifies the resource.
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
"""
return BundleContext(self._version, sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Numbers.V2.BundleList>'
[docs]class BundlePage(Page):
def __init__(self, version, response, solution):
"""
Initialize the BundlePage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundlePage
"""
super(BundlePage, self).__init__(version, response)
# Path Solution
self._solution = solution
[docs] def get_instance(self, payload):
"""
Build an instance of BundleInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
return BundleInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Numbers.V2.BundlePage>'
[docs]class BundleContext(InstanceContext):
def __init__(self, version, sid):
"""
Initialize the BundleContext
:param Version version: Version that contains the resource
:param sid: The unique string that identifies the resource.
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
"""
super(BundleContext, self).__init__(version)
# Path Solution
self._solution = {'sid': sid, }
self._uri = '/RegulatoryCompliance/Bundles/{sid}'.format(**self._solution)
# Dependents
self._evaluations = None
self._item_assignments = None
self._bundle_copies = None
self._replace_items = None
[docs] def fetch(self):
"""
Fetch the BundleInstance
:returns: The fetched BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return BundleInstance(self._version, payload, sid=self._solution['sid'], )
[docs] def update(self, status=values.unset, status_callback=values.unset,
friendly_name=values.unset, email=values.unset):
"""
Update the BundleInstance
:param BundleInstance.Status status: The verification status of the Bundle resource
:param unicode status_callback: The URL we call to inform your application of status changes.
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode email: The email address
:returns: The updated BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
data = values.of({
'Status': status,
'StatusCallback': status_callback,
'FriendlyName': friendly_name,
'Email': email,
})
payload = self._version.update(method='POST', uri=self._uri, data=data, )
return BundleInstance(self._version, payload, sid=self._solution['sid'], )
[docs] def delete(self):
"""
Deletes the BundleInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._version.delete(method='DELETE', uri=self._uri, )
@property
def evaluations(self):
"""
Access the evaluations
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
"""
if self._evaluations is None:
self._evaluations = EvaluationList(self._version, bundle_sid=self._solution['sid'], )
return self._evaluations
@property
def item_assignments(self):
"""
Access the item_assignments
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
"""
if self._item_assignments is None:
self._item_assignments = ItemAssignmentList(self._version, bundle_sid=self._solution['sid'], )
return self._item_assignments
@property
def bundle_copies(self):
"""
Access the bundle_copies
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.bundle_copy.BundleCopyList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.bundle_copy.BundleCopyList
"""
if self._bundle_copies is None:
self._bundle_copies = BundleCopyList(self._version, bundle_sid=self._solution['sid'], )
return self._bundle_copies
@property
def replace_items(self):
"""
Access the replace_items
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.replace_items.ReplaceItemsList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.replace_items.ReplaceItemsList
"""
if self._replace_items is None:
self._replace_items = ReplaceItemsList(self._version, bundle_sid=self._solution['sid'], )
return self._replace_items
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Numbers.V2.BundleContext {}>'.format(context)
[docs]class BundleInstance(InstanceResource):
[docs] class Status(object):
DRAFT = "draft"
PENDING_REVIEW = "pending-review"
IN_REVIEW = "in-review"
TWILIO_REJECTED = "twilio-rejected"
TWILIO_APPROVED = "twilio-approved"
PROVISIONALLY_APPROVED = "provisionally-approved"
[docs] class EndUserType(object):
INDIVIDUAL = "individual"
BUSINESS = "business"
[docs] class SortBy(object):
ASC = "ASC"
DESC = "DESC"
[docs] class SortDirection(object):
VALID_UNTIL_DATE = "valid_until_date"
DATE_UPDATED = "date_updated"
def __init__(self, version, payload, sid=None):
"""
Initialize the BundleInstance
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
super(BundleInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'account_sid': payload.get('account_sid'),
'regulation_sid': payload.get('regulation_sid'),
'friendly_name': payload.get('friendly_name'),
'status': payload.get('status'),
'valid_until': deserialize.iso8601_datetime(payload.get('valid_until')),
'email': payload.get('email'),
'status_callback': payload.get('status_callback'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
'url': payload.get('url'),
'links': payload.get('links'),
}
# Context
self._context = None
self._solution = {'sid': sid or self._properties['sid'], }
@property
def _proxy(self):
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: BundleContext for this BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleContext
"""
if self._context is None:
self._context = BundleContext(self._version, sid=self._solution['sid'], )
return self._context
@property
def sid(self):
"""
:returns: The unique string that identifies the resource.
:rtype: unicode
"""
return self._properties['sid']
@property
def account_sid(self):
"""
:returns: The SID of the Account that created the resource
:rtype: unicode
"""
return self._properties['account_sid']
@property
def regulation_sid(self):
"""
:returns: The unique string of a regulation.
:rtype: unicode
"""
return self._properties['regulation_sid']
@property
def friendly_name(self):
"""
:returns: The string that you assigned to describe the resource
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def status(self):
"""
:returns: The verification status of the Bundle resource
:rtype: BundleInstance.Status
"""
return self._properties['status']
@property
def valid_until(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource will be valid until.
:rtype: datetime
"""
return self._properties['valid_until']
@property
def email(self):
"""
:returns: The email address
:rtype: unicode
"""
return self._properties['email']
@property
def status_callback(self):
"""
:returns: The URL we call to inform your application of status changes.
:rtype: unicode
"""
return self._properties['status_callback']
@property
def date_created(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource was created
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The ISO 8601 date and time in GMT when the resource was last updated
:rtype: datetime
"""
return self._properties['date_updated']
@property
def url(self):
"""
:returns: The absolute URL of the Bundle resource
:rtype: unicode
"""
return self._properties['url']
@property
def links(self):
"""
:returns: The URLs of the Assigned Items of the Bundle resource
:rtype: unicode
"""
return self._properties['links']
[docs] def fetch(self):
"""
Fetch the BundleInstance
:returns: The fetched BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
return self._proxy.fetch()
[docs] def update(self, status=values.unset, status_callback=values.unset,
friendly_name=values.unset, email=values.unset):
"""
Update the BundleInstance
:param BundleInstance.Status status: The verification status of the Bundle resource
:param unicode status_callback: The URL we call to inform your application of status changes.
:param unicode friendly_name: The string that you assigned to describe the resource
:param unicode email: The email address
:returns: The updated BundleInstance
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.BundleInstance
"""
return self._proxy.update(
status=status,
status_callback=status_callback,
friendly_name=friendly_name,
email=email,
)
[docs] def delete(self):
"""
Deletes the BundleInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete()
@property
def evaluations(self):
"""
Access the evaluations
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.evaluation.EvaluationList
"""
return self._proxy.evaluations
@property
def item_assignments(self):
"""
Access the item_assignments
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.item_assignment.ItemAssignmentList
"""
return self._proxy.item_assignments
@property
def bundle_copies(self):
"""
Access the bundle_copies
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.bundle_copy.BundleCopyList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.bundle_copy.BundleCopyList
"""
return self._proxy.bundle_copies
@property
def replace_items(self):
"""
Access the replace_items
:returns: twilio.rest.numbers.v2.regulatory_compliance.bundle.replace_items.ReplaceItemsList
:rtype: twilio.rest.numbers.v2.regulatory_compliance.bundle.replace_items.ReplaceItemsList
"""
return self._proxy.replace_items
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
context = ' '.join('{}={}'.format(k, v) for k, v in self._solution.items())
return '<Twilio.Numbers.V2.BundleInstance {}>'.format(context)