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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Iam
This is the public Twilio REST API.
NOTE: This class is auto generated by OpenAPI Generator.
https://openapi-generator.tech
Do not edit the class manually.
"""
from datetime import datetime
from typing import Any, Dict, Optional, Union
from twilio.base import deserialize, serialize, 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.version import Version
class ApiKeyInstance(InstanceResource):
"""
:ivar sid: The unique string that we created to identify the Key resource.
:ivar friendly_name: The string that you assigned to describe the resource.
:ivar date_created: The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar date_updated: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
:ivar policy: The \\`Policy\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
"""
def __init__(
self, version: Version, payload: Dict[str, Any], sid: Optional[str] = None
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.date_created: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_created")
)
self.date_updated: Optional[datetime] = deserialize.rfc2822_datetime(
payload.get("date_updated")
)
self.policy: Optional[Dict[str, object]] = payload.get("policy")
self._solution = {
"sid": sid or self.sid,
}
self._context: Optional[ApiKeyContext] = None
@property
def _proxy(self) -> "ApiKeyContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: ApiKeyContext for this ApiKeyInstance
"""
if self._context is None:
self._context = ApiKeyContext(
self._version,
sid=self._solution["sid"],
)
return self._context
def delete(self) -> bool:
"""
Deletes the ApiKeyInstance
:returns: True if delete succeeds, False otherwise
"""
return self._proxy.delete()
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the ApiKeyInstance
:returns: True if delete succeeds, False otherwise
"""
return await self._proxy.delete_async()
def fetch(self) -> "ApiKeyInstance":
"""
Fetch the ApiKeyInstance
:returns: The fetched ApiKeyInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "ApiKeyInstance":
"""
Asynchronous coroutine to fetch the ApiKeyInstance
:returns: The fetched ApiKeyInstance
"""
return await self._proxy.fetch_async()
def update(
self,
friendly_name: Union[str, object] = values.unset,
policy: Union[object, object] = values.unset,
) -> "ApiKeyInstance":
"""
Update the ApiKeyInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param policy: The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
:returns: The updated ApiKeyInstance
"""
return self._proxy.update(
friendly_name=friendly_name,
policy=policy,
)
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
policy: Union[object, object] = values.unset,
) -> "ApiKeyInstance":
"""
Asynchronous coroutine to update the ApiKeyInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param policy: The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
:returns: The updated ApiKeyInstance
"""
return await self._proxy.update_async(
friendly_name=friendly_name,
policy=policy,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Iam.V1.ApiKeyInstance {}>".format(context)
class ApiKeyContext(InstanceContext):
def __init__(self, version: Version, sid: str):
"""
Initialize the ApiKeyContext
:param version: Version that contains the resource
:param sid: The Twilio-provided string that uniquely identifies the Key resource to update.
"""
super().__init__(version)
# Path Solution
self._solution = {
"sid": sid,
}
self._uri = "/Keys/{sid}".format(**self._solution)
def delete(self) -> bool:
"""
Deletes the ApiKeyInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return self._version.delete(method="DELETE", uri=self._uri, headers=headers)
async def delete_async(self) -> bool:
"""
Asynchronous coroutine that deletes the ApiKeyInstance
:returns: True if delete succeeds, False otherwise
"""
headers = values.of({})
return await self._version.delete_async(
method="DELETE", uri=self._uri, headers=headers
)
def fetch(self) -> ApiKeyInstance:
"""
Fetch the ApiKeyInstance
:returns: The fetched ApiKeyInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return ApiKeyInstance(
self._version,
payload,
sid=self._solution["sid"],
)
async def fetch_async(self) -> ApiKeyInstance:
"""
Asynchronous coroutine to fetch the ApiKeyInstance
:returns: The fetched ApiKeyInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return ApiKeyInstance(
self._version,
payload,
sid=self._solution["sid"],
)
def update(
self,
friendly_name: Union[str, object] = values.unset,
policy: Union[object, object] = values.unset,
) -> ApiKeyInstance:
"""
Update the ApiKeyInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param policy: The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
:returns: The updated ApiKeyInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Policy": serialize.object(policy),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return ApiKeyInstance(self._version, payload, sid=self._solution["sid"])
async def update_async(
self,
friendly_name: Union[str, object] = values.unset,
policy: Union[object, object] = values.unset,
) -> ApiKeyInstance:
"""
Asynchronous coroutine to update the ApiKeyInstance
:param friendly_name: A descriptive string that you create to describe the resource. It can be up to 64 characters long.
:param policy: The \\\\`Policy\\\\` object is a collection that specifies the allowed Twilio permissions for the restricted key. For more information on the permissions available with restricted API keys, refer to the [Twilio documentation](https://www.twilio.com/docs/iam/api-keys/restricted-api-keys#permissions-available-with-restricted-api-keys).
:returns: The updated ApiKeyInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"Policy": serialize.object(policy),
}
)
headers = values.of({})
headers["Content-Type"] = "application/x-www-form-urlencoded"
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return ApiKeyInstance(self._version, payload, sid=self._solution["sid"])
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
context = " ".join("{}={}".format(k, v) for k, v in self._solution.items())
return "<Twilio.Iam.V1.ApiKeyContext {}>".format(context)
class ApiKeyList(ListResource):
def __init__(self, version: Version):
"""
Initialize the ApiKeyList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, sid: str) -> ApiKeyContext:
"""
Constructs a ApiKeyContext
:param sid: The Twilio-provided string that uniquely identifies the Key resource to update.
"""
return ApiKeyContext(self._version, sid=sid)
def __call__(self, sid: str) -> ApiKeyContext:
"""
Constructs a ApiKeyContext
:param sid: The Twilio-provided string that uniquely identifies the Key resource to update.
"""
return ApiKeyContext(self._version, sid=sid)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Iam.V1.ApiKeyList>"
|