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
|
# coding=utf-8
r"""
This code was generated by
\ / _ _ _| _ _
| (_)\/(_)(_|\/| |(/_ v1.0.0
/ /
"""
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
class WebhookList(ListResource):
def __init__(self, version):
"""
Initialize the WebhookList
:param Version version: Version that contains the resource
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookList
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookList
"""
super(WebhookList, self).__init__(version)
# Path Solution
self._solution = {}
def get(self):
"""
Constructs a WebhookContext
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
"""
return WebhookContext(self._version, )
def __call__(self):
"""
Constructs a WebhookContext
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
"""
return WebhookContext(self._version, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.WebhookList>'
class WebhookPage(Page):
def __init__(self, version, response, solution):
"""
Initialize the WebhookPage
:param Version version: Version that contains the resource
:param Response response: Response from the API
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookPage
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookPage
"""
super(WebhookPage, self).__init__(version, response)
# Path Solution
self._solution = solution
def get_instance(self, payload):
"""
Build an instance of WebhookInstance
:param dict payload: Payload response from the API
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
return WebhookInstance(self._version, payload, )
def __repr__(self):
"""
Provide a friendly representation
:returns: Machine friendly representation
:rtype: str
"""
return '<Twilio.Conversations.V1.WebhookPage>'
class WebhookContext(InstanceContext):
def __init__(self, version):
"""
Initialize the WebhookContext
:param Version version: Version that contains the resource
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
"""
super(WebhookContext, self).__init__(version)
# Path Solution
self._solution = {}
self._uri = '/Configuration/Webhooks'.format(**self._solution)
def fetch(self):
"""
Fetch the WebhookInstance
:returns: The fetched WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
payload = self._version.fetch(method='GET', uri=self._uri, )
return WebhookInstance(self._version, payload, )
def update(self, method=values.unset, filters=values.unset,
pre_webhook_url=values.unset, post_webhook_url=values.unset,
target=values.unset):
"""
Update the WebhookInstance
:param unicode method: The HTTP method to be used when sending a webhook request.
:param list[unicode] filters: The list of webhook event triggers that are enabled for this Service.
:param unicode pre_webhook_url: The absolute url the pre-event webhook request should be sent to.
:param unicode post_webhook_url: The absolute url the post-event webhook request should be sent to.
:param WebhookInstance.Target target: The routing target of the webhook.
:returns: The updated WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
data = values.of({
'Method': method,
'Filters': serialize.map(filters, lambda e: e),
'PreWebhookUrl': pre_webhook_url,
'PostWebhookUrl': post_webhook_url,
'Target': target,
})
payload = self._version.update(method='POST', uri=self._uri, data=data, )
return WebhookInstance(self._version, payload, )
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.Conversations.V1.WebhookContext {}>'.format(context)
class WebhookInstance(InstanceResource):
class Target(object):
WEBHOOK = "webhook"
FLEX = "flex"
class Method(object):
GET = "GET"
POST = "POST"
def __init__(self, version, payload):
"""
Initialize the WebhookInstance
:returns: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
super(WebhookInstance, self).__init__(version)
# Marshaled Properties
self._properties = {
'account_sid': payload.get('account_sid'),
'method': payload.get('method'),
'filters': payload.get('filters'),
'pre_webhook_url': payload.get('pre_webhook_url'),
'post_webhook_url': payload.get('post_webhook_url'),
'target': payload.get('target'),
'url': payload.get('url'),
}
# Context
self._context = None
self._solution = {}
@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: WebhookContext for this WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookContext
"""
if self._context is None:
self._context = WebhookContext(self._version, )
return self._context
@property
def account_sid(self):
"""
:returns: The unique ID of the Account responsible for this conversation.
:rtype: unicode
"""
return self._properties['account_sid']
@property
def method(self):
"""
:returns: The HTTP method to be used when sending a webhook request.
:rtype: WebhookInstance.Method
"""
return self._properties['method']
@property
def filters(self):
"""
:returns: The list of webhook event triggers that are enabled for this Service.
:rtype: list[unicode]
"""
return self._properties['filters']
@property
def pre_webhook_url(self):
"""
:returns: The absolute url the pre-event webhook request should be sent to.
:rtype: unicode
"""
return self._properties['pre_webhook_url']
@property
def post_webhook_url(self):
"""
:returns: The absolute url the post-event webhook request should be sent to.
:rtype: unicode
"""
return self._properties['post_webhook_url']
@property
def target(self):
"""
:returns: The routing target of the webhook.
:rtype: WebhookInstance.Target
"""
return self._properties['target']
@property
def url(self):
"""
:returns: An absolute URL for this webhook.
:rtype: unicode
"""
return self._properties['url']
def fetch(self):
"""
Fetch the WebhookInstance
:returns: The fetched WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
return self._proxy.fetch()
def update(self, method=values.unset, filters=values.unset,
pre_webhook_url=values.unset, post_webhook_url=values.unset,
target=values.unset):
"""
Update the WebhookInstance
:param unicode method: The HTTP method to be used when sending a webhook request.
:param list[unicode] filters: The list of webhook event triggers that are enabled for this Service.
:param unicode pre_webhook_url: The absolute url the pre-event webhook request should be sent to.
:param unicode post_webhook_url: The absolute url the post-event webhook request should be sent to.
:param WebhookInstance.Target target: The routing target of the webhook.
:returns: The updated WebhookInstance
:rtype: twilio.rest.conversations.v1.configuration.webhook.WebhookInstance
"""
return self._proxy.update(
method=method,
filters=filters,
pre_webhook_url=pre_webhook_url,
post_webhook_url=post_webhook_url,
target=target,
)
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.Conversations.V1.WebhookInstance {}>'.format(context)
|