docusign_esign.models.correct_view_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 CorrectViewRequest(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        'begin_on_tagger': 'str',
 37        'return_url': 'str',
 38        'suppress_navigation': 'str',
 39        'view_url': 'str'
 40    }
 41
 42    attribute_map = {
 43        'begin_on_tagger': 'beginOnTagger',
 44        'return_url': 'returnUrl',
 45        'suppress_navigation': 'suppressNavigation',
 46        'view_url': 'viewUrl'
 47    }
 48
 49    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 50        """CorrectViewRequest - a model defined in Swagger"""  # noqa: E501
 51        if _configuration is None:
 52            _configuration = Configuration()
 53        self._configuration = _configuration
 54
 55        self._begin_on_tagger = None
 56        self._return_url = None
 57        self._suppress_navigation = None
 58        self._view_url = None
 59        self.discriminator = None
 60
 61        setattr(self, "_{}".format('begin_on_tagger'), kwargs.get('begin_on_tagger', None))
 62        setattr(self, "_{}".format('return_url'), kwargs.get('return_url', None))
 63        setattr(self, "_{}".format('suppress_navigation'), kwargs.get('suppress_navigation', None))
 64        setattr(self, "_{}".format('view_url'), kwargs.get('view_url', None))
 65
 66    @property
 67    def begin_on_tagger(self):
 68        """Gets the begin_on_tagger of this CorrectViewRequest.  # noqa: E501
 69
 70          # noqa: E501
 71
 72        :return: The begin_on_tagger of this CorrectViewRequest.  # noqa: E501
 73        :rtype: str
 74        """
 75        return self._begin_on_tagger
 76
 77    @begin_on_tagger.setter
 78    def begin_on_tagger(self, begin_on_tagger):
 79        """Sets the begin_on_tagger of this CorrectViewRequest.
 80
 81          # noqa: E501
 82
 83        :param begin_on_tagger: The begin_on_tagger of this CorrectViewRequest.  # noqa: E501
 84        :type: str
 85        """
 86
 87        self._begin_on_tagger = begin_on_tagger
 88
 89    @property
 90    def return_url(self):
 91        """Gets the return_url of this CorrectViewRequest.  # noqa: E501
 92
 93        The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are:   * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action)  ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.   # noqa: E501
 94
 95        :return: The return_url of this CorrectViewRequest.  # noqa: E501
 96        :rtype: str
 97        """
 98        return self._return_url
 99
100    @return_url.setter
101    def return_url(self, return_url):
102        """Sets the return_url of this CorrectViewRequest.
103
104        The url used after correct/send view session has ended. DocuSign redirects to the url and includes an event parameter that can be used by your app. The event parameters returned are:   * send (user corrected and sent the envelope) * save (user saved the envelope) * cancel (user canceled the transaction.) * error (there was an error when performing the correct or send) * sessionEnd (the session ended before the user completed a different action)  ###### Note: Include https:// in the URL or the redirect might not succeed on some browsers.   # noqa: E501
105
106        :param return_url: The return_url of this CorrectViewRequest.  # noqa: E501
107        :type: str
108        """
109
110        self._return_url = return_url
111
112    @property
113    def suppress_navigation(self):
114        """Gets the suppress_navigation of this CorrectViewRequest.  # noqa: E501
115
116        Specifies whether the window is displayed with or without dressing.  # noqa: E501
117
118        :return: The suppress_navigation of this CorrectViewRequest.  # noqa: E501
119        :rtype: str
120        """
121        return self._suppress_navigation
122
123    @suppress_navigation.setter
124    def suppress_navigation(self, suppress_navigation):
125        """Sets the suppress_navigation of this CorrectViewRequest.
126
127        Specifies whether the window is displayed with or without dressing.  # noqa: E501
128
129        :param suppress_navigation: The suppress_navigation of this CorrectViewRequest.  # noqa: E501
130        :type: str
131        """
132
133        self._suppress_navigation = suppress_navigation
134
135    @property
136    def view_url(self):
137        """Gets the view_url of this CorrectViewRequest.  # noqa: E501
138
139          # noqa: E501
140
141        :return: The view_url of this CorrectViewRequest.  # noqa: E501
142        :rtype: str
143        """
144        return self._view_url
145
146    @view_url.setter
147    def view_url(self, view_url):
148        """Sets the view_url of this CorrectViewRequest.
149
150          # noqa: E501
151
152        :param view_url: The view_url of this CorrectViewRequest.  # noqa: E501
153        :type: str
154        """
155
156        self._view_url = view_url
157
158    def to_dict(self):
159        """Returns the model properties as a dict"""
160        result = {}
161
162        for attr, _ in six.iteritems(self.swagger_types):
163            value = getattr(self, attr)
164            if isinstance(value, list):
165                result[attr] = list(map(
166                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
167                    value
168                ))
169            elif hasattr(value, "to_dict"):
170                result[attr] = value.to_dict()
171            elif isinstance(value, dict):
172                result[attr] = dict(map(
173                    lambda item: (item[0], item[1].to_dict())
174                    if hasattr(item[1], "to_dict") else item,
175                    value.items()
176                ))
177            else:
178                result[attr] = value
179        if issubclass(CorrectViewRequest, dict):
180            for key, value in self.items():
181                result[key] = value
182
183        return result
184
185    def to_str(self):
186        """Returns the string representation of the model"""
187        return pprint.pformat(self.to_dict())
188
189    def __repr__(self):
190        """For `print` and `pprint`"""
191        return self.to_str()
192
193    def __eq__(self, other):
194        """Returns true if both objects are equal"""
195        if not isinstance(other, CorrectViewRequest):
196            return False
197
198        return self.to_dict() == other.to_dict()
199
200    def __ne__(self, other):
201        """Returns true if both objects are not equal"""
202        if not isinstance(other, CorrectViewRequest):
203            return True
204
205        return self.to_dict() != other.to_dict()