Module mailslurp_client.models.webhook_dto
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - Homepage - Get an API KEY - Generated SDK Clients - Examples repository # noqa: E501
The version of the OpenAPI document: 6.5.2 Contact: contact@mailslurp.dev Generated by: https://openapi-generator.tech
Expand source code
# coding: utf-8
"""
MailSlurp API
MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository # noqa: E501
The version of the OpenAPI document: 6.5.2
Contact: contact@mailslurp.dev
Generated by: https://openapi-generator.tech
"""
import pprint
import re # noqa: F401
import six
from mailslurp_client.configuration import Configuration
class WebhookDto(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""
"""
Attributes:
openapi_types (dict): The key is attribute name
and the value is attribute type.
attribute_map (dict): The key is attribute name
and the value is json key in definition.
"""
openapi_types = {
'id': 'str',
'user_id': 'str',
'basic_auth': 'bool',
'name': 'str',
'phone_id': 'str',
'inbox_id': 'str',
'request_body_template': 'str',
'url': 'str',
'method': 'str',
'payload_json_schema': 'str',
'created_at': 'datetime',
'updated_at': 'datetime',
'event_name': 'str',
'request_headers': 'WebhookHeaders',
'ignore_insecure_ssl_certificates': 'bool',
'use_static_ip_range': 'bool'
}
attribute_map = {
'id': 'id',
'user_id': 'userId',
'basic_auth': 'basicAuth',
'name': 'name',
'phone_id': 'phoneId',
'inbox_id': 'inboxId',
'request_body_template': 'requestBodyTemplate',
'url': 'url',
'method': 'method',
'payload_json_schema': 'payloadJsonSchema',
'created_at': 'createdAt',
'updated_at': 'updatedAt',
'event_name': 'eventName',
'request_headers': 'requestHeaders',
'ignore_insecure_ssl_certificates': 'ignoreInsecureSslCertificates',
'use_static_ip_range': 'useStaticIpRange'
}
def __init__(self, id=None, user_id=None, basic_auth=None, name=None, phone_id=None, inbox_id=None, request_body_template=None, url=None, method=None, payload_json_schema=None, created_at=None, updated_at=None, event_name=None, request_headers=None, ignore_insecure_ssl_certificates=None, use_static_ip_range=None, local_vars_configuration=None): # noqa: E501
"""WebhookDto - a model defined in OpenAPI""" # noqa: E501
if local_vars_configuration is None:
local_vars_configuration = Configuration()
self.local_vars_configuration = local_vars_configuration
self._id = None
self._user_id = None
self._basic_auth = None
self._name = None
self._phone_id = None
self._inbox_id = None
self._request_body_template = None
self._url = None
self._method = None
self._payload_json_schema = None
self._created_at = None
self._updated_at = None
self._event_name = None
self._request_headers = None
self._ignore_insecure_ssl_certificates = None
self._use_static_ip_range = None
self.discriminator = None
self.id = id
self.user_id = user_id
self.basic_auth = basic_auth
self.name = name
self.phone_id = phone_id
self.inbox_id = inbox_id
self.request_body_template = request_body_template
self.url = url
self.method = method
self.payload_json_schema = payload_json_schema
self.created_at = created_at
self.updated_at = updated_at
self.event_name = event_name
if request_headers is not None:
self.request_headers = request_headers
self.ignore_insecure_ssl_certificates = ignore_insecure_ssl_certificates
self.use_static_ip_range = use_static_ip_range
@property
def id(self):
"""Gets the id of this WebhookDto. # noqa: E501
ID of the Webhook # noqa: E501
:return: The id of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._id
@id.setter
def id(self, id):
"""Sets the id of this WebhookDto.
ID of the Webhook # noqa: E501
:param id: The id of this WebhookDto. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501
raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501
self._id = id
@property
def user_id(self):
"""Gets the user_id of this WebhookDto. # noqa: E501
User ID of the Webhook # noqa: E501
:return: The user_id of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._user_id
@user_id.setter
def user_id(self, user_id):
"""Sets the user_id of this WebhookDto.
User ID of the Webhook # noqa: E501
:param user_id: The user_id of this WebhookDto. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and user_id is None: # noqa: E501
raise ValueError("Invalid value for `user_id`, must not be `None`") # noqa: E501
self._user_id = user_id
@property
def basic_auth(self):
"""Gets the basic_auth of this WebhookDto. # noqa: E501
Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501
:return: The basic_auth of this WebhookDto. # noqa: E501
:rtype: bool
"""
return self._basic_auth
@basic_auth.setter
def basic_auth(self, basic_auth):
"""Sets the basic_auth of this WebhookDto.
Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501
:param basic_auth: The basic_auth of this WebhookDto. # noqa: E501
:type: bool
"""
if self.local_vars_configuration.client_side_validation and basic_auth is None: # noqa: E501
raise ValueError("Invalid value for `basic_auth`, must not be `None`") # noqa: E501
self._basic_auth = basic_auth
@property
def name(self):
"""Gets the name of this WebhookDto. # noqa: E501
Name of the webhook # noqa: E501
:return: The name of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._name
@name.setter
def name(self, name):
"""Sets the name of this WebhookDto.
Name of the webhook # noqa: E501
:param name: The name of this WebhookDto. # noqa: E501
:type: str
"""
self._name = name
@property
def phone_id(self):
"""Gets the phone_id of this WebhookDto. # noqa: E501
The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501
:return: The phone_id of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._phone_id
@phone_id.setter
def phone_id(self, phone_id):
"""Sets the phone_id of this WebhookDto.
The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501
:param phone_id: The phone_id of this WebhookDto. # noqa: E501
:type: str
"""
self._phone_id = phone_id
@property
def inbox_id(self):
"""Gets the inbox_id of this WebhookDto. # noqa: E501
The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501
:return: The inbox_id of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._inbox_id
@inbox_id.setter
def inbox_id(self, inbox_id):
"""Sets the inbox_id of this WebhookDto.
The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501
:param inbox_id: The inbox_id of this WebhookDto. # noqa: E501
:type: str
"""
self._inbox_id = inbox_id
@property
def request_body_template(self):
"""Gets the request_body_template of this WebhookDto. # noqa: E501
Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501
:return: The request_body_template of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._request_body_template
@request_body_template.setter
def request_body_template(self, request_body_template):
"""Sets the request_body_template of this WebhookDto.
Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501
:param request_body_template: The request_body_template of this WebhookDto. # noqa: E501
:type: str
"""
self._request_body_template = request_body_template
@property
def url(self):
"""Gets the url of this WebhookDto. # noqa: E501
URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501
:return: The url of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._url
@url.setter
def url(self, url):
"""Sets the url of this WebhookDto.
URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501
:param url: The url of this WebhookDto. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and url is None: # noqa: E501
raise ValueError("Invalid value for `url`, must not be `None`") # noqa: E501
self._url = url
@property
def method(self):
"""Gets the method of this WebhookDto. # noqa: E501
HTTP method that your server endpoint must listen for # noqa: E501
:return: The method of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._method
@method.setter
def method(self, method):
"""Sets the method of this WebhookDto.
HTTP method that your server endpoint must listen for # noqa: E501
:param method: The method of this WebhookDto. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and method is None: # noqa: E501
raise ValueError("Invalid value for `method`, must not be `None`") # noqa: E501
allowed_values = ["POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE"] # noqa: E501
if self.local_vars_configuration.client_side_validation and method not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `method` ({0}), must be one of {1}" # noqa: E501
.format(method, allowed_values)
)
self._method = method
@property
def payload_json_schema(self):
"""Gets the payload_json_schema of this WebhookDto. # noqa: E501
Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501
:return: The payload_json_schema of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._payload_json_schema
@payload_json_schema.setter
def payload_json_schema(self, payload_json_schema):
"""Sets the payload_json_schema of this WebhookDto.
Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501
:param payload_json_schema: The payload_json_schema of this WebhookDto. # noqa: E501
:type: str
"""
if self.local_vars_configuration.client_side_validation and payload_json_schema is None: # noqa: E501
raise ValueError("Invalid value for `payload_json_schema`, must not be `None`") # noqa: E501
self._payload_json_schema = payload_json_schema
@property
def created_at(self):
"""Gets the created_at of this WebhookDto. # noqa: E501
When the webhook was created # noqa: E501
:return: The created_at of this WebhookDto. # noqa: E501
:rtype: datetime
"""
return self._created_at
@created_at.setter
def created_at(self, created_at):
"""Sets the created_at of this WebhookDto.
When the webhook was created # noqa: E501
:param created_at: The created_at of this WebhookDto. # noqa: E501
:type: datetime
"""
self._created_at = created_at
@property
def updated_at(self):
"""Gets the updated_at of this WebhookDto. # noqa: E501
:return: The updated_at of this WebhookDto. # noqa: E501
:rtype: datetime
"""
return self._updated_at
@updated_at.setter
def updated_at(self, updated_at):
"""Sets the updated_at of this WebhookDto.
:param updated_at: The updated_at of this WebhookDto. # noqa: E501
:type: datetime
"""
if self.local_vars_configuration.client_side_validation and updated_at is None: # noqa: E501
raise ValueError("Invalid value for `updated_at`, must not be `None`") # noqa: E501
self._updated_at = updated_at
@property
def event_name(self):
"""Gets the event_name of this WebhookDto. # noqa: E501
Webhook trigger event name # noqa: E501
:return: The event_name of this WebhookDto. # noqa: E501
:rtype: str
"""
return self._event_name
@event_name.setter
def event_name(self, event_name):
"""Sets the event_name of this WebhookDto.
Webhook trigger event name # noqa: E501
:param event_name: The event_name of this WebhookDto. # noqa: E501
:type: str
"""
allowed_values = [None,"EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"] # noqa: E501
if self.local_vars_configuration.client_side_validation and event_name not in allowed_values: # noqa: E501
raise ValueError(
"Invalid value for `event_name` ({0}), must be one of {1}" # noqa: E501
.format(event_name, allowed_values)
)
self._event_name = event_name
@property
def request_headers(self):
"""Gets the request_headers of this WebhookDto. # noqa: E501
:return: The request_headers of this WebhookDto. # noqa: E501
:rtype: WebhookHeaders
"""
return self._request_headers
@request_headers.setter
def request_headers(self, request_headers):
"""Sets the request_headers of this WebhookDto.
:param request_headers: The request_headers of this WebhookDto. # noqa: E501
:type: WebhookHeaders
"""
self._request_headers = request_headers
@property
def ignore_insecure_ssl_certificates(self):
"""Gets the ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501
Should notifier ignore insecure SSL certificates # noqa: E501
:return: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501
:rtype: bool
"""
return self._ignore_insecure_ssl_certificates
@ignore_insecure_ssl_certificates.setter
def ignore_insecure_ssl_certificates(self, ignore_insecure_ssl_certificates):
"""Sets the ignore_insecure_ssl_certificates of this WebhookDto.
Should notifier ignore insecure SSL certificates # noqa: E501
:param ignore_insecure_ssl_certificates: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501
:type: bool
"""
self._ignore_insecure_ssl_certificates = ignore_insecure_ssl_certificates
@property
def use_static_ip_range(self):
"""Gets the use_static_ip_range of this WebhookDto. # noqa: E501
Should notifier use static IP range when sending webhook payload # noqa: E501
:return: The use_static_ip_range of this WebhookDto. # noqa: E501
:rtype: bool
"""
return self._use_static_ip_range
@use_static_ip_range.setter
def use_static_ip_range(self, use_static_ip_range):
"""Sets the use_static_ip_range of this WebhookDto.
Should notifier use static IP range when sending webhook payload # noqa: E501
:param use_static_ip_range: The use_static_ip_range of this WebhookDto. # noqa: E501
:type: bool
"""
self._use_static_ip_range = use_static_ip_range
def to_dict(self):
"""Returns the model properties as a dict"""
result = {}
for attr, _ in six.iteritems(self.openapi_types):
value = getattr(self, attr)
if isinstance(value, list):
result[attr] = list(map(
lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
value
))
elif hasattr(value, "to_dict"):
result[attr] = value.to_dict()
elif isinstance(value, dict):
result[attr] = dict(map(
lambda item: (item[0], item[1].to_dict())
if hasattr(item[1], "to_dict") else item,
value.items()
))
else:
result[attr] = value
return result
def to_str(self):
"""Returns the string representation of the model"""
return pprint.pformat(self.to_dict())
def __repr__(self):
"""For `print` and `pprint`"""
return self.to_str()
def __eq__(self, other):
"""Returns true if both objects are equal"""
if not isinstance(other, WebhookDto):
return False
return self.to_dict() == other.to_dict()
def __ne__(self, other):
"""Returns true if both objects are not equal"""
if not isinstance(other, WebhookDto):
return True
return self.to_dict() != other.to_dict()Classes
class WebhookDto (id=None, user_id=None, basic_auth=None, name=None, phone_id=None, inbox_id=None, request_body_template=None, url=None, method=None, payload_json_schema=None, created_at=None, updated_at=None, event_name=None, request_headers=None, ignore_insecure_ssl_certificates=None, use_static_ip_range=None, local_vars_configuration=None)-
NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech
Do not edit the class manually.
WebhookDto - a model defined in OpenAPI
Expand source code
class WebhookDto(object): """NOTE: This class is auto generated by OpenAPI Generator. Ref: https://openapi-generator.tech Do not edit the class manually. """ """ Attributes: openapi_types (dict): The key is attribute name and the value is attribute type. attribute_map (dict): The key is attribute name and the value is json key in definition. """ openapi_types = { 'id': 'str', 'user_id': 'str', 'basic_auth': 'bool', 'name': 'str', 'phone_id': 'str', 'inbox_id': 'str', 'request_body_template': 'str', 'url': 'str', 'method': 'str', 'payload_json_schema': 'str', 'created_at': 'datetime', 'updated_at': 'datetime', 'event_name': 'str', 'request_headers': 'WebhookHeaders', 'ignore_insecure_ssl_certificates': 'bool', 'use_static_ip_range': 'bool' } attribute_map = { 'id': 'id', 'user_id': 'userId', 'basic_auth': 'basicAuth', 'name': 'name', 'phone_id': 'phoneId', 'inbox_id': 'inboxId', 'request_body_template': 'requestBodyTemplate', 'url': 'url', 'method': 'method', 'payload_json_schema': 'payloadJsonSchema', 'created_at': 'createdAt', 'updated_at': 'updatedAt', 'event_name': 'eventName', 'request_headers': 'requestHeaders', 'ignore_insecure_ssl_certificates': 'ignoreInsecureSslCertificates', 'use_static_ip_range': 'useStaticIpRange' } def __init__(self, id=None, user_id=None, basic_auth=None, name=None, phone_id=None, inbox_id=None, request_body_template=None, url=None, method=None, payload_json_schema=None, created_at=None, updated_at=None, event_name=None, request_headers=None, ignore_insecure_ssl_certificates=None, use_static_ip_range=None, local_vars_configuration=None): # noqa: E501 """WebhookDto - a model defined in OpenAPI""" # noqa: E501 if local_vars_configuration is None: local_vars_configuration = Configuration() self.local_vars_configuration = local_vars_configuration self._id = None self._user_id = None self._basic_auth = None self._name = None self._phone_id = None self._inbox_id = None self._request_body_template = None self._url = None self._method = None self._payload_json_schema = None self._created_at = None self._updated_at = None self._event_name = None self._request_headers = None self._ignore_insecure_ssl_certificates = None self._use_static_ip_range = None self.discriminator = None self.id = id self.user_id = user_id self.basic_auth = basic_auth self.name = name self.phone_id = phone_id self.inbox_id = inbox_id self.request_body_template = request_body_template self.url = url self.method = method self.payload_json_schema = payload_json_schema self.created_at = created_at self.updated_at = updated_at self.event_name = event_name if request_headers is not None: self.request_headers = request_headers self.ignore_insecure_ssl_certificates = ignore_insecure_ssl_certificates self.use_static_ip_range = use_static_ip_range @property def id(self): """Gets the id of this WebhookDto. # noqa: E501 ID of the Webhook # noqa: E501 :return: The id of this WebhookDto. # noqa: E501 :rtype: str """ return self._id @id.setter def id(self, id): """Sets the id of this WebhookDto. ID of the Webhook # noqa: E501 :param id: The id of this WebhookDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and id is None: # noqa: E501 raise ValueError("Invalid value for `id`, must not be `None`") # noqa: E501 self._id = id @property def user_id(self): """Gets the user_id of this WebhookDto. # noqa: E501 User ID of the Webhook # noqa: E501 :return: The user_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._user_id @user_id.setter def user_id(self, user_id): """Sets the user_id of this WebhookDto. User ID of the Webhook # noqa: E501 :param user_id: The user_id of this WebhookDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and user_id is None: # noqa: E501 raise ValueError("Invalid value for `user_id`, must not be `None`") # noqa: E501 self._user_id = user_id @property def basic_auth(self): """Gets the basic_auth of this WebhookDto. # noqa: E501 Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501 :return: The basic_auth of this WebhookDto. # noqa: E501 :rtype: bool """ return self._basic_auth @basic_auth.setter def basic_auth(self, basic_auth): """Sets the basic_auth of this WebhookDto. Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501 :param basic_auth: The basic_auth of this WebhookDto. # noqa: E501 :type: bool """ if self.local_vars_configuration.client_side_validation and basic_auth is None: # noqa: E501 raise ValueError("Invalid value for `basic_auth`, must not be `None`") # noqa: E501 self._basic_auth = basic_auth @property def name(self): """Gets the name of this WebhookDto. # noqa: E501 Name of the webhook # noqa: E501 :return: The name of this WebhookDto. # noqa: E501 :rtype: str """ return self._name @name.setter def name(self, name): """Sets the name of this WebhookDto. Name of the webhook # noqa: E501 :param name: The name of this WebhookDto. # noqa: E501 :type: str """ self._name = name @property def phone_id(self): """Gets the phone_id of this WebhookDto. # noqa: E501 The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501 :return: The phone_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._phone_id @phone_id.setter def phone_id(self, phone_id): """Sets the phone_id of this WebhookDto. The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501 :param phone_id: The phone_id of this WebhookDto. # noqa: E501 :type: str """ self._phone_id = phone_id @property def inbox_id(self): """Gets the inbox_id of this WebhookDto. # noqa: E501 The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501 :return: The inbox_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._inbox_id @inbox_id.setter def inbox_id(self, inbox_id): """Sets the inbox_id of this WebhookDto. The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501 :param inbox_id: The inbox_id of this WebhookDto. # noqa: E501 :type: str """ self._inbox_id = inbox_id @property def request_body_template(self): """Gets the request_body_template of this WebhookDto. # noqa: E501 Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501 :return: The request_body_template of this WebhookDto. # noqa: E501 :rtype: str """ return self._request_body_template @request_body_template.setter def request_body_template(self, request_body_template): """Sets the request_body_template of this WebhookDto. Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501 :param request_body_template: The request_body_template of this WebhookDto. # noqa: E501 :type: str """ self._request_body_template = request_body_template @property def url(self): """Gets the url of this WebhookDto. # noqa: E501 URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501 :return: The url of this WebhookDto. # noqa: E501 :rtype: str """ return self._url @url.setter def url(self, url): """Sets the url of this WebhookDto. URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501 :param url: The url of this WebhookDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and url is None: # noqa: E501 raise ValueError("Invalid value for `url`, must not be `None`") # noqa: E501 self._url = url @property def method(self): """Gets the method of this WebhookDto. # noqa: E501 HTTP method that your server endpoint must listen for # noqa: E501 :return: The method of this WebhookDto. # noqa: E501 :rtype: str """ return self._method @method.setter def method(self, method): """Sets the method of this WebhookDto. HTTP method that your server endpoint must listen for # noqa: E501 :param method: The method of this WebhookDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and method is None: # noqa: E501 raise ValueError("Invalid value for `method`, must not be `None`") # noqa: E501 allowed_values = ["POST", "DELETE", "GET", "PUT", "PATCH", "HEAD", "OPTIONS", "TRACE"] # noqa: E501 if self.local_vars_configuration.client_side_validation and method not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `method` ({0}), must be one of {1}" # noqa: E501 .format(method, allowed_values) ) self._method = method @property def payload_json_schema(self): """Gets the payload_json_schema of this WebhookDto. # noqa: E501 Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501 :return: The payload_json_schema of this WebhookDto. # noqa: E501 :rtype: str """ return self._payload_json_schema @payload_json_schema.setter def payload_json_schema(self, payload_json_schema): """Sets the payload_json_schema of this WebhookDto. Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501 :param payload_json_schema: The payload_json_schema of this WebhookDto. # noqa: E501 :type: str """ if self.local_vars_configuration.client_side_validation and payload_json_schema is None: # noqa: E501 raise ValueError("Invalid value for `payload_json_schema`, must not be `None`") # noqa: E501 self._payload_json_schema = payload_json_schema @property def created_at(self): """Gets the created_at of this WebhookDto. # noqa: E501 When the webhook was created # noqa: E501 :return: The created_at of this WebhookDto. # noqa: E501 :rtype: datetime """ return self._created_at @created_at.setter def created_at(self, created_at): """Sets the created_at of this WebhookDto. When the webhook was created # noqa: E501 :param created_at: The created_at of this WebhookDto. # noqa: E501 :type: datetime """ self._created_at = created_at @property def updated_at(self): """Gets the updated_at of this WebhookDto. # noqa: E501 :return: The updated_at of this WebhookDto. # noqa: E501 :rtype: datetime """ return self._updated_at @updated_at.setter def updated_at(self, updated_at): """Sets the updated_at of this WebhookDto. :param updated_at: The updated_at of this WebhookDto. # noqa: E501 :type: datetime """ if self.local_vars_configuration.client_side_validation and updated_at is None: # noqa: E501 raise ValueError("Invalid value for `updated_at`, must not be `None`") # noqa: E501 self._updated_at = updated_at @property def event_name(self): """Gets the event_name of this WebhookDto. # noqa: E501 Webhook trigger event name # noqa: E501 :return: The event_name of this WebhookDto. # noqa: E501 :rtype: str """ return self._event_name @event_name.setter def event_name(self, event_name): """Sets the event_name of this WebhookDto. Webhook trigger event name # noqa: E501 :param event_name: The event_name of this WebhookDto. # noqa: E501 :type: str """ allowed_values = [None,"EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ", "DELIVERY_STATUS", "BOUNCE", "BOUNCE_RECIPIENT", "NEW_SMS"] # noqa: E501 if self.local_vars_configuration.client_side_validation and event_name not in allowed_values: # noqa: E501 raise ValueError( "Invalid value for `event_name` ({0}), must be one of {1}" # noqa: E501 .format(event_name, allowed_values) ) self._event_name = event_name @property def request_headers(self): """Gets the request_headers of this WebhookDto. # noqa: E501 :return: The request_headers of this WebhookDto. # noqa: E501 :rtype: WebhookHeaders """ return self._request_headers @request_headers.setter def request_headers(self, request_headers): """Sets the request_headers of this WebhookDto. :param request_headers: The request_headers of this WebhookDto. # noqa: E501 :type: WebhookHeaders """ self._request_headers = request_headers @property def ignore_insecure_ssl_certificates(self): """Gets the ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 Should notifier ignore insecure SSL certificates # noqa: E501 :return: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 :rtype: bool """ return self._ignore_insecure_ssl_certificates @ignore_insecure_ssl_certificates.setter def ignore_insecure_ssl_certificates(self, ignore_insecure_ssl_certificates): """Sets the ignore_insecure_ssl_certificates of this WebhookDto. Should notifier ignore insecure SSL certificates # noqa: E501 :param ignore_insecure_ssl_certificates: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 :type: bool """ self._ignore_insecure_ssl_certificates = ignore_insecure_ssl_certificates @property def use_static_ip_range(self): """Gets the use_static_ip_range of this WebhookDto. # noqa: E501 Should notifier use static IP range when sending webhook payload # noqa: E501 :return: The use_static_ip_range of this WebhookDto. # noqa: E501 :rtype: bool """ return self._use_static_ip_range @use_static_ip_range.setter def use_static_ip_range(self, use_static_ip_range): """Sets the use_static_ip_range of this WebhookDto. Should notifier use static IP range when sending webhook payload # noqa: E501 :param use_static_ip_range: The use_static_ip_range of this WebhookDto. # noqa: E501 :type: bool """ self._use_static_ip_range = use_static_ip_range def to_dict(self): """Returns the model properties as a dict""" result = {} for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value )) elif hasattr(value, "to_dict"): result[attr] = value.to_dict() elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, value.items() )) else: result[attr] = value return result def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict()) def __repr__(self): """For `print` and `pprint`""" return self.to_str() def __eq__(self, other): """Returns true if both objects are equal""" if not isinstance(other, WebhookDto): return False return self.to_dict() == other.to_dict() def __ne__(self, other): """Returns true if both objects are not equal""" if not isinstance(other, WebhookDto): return True return self.to_dict() != other.to_dict()Class variables
var attribute_mapvar openapi_types
Instance variables
var basic_auth-
Gets the basic_auth of this WebhookDto. # noqa: E501
Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501
:return: The basic_auth of this WebhookDto. # noqa: E501 :rtype: bool
Expand source code
@property def basic_auth(self): """Gets the basic_auth of this WebhookDto. # noqa: E501 Does webhook expect basic authentication? If true it means you created this webhook with a username and password. MailSlurp will use these in the URL to authenticate itself. # noqa: E501 :return: The basic_auth of this WebhookDto. # noqa: E501 :rtype: bool """ return self._basic_auth var created_at-
Gets the created_at of this WebhookDto. # noqa: E501
When the webhook was created # noqa: E501
:return: The created_at of this WebhookDto. # noqa: E501 :rtype: datetime
Expand source code
@property def created_at(self): """Gets the created_at of this WebhookDto. # noqa: E501 When the webhook was created # noqa: E501 :return: The created_at of this WebhookDto. # noqa: E501 :rtype: datetime """ return self._created_at var event_name-
Gets the event_name of this WebhookDto. # noqa: E501
Webhook trigger event name # noqa: E501
:return: The event_name of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def event_name(self): """Gets the event_name of this WebhookDto. # noqa: E501 Webhook trigger event name # noqa: E501 :return: The event_name of this WebhookDto. # noqa: E501 :rtype: str """ return self._event_name var id-
Gets the id of this WebhookDto. # noqa: E501
ID of the Webhook # noqa: E501
:return: The id of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def id(self): """Gets the id of this WebhookDto. # noqa: E501 ID of the Webhook # noqa: E501 :return: The id of this WebhookDto. # noqa: E501 :rtype: str """ return self._id var ignore_insecure_ssl_certificates-
Gets the ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501
Should notifier ignore insecure SSL certificates # noqa: E501
:return: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 :rtype: bool
Expand source code
@property def ignore_insecure_ssl_certificates(self): """Gets the ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 Should notifier ignore insecure SSL certificates # noqa: E501 :return: The ignore_insecure_ssl_certificates of this WebhookDto. # noqa: E501 :rtype: bool """ return self._ignore_insecure_ssl_certificates var inbox_id-
Gets the inbox_id of this WebhookDto. # noqa: E501
The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501
:return: The inbox_id of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def inbox_id(self): """Gets the inbox_id of this WebhookDto. # noqa: E501 The inbox that the Webhook will be triggered by. If null then webhook triggered at account level or phone level if phoneId set # noqa: E501 :return: The inbox_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._inbox_id var method-
Gets the method of this WebhookDto. # noqa: E501
HTTP method that your server endpoint must listen for # noqa: E501
:return: The method of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def method(self): """Gets the method of this WebhookDto. # noqa: E501 HTTP method that your server endpoint must listen for # noqa: E501 :return: The method of this WebhookDto. # noqa: E501 :rtype: str """ return self._method var name-
Gets the name of this WebhookDto. # noqa: E501
Name of the webhook # noqa: E501
:return: The name of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def name(self): """Gets the name of this WebhookDto. # noqa: E501 Name of the webhook # noqa: E501 :return: The name of this WebhookDto. # noqa: E501 :rtype: str """ return self._name var payload_json_schema-
Gets the payload_json_schema of this WebhookDto. # noqa: E501
Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501
:return: The payload_json_schema of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def payload_json_schema(self): """Gets the payload_json_schema of this WebhookDto. # noqa: E501 Deprecated. Fetch JSON Schema for webhook using the getJsonSchemaForWebhookPayload method # noqa: E501 :return: The payload_json_schema of this WebhookDto. # noqa: E501 :rtype: str """ return self._payload_json_schema var phone_id-
Gets the phone_id of this WebhookDto. # noqa: E501
The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501
:return: The phone_id of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def phone_id(self): """Gets the phone_id of this WebhookDto. # noqa: E501 The phoneNumberId that the Webhook will be triggered by. If null then webhook triggered at account level or inbox level if inboxId set # noqa: E501 :return: The phone_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._phone_id var request_body_template-
Gets the request_body_template of this WebhookDto. # noqa: E501
Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501
:return: The request_body_template of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def request_body_template(self): """Gets the request_body_template of this WebhookDto. # noqa: E501 Request body template for HTTP request that will be sent for the webhook. Use Moustache style template variables to insert values from the original event payload. # noqa: E501 :return: The request_body_template of this WebhookDto. # noqa: E501 :rtype: str """ return self._request_body_template var request_headers-
Gets the request_headers of this WebhookDto. # noqa: E501
:return: The request_headers of this WebhookDto. # noqa: E501 :rtype: WebhookHeaders
Expand source code
@property def request_headers(self): """Gets the request_headers of this WebhookDto. # noqa: E501 :return: The request_headers of this WebhookDto. # noqa: E501 :rtype: WebhookHeaders """ return self._request_headers var updated_at-
Gets the updated_at of this WebhookDto. # noqa: E501
:return: The updated_at of this WebhookDto. # noqa: E501 :rtype: datetime
Expand source code
@property def updated_at(self): """Gets the updated_at of this WebhookDto. # noqa: E501 :return: The updated_at of this WebhookDto. # noqa: E501 :rtype: datetime """ return self._updated_at var url-
Gets the url of this WebhookDto. # noqa: E501
URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501
:return: The url of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def url(self): """Gets the url of this WebhookDto. # noqa: E501 URL of your server that the webhook will be sent to. The schema of the JSON that is sent is described by the payloadJsonSchema. # noqa: E501 :return: The url of this WebhookDto. # noqa: E501 :rtype: str """ return self._url var use_static_ip_range-
Gets the use_static_ip_range of this WebhookDto. # noqa: E501
Should notifier use static IP range when sending webhook payload # noqa: E501
:return: The use_static_ip_range of this WebhookDto. # noqa: E501 :rtype: bool
Expand source code
@property def use_static_ip_range(self): """Gets the use_static_ip_range of this WebhookDto. # noqa: E501 Should notifier use static IP range when sending webhook payload # noqa: E501 :return: The use_static_ip_range of this WebhookDto. # noqa: E501 :rtype: bool """ return self._use_static_ip_range var user_id-
Gets the user_id of this WebhookDto. # noqa: E501
User ID of the Webhook # noqa: E501
:return: The user_id of this WebhookDto. # noqa: E501 :rtype: str
Expand source code
@property def user_id(self): """Gets the user_id of this WebhookDto. # noqa: E501 User ID of the Webhook # noqa: E501 :return: The user_id of this WebhookDto. # noqa: E501 :rtype: str """ return self._user_id
Methods
def to_dict(self)-
Returns the model properties as a dict
Expand source code
def to_dict(self): """Returns the model properties as a dict""" result = {} for attr, _ in six.iteritems(self.openapi_types): value = getattr(self, attr) if isinstance(value, list): result[attr] = list(map( lambda x: x.to_dict() if hasattr(x, "to_dict") else x, value )) elif hasattr(value, "to_dict"): result[attr] = value.to_dict() elif isinstance(value, dict): result[attr] = dict(map( lambda item: (item[0], item[1].to_dict()) if hasattr(item[1], "to_dict") else item, value.items() )) else: result[attr] = value return result def to_str(self)-
Returns the string representation of the model
Expand source code
def to_str(self): """Returns the string representation of the model""" return pprint.pformat(self.to_dict())