docusign_esign.models.return_url_request

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.  # noqa: E501
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class ReturnUrlRequest(object):
 23    """NOTE: This class is auto generated by the swagger code generator program.
 24
 25    Do not edit the class manually.
 26    """
 27
 28    """
 29    Attributes:
 30      swagger_types (dict): The key is attribute name
 31                            and the value is attribute type.
 32      attribute_map (dict): The key is attribute name
 33                            and the value is json key in definition.
 34    """
 35    swagger_types = {
 36        'return_url': 'str'
 37    }
 38
 39    attribute_map = {
 40        'return_url': 'returnUrl'
 41    }
 42
 43    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 44        """ReturnUrlRequest - a model defined in Swagger"""  # noqa: E501
 45        if _configuration is None:
 46            _configuration = Configuration()
 47        self._configuration = _configuration
 48
 49        self._return_url = None
 50        self.discriminator = None
 51
 52        setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None))
 53
 54    @property
 55    def return_url(self):
 56        """Gets the return_url of this ReturnUrlRequest.  # noqa: E501
 57
 58        Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:   * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).  # noqa: E501
 59
 60        :return: The return_url of this ReturnUrlRequest.  # noqa: E501
 61        :rtype: str
 62        """
 63        return self._return_url
 64
 65    @return_url.setter
 66    def return_url(self, return_url):
 67        """Sets the return_url of this ReturnUrlRequest.
 68
 69        Identifies the return point after sending the envelope. DocuSign returns to the URL and includes an event parameter that can be used to redirect the recipient to another location. The possible event parameters returned are:   * send (user sends the envelope) * save (user saves the envelope) * cancel (user cancels the sending transaction. No envelopeId is returned in this case.) * error (there is an error when performing the send) * sessionEnd (the sending session ends before the user completes another action).  # noqa: E501
 70
 71        :param return_url: The return_url of this ReturnUrlRequest.  # noqa: E501
 72        :type: str
 73        """
 74
 75        self._return_url = return_url
 76
 77    def to_dict(self):
 78        """Returns the model properties as a dict"""
 79        result = {}
 80
 81        for attr, _ in six.iteritems(self.swagger_types):
 82            value = getattr(self, attr)
 83            if isinstance(value, list):
 84                result[attr] = list(map(
 85                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
 86                    value
 87                ))
 88            elif hasattr(value, "to_dict"):
 89                result[attr] = value.to_dict()
 90            elif isinstance(value, dict):
 91                result[attr] = dict(map(
 92                    lambda item: (item[0], item[1].to_dict())
 93                    if hasattr(item[1], "to_dict") else item,
 94                    value.items()
 95                ))
 96            else:
 97                result[attr] = value
 98        if issubclass(ReturnUrlRequest, dict):
 99            for key, value in self.items():
100                result[key] = value
101
102        return result
103
104    def to_str(self):
105        """Returns the string representation of the model"""
106        return pprint.pformat(self.to_dict())
107
108    def __repr__(self):
109        """For `print` and `pprint`"""
110        return self.to_str()
111
112    def __eq__(self, other):
113        """Returns true if both objects are equal"""
114        if not isinstance(other, ReturnUrlRequest):
115            return False
116
117        return self.to_dict() == other.to_dict()
118
119    def __ne__(self, other):
120        """Returns true if both objects are not equal"""
121        if not isinstance(other, ReturnUrlRequest):
122            return True
123
124        return self.to_dict() != other.to_dict()