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
|
r"""
This code was generated by
___ _ _ _ _ _ _ ____ ____ ____ _ ____ ____ _ _ ____ ____ ____ ___ __ __
| | | | | | | | | __ | | |__| | __ | __ |___ |\ | |___ |__/ |__| | | | |__/
| |_|_| | |___ | |__| |__| | | | |__] |___ | \| |___ | \ | | | |__| | \
Twilio - Video
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 typing import Any, Dict, Optional, Union
from twilio.base import 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 CompositionSettingsInstance(InstanceResource):
"""
:ivar account_sid: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CompositionSettings resource.
:ivar friendly_name: The string that you assigned to describe the resource and that will be shown in the console
:ivar aws_credentials_sid: The SID of the stored Credential resource.
:ivar aws_s3_url: The URL of the AWS S3 bucket where the compositions are stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
:ivar aws_storage_enabled: Whether all compositions are written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
:ivar encryption_key_sid: The SID of the Public Key resource used for encryption.
:ivar encryption_enabled: Whether all compositions are stored in an encrypted form. The default is `false`.
:ivar url: The absolute URL of the resource.
"""
def __init__(self, version: Version, payload: Dict[str, Any]):
super().__init__(version)
self.account_sid: Optional[str] = payload.get("account_sid")
self.friendly_name: Optional[str] = payload.get("friendly_name")
self.aws_credentials_sid: Optional[str] = payload.get("aws_credentials_sid")
self.aws_s3_url: Optional[str] = payload.get("aws_s3_url")
self.aws_storage_enabled: Optional[bool] = payload.get("aws_storage_enabled")
self.encryption_key_sid: Optional[str] = payload.get("encryption_key_sid")
self.encryption_enabled: Optional[bool] = payload.get("encryption_enabled")
self.url: Optional[str] = payload.get("url")
self._context: Optional[CompositionSettingsContext] = None
@property
def _proxy(self) -> "CompositionSettingsContext":
"""
Generate an instance context for the instance, the context is capable of
performing various actions. All instance actions are proxied to the context
:returns: CompositionSettingsContext for this CompositionSettingsInstance
"""
if self._context is None:
self._context = CompositionSettingsContext(
self._version,
)
return self._context
def create(
self,
friendly_name: str,
aws_credentials_sid: Union[str, object] = values.unset,
encryption_key_sid: Union[str, object] = values.unset,
aws_s3_url: Union[str, object] = values.unset,
aws_storage_enabled: Union[bool, object] = values.unset,
encryption_enabled: Union[bool, object] = values.unset,
) -> "CompositionSettingsInstance":
"""
Create the CompositionSettingsInstance
:param friendly_name: A descriptive string that you create to describe the resource and show to the user in the console
:param aws_credentials_sid: The SID of the stored Credential resource.
:param encryption_key_sid: The SID of the Public Key resource to use for encryption.
:param aws_s3_url: The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
:param aws_storage_enabled: Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
:param encryption_enabled: Whether all compositions should be stored in an encrypted form. The default is `false`.
:returns: The created CompositionSettingsInstance
"""
return self._proxy.create(
friendly_name,
aws_credentials_sid=aws_credentials_sid,
encryption_key_sid=encryption_key_sid,
aws_s3_url=aws_s3_url,
aws_storage_enabled=aws_storage_enabled,
encryption_enabled=encryption_enabled,
)
async def create_async(
self,
friendly_name: str,
aws_credentials_sid: Union[str, object] = values.unset,
encryption_key_sid: Union[str, object] = values.unset,
aws_s3_url: Union[str, object] = values.unset,
aws_storage_enabled: Union[bool, object] = values.unset,
encryption_enabled: Union[bool, object] = values.unset,
) -> "CompositionSettingsInstance":
"""
Asynchronous coroutine to create the CompositionSettingsInstance
:param friendly_name: A descriptive string that you create to describe the resource and show to the user in the console
:param aws_credentials_sid: The SID of the stored Credential resource.
:param encryption_key_sid: The SID of the Public Key resource to use for encryption.
:param aws_s3_url: The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
:param aws_storage_enabled: Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
:param encryption_enabled: Whether all compositions should be stored in an encrypted form. The default is `false`.
:returns: The created CompositionSettingsInstance
"""
return await self._proxy.create_async(
friendly_name,
aws_credentials_sid=aws_credentials_sid,
encryption_key_sid=encryption_key_sid,
aws_s3_url=aws_s3_url,
aws_storage_enabled=aws_storage_enabled,
encryption_enabled=encryption_enabled,
)
def fetch(self) -> "CompositionSettingsInstance":
"""
Fetch the CompositionSettingsInstance
:returns: The fetched CompositionSettingsInstance
"""
return self._proxy.fetch()
async def fetch_async(self) -> "CompositionSettingsInstance":
"""
Asynchronous coroutine to fetch the CompositionSettingsInstance
:returns: The fetched CompositionSettingsInstance
"""
return await self._proxy.fetch_async()
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Video.V1.CompositionSettingsInstance>"
class CompositionSettingsContext(InstanceContext):
def __init__(self, version: Version):
"""
Initialize the CompositionSettingsContext
:param version: Version that contains the resource
"""
super().__init__(version)
self._uri = "/CompositionSettings/Default"
def create(
self,
friendly_name: str,
aws_credentials_sid: Union[str, object] = values.unset,
encryption_key_sid: Union[str, object] = values.unset,
aws_s3_url: Union[str, object] = values.unset,
aws_storage_enabled: Union[bool, object] = values.unset,
encryption_enabled: Union[bool, object] = values.unset,
) -> CompositionSettingsInstance:
"""
Create the CompositionSettingsInstance
:param friendly_name: A descriptive string that you create to describe the resource and show to the user in the console
:param aws_credentials_sid: The SID of the stored Credential resource.
:param encryption_key_sid: The SID of the Public Key resource to use for encryption.
:param aws_s3_url: The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
:param aws_storage_enabled: Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
:param encryption_enabled: Whether all compositions should be stored in an encrypted form. The default is `false`.
:returns: The created CompositionSettingsInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"AwsCredentialsSid": aws_credentials_sid,
"EncryptionKeySid": encryption_key_sid,
"AwsS3Url": aws_s3_url,
"AwsStorageEnabled": serialize.boolean_to_string(aws_storage_enabled),
"EncryptionEnabled": serialize.boolean_to_string(encryption_enabled),
}
)
payload = self._version.create(method="POST", uri=self._uri, data=data)
return CompositionSettingsInstance(self._version, payload)
async def create_async(
self,
friendly_name: str,
aws_credentials_sid: Union[str, object] = values.unset,
encryption_key_sid: Union[str, object] = values.unset,
aws_s3_url: Union[str, object] = values.unset,
aws_storage_enabled: Union[bool, object] = values.unset,
encryption_enabled: Union[bool, object] = values.unset,
) -> CompositionSettingsInstance:
"""
Asynchronous coroutine to create the CompositionSettingsInstance
:param friendly_name: A descriptive string that you create to describe the resource and show to the user in the console
:param aws_credentials_sid: The SID of the stored Credential resource.
:param encryption_key_sid: The SID of the Public Key resource to use for encryption.
:param aws_s3_url: The URL of the AWS S3 bucket where the compositions should be stored. We only support DNS-compliant URLs like `https://documentation-example-twilio-bucket/compositions`, where `compositions` is the path in which you want the compositions to be stored. This URL accepts only URI-valid characters, as described in the [RFC 3986](https://tools.ietf.org/html/rfc3986#section-2).
:param aws_storage_enabled: Whether all compositions should be written to the `aws_s3_url`. When `false`, all compositions are stored in our cloud.
:param encryption_enabled: Whether all compositions should be stored in an encrypted form. The default is `false`.
:returns: The created CompositionSettingsInstance
"""
data = values.of(
{
"FriendlyName": friendly_name,
"AwsCredentialsSid": aws_credentials_sid,
"EncryptionKeySid": encryption_key_sid,
"AwsS3Url": aws_s3_url,
"AwsStorageEnabled": serialize.boolean_to_string(aws_storage_enabled),
"EncryptionEnabled": serialize.boolean_to_string(encryption_enabled),
}
)
payload = await self._version.create_async(
method="POST", uri=self._uri, data=data
)
return CompositionSettingsInstance(self._version, payload)
def fetch(self) -> CompositionSettingsInstance:
"""
Fetch the CompositionSettingsInstance
:returns: The fetched CompositionSettingsInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = self._version.fetch(method="GET", uri=self._uri, headers=headers)
return CompositionSettingsInstance(
self._version,
payload,
)
async def fetch_async(self) -> CompositionSettingsInstance:
"""
Asynchronous coroutine to fetch the CompositionSettingsInstance
:returns: The fetched CompositionSettingsInstance
"""
headers = values.of({})
headers["Accept"] = "application/json"
payload = await self._version.fetch_async(
method="GET", uri=self._uri, headers=headers
)
return CompositionSettingsInstance(
self._version,
payload,
)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Video.V1.CompositionSettingsContext>"
class CompositionSettingsList(ListResource):
def __init__(self, version: Version):
"""
Initialize the CompositionSettingsList
:param version: Version that contains the resource
"""
super().__init__(version)
def get(self) -> CompositionSettingsContext:
"""
Constructs a CompositionSettingsContext
"""
return CompositionSettingsContext(self._version)
def __call__(self) -> CompositionSettingsContext:
"""
Constructs a CompositionSettingsContext
"""
return CompositionSettingsContext(self._version)
def __repr__(self) -> str:
"""
Provide a friendly representation
:returns: Machine friendly representation
"""
return "<Twilio.Video.V1.CompositionSettingsList>"
|
