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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Flex
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, 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 PluginVersionArchiveInstance(InstanceResource):
"""
:ivar sid: The unique string that we created to identify the Flex Plugin Version resource.
:ivar plugin_sid: The SID of the Flex Plugin resource this Flex Plugin Version belongs to.
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Flex Plugin Version resource and owns this resource.
:ivar version: The unique version of this Flex Plugin Version.
:ivar plugin_url: The URL of where the Flex Plugin Version JavaScript bundle is hosted on.
:ivar changelog: A changelog that describes the changes this Flex Plugin Version brings.
:ivar private: Whether to inject credentials while accessing this Plugin Version. The default value is false.
:ivar archived: Whether the Flex Plugin Version is archived. The default value is false.
:ivar date_created: The date and time in GMT when the Flex Plugin Version was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
:ivar url: The absolute URL of the Flex Plugin Version resource.
"""
def __init__(
self,
version: Version,
payload: Dict[str, Any],
plugin_sid: Optional[str] = None,
sid: Optional[str] = None,
):
super().__init__(version)
self.sid: Optional[str] = payload.get("sid")
self.plugin_sid: Optional[str] = payload.get("plugin_sid")
self.account_sid: Optional[str] = payload.get("account_sid")
self.version: Optional[str] = payload.get("version")
self.plugin_url: Optional[str] = payload.get("plugin_url")
self.changelog: Optional[str] = payload.get("changelog")
self.private: Optional[bool] = payload.get("private")
self.archived: Optional[bool] = payload.get("archived")
self.date_created: Optional[datetime] = deserialize.iso8601_datetime(
payload.get("date_created")
)
self.url: Optional[str] = payload.get("url")
self._solution = {
"plugin_sid": plugin_sid or self.plugin_sid,
"sid": sid or self.sid,
}
self._context: Optional[PluginVersionArchiveContext] = None
@property
def _proxy(self) -> "PluginVersionArchiveContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: PluginVersionArchiveContext for this PluginVersionArchiveInstance
"""
if self._context is None:
self._context = PluginVersionArchiveContext(
self._version,
plugin_sid=self._solution["plugin_sid"],
sid=self._solution["sid"],
)
return self._context
def update(
self, flex_metadata: Union[str, object] = values.unset
) -> "PluginVersionArchiveInstance":
"""
Update the PluginVersionArchiveInstance
:param flex_metadata: The Flex-Metadata HTTP request header
:returns: The updated PluginVersionArchiveInstance
"""
return self._proxy.update(
flex_metadata=flex_metadata,
)
async def update_async(
self, flex_metadata: Union[str, object] = values.unset
) -> "PluginVersionArchiveInstance":
"""
Asynchronous coroutine to update the PluginVersionArchiveInstance
:param flex_metadata: The Flex-Metadata HTTP request header
:returns: The updated PluginVersionArchiveInstance
"""
return await self._proxy.update_async(
flex_metadata=flex_metadata,
)
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.FlexApi.V1.PluginVersionArchiveInstance {}>".format(context)
class PluginVersionArchiveContext(InstanceContext):
def __init__(self, version: Version, plugin_sid: str, sid: str):
"""
Initialize the PluginVersionArchiveContext
:param version: Version that contains the resource
:param plugin_sid: The SID of the Flex Plugin the resource to belongs to.
:param sid: The SID of the Flex Plugin Version resource to archive.
"""
super().__init__(version)
# Path Solution
self._solution = {
"plugin_sid": plugin_sid,
"sid": sid,
}
self._uri = "/PluginService/Plugins/{plugin_sid}/Versions/{sid}/Archive".format(
**self._solution
)
def update(
self, flex_metadata: Union[str, object] = values.unset
) -> PluginVersionArchiveInstance:
"""
Update the PluginVersionArchiveInstance
:param flex_metadata: The Flex-Metadata HTTP request header
:returns: The updated PluginVersionArchiveInstance
"""
data = values.of({})
headers = values.of({})
if not (
flex_metadata is values.unset
or (isinstance(flex_metadata, str) and not flex_metadata)
):
headers["Flex-Metadata"] = flex_metadata
headers["Accept"] = "application/json"
payload = self._version.update(
method="POST", uri=self._uri, data=data, headers=headers
)
return PluginVersionArchiveInstance(
self._version,
payload,
plugin_sid=self._solution["plugin_sid"],
sid=self._solution["sid"],
)
async def update_async(
self, flex_metadata: Union[str, object] = values.unset
) -> PluginVersionArchiveInstance:
"""
Asynchronous coroutine to update the PluginVersionArchiveInstance
:param flex_metadata: The Flex-Metadata HTTP request header
:returns: The updated PluginVersionArchiveInstance
"""
data = values.of({})
headers = values.of({})
if not (
flex_metadata is values.unset
or (isinstance(flex_metadata, str) and not flex_metadata)
):
headers["Flex-Metadata"] = flex_metadata
headers["Accept"] = "application/json"
payload = await self._version.update_async(
method="POST", uri=self._uri, data=data, headers=headers
)
return PluginVersionArchiveInstance(
self._version,
payload,
plugin_sid=self._solution["plugin_sid"],
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.FlexApi.V1.PluginVersionArchiveContext {}>".format(context)
class PluginVersionArchiveList(ListResource):
def __init__(self, version: Version):
"""
Initialize the PluginVersionArchiveList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self, plugin_sid: str, sid: str) -> PluginVersionArchiveContext:
"""
Constructs a PluginVersionArchiveContext
:param plugin_sid: The SID of the Flex Plugin the resource to belongs to.
:param sid: The SID of the Flex Plugin Version resource to archive.
"""
return PluginVersionArchiveContext(
self._version, plugin_sid=plugin_sid, sid=sid
)
def __call__(self, plugin_sid: str, sid: str) -> PluginVersionArchiveContext:
"""
Constructs a PluginVersionArchiveContext
:param plugin_sid: The SID of the Flex Plugin the resource to belongs to.
:param sid: The SID of the Flex Plugin Version resource to archive.
"""
return PluginVersionArchiveContext(
self._version, plugin_sid=plugin_sid, sid=sid
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.FlexApi.V1.PluginVersionArchiveList>"
|