1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
from twilio.base import deserialize
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
class CertificateList(ListResource):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, fleet_sid):
"""
Initialize the CertificateList
:param Version version: Version that contains the resource
:param fleet_sid: The unique identifier of the Fleet.
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateList
"""
super(CertificateList, self).__init__(version)
# Path Solution
self._solution = {'fleet_sid': fleet_sid, }
self._uri = '/Fleets/{fleet_sid}/Certificates'.format(**self._solution)
def create(self, certificate_data, friendly_name=values.unset,
device_sid=values.unset):
"""
Create the CertificateInstance
:param unicode certificate_data: The public certificate data.
:param unicode friendly_name: The human readable description for this Certificate.
:param unicode device_sid: The unique identifier of a Device to be authenticated.
:returns: The created CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
data = values.of({
'CertificateData': certificate_data,
'FriendlyName': friendly_name,
'DeviceSid': device_sid,
})
payload = self._version.create(method='POST', uri=self._uri, data=data, )
return CertificateInstance(self._version, payload, fleet_sid=self._solution['fleet_sid'], )
def stream(self, device_sid=values.unset, limit=None, page_size=None):
"""
Streams CertificateInstance 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 unicode device_sid: Find all Certificates authenticating specified Device.
: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.preview.deployed_devices.fleet.certificate.CertificateInstance]
"""
limits = self._version.read_limits(limit, page_size)
page = self.page(device_sid=device_sid, page_size=limits['page_size'], )
return self._version.stream(page, limits['limit'])
def list(self, device_sid=values.unset, limit=None, page_size=None):
"""
Lists CertificateInstance records from the API as a list.
Unlike stream(), this operation is eager and will load `limit` records into
memory before returning.
:param unicode device_sid: Find all Certificates authenticating specified Device.
: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.preview.deployed_devices.fleet.certificate.CertificateInstance]
"""
return list(self.stream(device_sid=device_sid, limit=limit, page_size=page_size, ))
def page(self, device_sid=values.unset, page_token=values.unset,
page_number=values.unset, page_size=values.unset):
"""
Retrieve a single page of CertificateInstance records from the API.
Request is executed immediately
:param unicode device_sid: Find all Certificates authenticating specified Device.
: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 CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
"""
data = values.of({
'DeviceSid': device_sid,
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
response = self._version.page(method='GET', uri=self._uri, params=data, )
return CertificatePage(self._version, response, self._solution)
def get_page(self, target_url):
"""
Retrieve a specific page of CertificateInstance records from the API.
Request is executed immediately
:param str target_url: API-generated URL for the requested results page
:returns: Page of CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
"""
response = self._version.domain.twilio.request(
'GET',
target_url,
)
return CertificatePage(self._version, response, self._solution)
def get(self, sid):
"""
Constructs a CertificateContext
:param sid: A string that uniquely identifies the Certificate.
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
"""
return CertificateContext(self._version, fleet_sid=self._solution['fleet_sid'], sid=sid, )
def __call__(self, sid):
"""
Constructs a CertificateContext
:param sid: A string that uniquely identifies the Certificate.
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
"""
return CertificateContext(self._version, fleet_sid=self._solution['fleet_sid'], sid=sid, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.DeployedDevices.CertificateList>'
class CertificatePage(Page):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, response, solution):
"""
Initialize the CertificatePage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:param fleet_sid: The unique identifier of the Fleet.
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificatePage
"""
super(CertificatePage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of CertificateInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
return CertificateInstance(self._version, payload, fleet_sid=self._solution['fleet_sid'], )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Preview.DeployedDevices.CertificatePage>'
class CertificateContext(InstanceContext):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, fleet_sid, sid):
"""
Initialize the CertificateContext
:param Version version: Version that contains the resource
:param fleet_sid: The fleet_sid
:param sid: A string that uniquely identifies the Certificate.
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
"""
super(CertificateContext, self).__init__(version)
# Path Solution
self._solution = {'fleet_sid': fleet_sid, 'sid': sid, }
self._uri = '/Fleets/{fleet_sid}/Certificates/{sid}'.format(**self._solution)
def fetch(self):
"""
Fetch the CertificateInstance
:returns: The fetched CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return CertificateInstance(
self._version,
payload,
fleet_sid=self._solution['fleet_sid'],
sid=self._solution['sid'],
)
def delete(self):
"""
Deletes the CertificateInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._version.delete(method='DELETE', uri=self._uri, )
def update(self, friendly_name=values.unset, device_sid=values.unset):
"""
Update the CertificateInstance
:param unicode friendly_name: The human readable description for this Certificate.
:param unicode device_sid: The unique identifier of a Device to be authenticated.
:returns: The updated CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
data = values.of({'FriendlyName': friendly_name, 'DeviceSid': device_sid, })
payload = self._version.update(method='POST', uri=self._uri, data=data, )
return CertificateInstance(
self._version,
payload,
fleet_sid=self._solution['fleet_sid'],
sid=self._solution['sid'],
)
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.Preview.DeployedDevices.CertificateContext {}>'.format(context)
class CertificateInstance(InstanceResource):
""" PLEASE NOTE that this class contains preview products that are subject
to change. Use them with caution. If you currently do not have developer
preview access, please contact help@twilio.com. """
def __init__(self, version, payload, fleet_sid, sid=None):
"""
Initialize the CertificateInstance
:returns: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
super(CertificateInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'sid': payload.get('sid'),
'url': payload.get('url'),
'friendly_name': payload.get('friendly_name'),
'fleet_sid': payload.get('fleet_sid'),
'account_sid': payload.get('account_sid'),
'device_sid': payload.get('device_sid'),
'thumbprint': payload.get('thumbprint'),
'date_created': deserialize.iso8601_datetime(payload.get('date_created')),
'date_updated': deserialize.iso8601_datetime(payload.get('date_updated')),
}
# Context
self._context = None
self._solution = {'fleet_sid': fleet_sid, '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: CertificateContext for this CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateContext
"""
if self._context is None:
self._context = CertificateContext(
self._version,
fleet_sid=self._solution['fleet_sid'],
sid=self._solution['sid'],
)
return self._context
@property
def sid(self):
"""
:returns: A string that uniquely identifies this Certificate.
:rtype: unicode
"""
return self._properties['sid']
@property
def url(self):
"""
:returns: URL of this Certificate.
:rtype: unicode
"""
return self._properties['url']
@property
def friendly_name(self):
"""
:returns: A human readable description for this Certificate.
:rtype: unicode
"""
return self._properties['friendly_name']
@property
def fleet_sid(self):
"""
:returns: The unique identifier of the Fleet.
:rtype: unicode
"""
return self._properties['fleet_sid']
@property
def account_sid(self):
"""
:returns: The unique SID that identifies this Account.
:rtype: unicode
"""
return self._properties['account_sid']
@property
def device_sid(self):
"""
:returns: The unique identifier of a mapped Device.
:rtype: unicode
"""
return self._properties['device_sid']
@property
def thumbprint(self):
"""
:returns: A Certificate unique payload hash.
:rtype: unicode
"""
return self._properties['thumbprint']
@property
def date_created(self):
"""
:returns: The date this Certificate was created.
:rtype: datetime
"""
return self._properties['date_created']
@property
def date_updated(self):
"""
:returns: The date this Certificate was updated.
:rtype: datetime
"""
return self._properties['date_updated']
def fetch(self):
"""
Fetch the CertificateInstance
:returns: The fetched CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
return self._proxy.fetch()
def delete(self):
"""
Deletes the CertificateInstance
:returns: True if delete succeeds, False otherwise
:rtype: bool
"""
return self._proxy.delete()
def update(self, friendly_name=values.unset, device_sid=values.unset):
"""
Update the CertificateInstance
:param unicode friendly_name: The human readable description for this Certificate.
:param unicode device_sid: The unique identifier of a Device to be authenticated.
:returns: The updated CertificateInstance
:rtype: twilio.rest.preview.deployed_devices.fleet.certificate.CertificateInstance
"""
return self._proxy.update(friendly_name=friendly_name, device_sid=device_sid, )
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.Preview.DeployedDevices.CertificateInstance {}>'.format(context)
|