docusign_esign.models.complete_sign_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
 19
 20class CompleteSignRequest(object):
 21    """NOTE: This class is auto generated by the swagger code generator program.
 22
 23    Do not edit the class manually.
 24    """
 25
 26    """
 27    Attributes:
 28      swagger_types (dict): The key is attribute name
 29                            and the value is attribute type.
 30      attribute_map (dict): The key is attribute name
 31                            and the value is json key in definition.
 32    """
 33    swagger_types = {
 34        'certificate': 'str',
 35        'correlation_id': 'str',
 36        'document_update_infos': 'list[DocumentUpdateInfo]',
 37        'max_signature_length': 'str',
 38        'signing_location': 'str',
 39        'transaction_id': 'str'
 40    }
 41
 42    attribute_map = {
 43        'certificate': 'certificate',
 44        'correlation_id': 'correlationId',
 45        'document_update_infos': 'documentUpdateInfos',
 46        'max_signature_length': 'maxSignatureLength',
 47        'signing_location': 'signingLocation',
 48        'transaction_id': 'transactionId'
 49    }
 50
 51    def __init__(self, certificate=None, correlation_id=None, document_update_infos=None, max_signature_length=None, signing_location=None, transaction_id=None):  # noqa: E501
 52        """CompleteSignRequest - a model defined in Swagger"""  # noqa: E501
 53
 54        self._certificate = None
 55        self._correlation_id = None
 56        self._document_update_infos = None
 57        self._max_signature_length = None
 58        self._signing_location = None
 59        self._transaction_id = None
 60        self.discriminator = None
 61
 62        if certificate is not None:
 63            self.certificate = certificate
 64        if correlation_id is not None:
 65            self.correlation_id = correlation_id
 66        if document_update_infos is not None:
 67            self.document_update_infos = document_update_infos
 68        if max_signature_length is not None:
 69            self.max_signature_length = max_signature_length
 70        if signing_location is not None:
 71            self.signing_location = signing_location
 72        if transaction_id is not None:
 73            self.transaction_id = transaction_id
 74
 75    @property
 76    def certificate(self):
 77        """Gets the certificate of this CompleteSignRequest.  # noqa: E501
 78
 79          # noqa: E501
 80
 81        :return: The certificate of this CompleteSignRequest.  # noqa: E501
 82        :rtype: str
 83        """
 84        return self._certificate
 85
 86    @certificate.setter
 87    def certificate(self, certificate):
 88        """Sets the certificate of this CompleteSignRequest.
 89
 90          # noqa: E501
 91
 92        :param certificate: The certificate of this CompleteSignRequest.  # noqa: E501
 93        :type: str
 94        """
 95
 96        self._certificate = certificate
 97
 98    @property
 99    def correlation_id(self):
100        """Gets the correlation_id of this CompleteSignRequest.  # noqa: E501
101
102          # noqa: E501
103
104        :return: The correlation_id of this CompleteSignRequest.  # noqa: E501
105        :rtype: str
106        """
107        return self._correlation_id
108
109    @correlation_id.setter
110    def correlation_id(self, correlation_id):
111        """Sets the correlation_id of this CompleteSignRequest.
112
113          # noqa: E501
114
115        :param correlation_id: The correlation_id of this CompleteSignRequest.  # noqa: E501
116        :type: str
117        """
118
119        self._correlation_id = correlation_id
120
121    @property
122    def document_update_infos(self):
123        """Gets the document_update_infos of this CompleteSignRequest.  # noqa: E501
124
125          # noqa: E501
126
127        :return: The document_update_infos of this CompleteSignRequest.  # noqa: E501
128        :rtype: list[DocumentUpdateInfo]
129        """
130        return self._document_update_infos
131
132    @document_update_infos.setter
133    def document_update_infos(self, document_update_infos):
134        """Sets the document_update_infos of this CompleteSignRequest.
135
136          # noqa: E501
137
138        :param document_update_infos: The document_update_infos of this CompleteSignRequest.  # noqa: E501
139        :type: list[DocumentUpdateInfo]
140        """
141
142        self._document_update_infos = document_update_infos
143
144    @property
145    def max_signature_length(self):
146        """Gets the max_signature_length of this CompleteSignRequest.  # noqa: E501
147
148          # noqa: E501
149
150        :return: The max_signature_length of this CompleteSignRequest.  # noqa: E501
151        :rtype: str
152        """
153        return self._max_signature_length
154
155    @max_signature_length.setter
156    def max_signature_length(self, max_signature_length):
157        """Sets the max_signature_length of this CompleteSignRequest.
158
159          # noqa: E501
160
161        :param max_signature_length: The max_signature_length of this CompleteSignRequest.  # noqa: E501
162        :type: str
163        """
164
165        self._max_signature_length = max_signature_length
166
167    @property
168    def signing_location(self):
169        """Gets the signing_location of this CompleteSignRequest.  # noqa: E501
170
171        Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.  # noqa: E501
172
173        :return: The signing_location of this CompleteSignRequest.  # noqa: E501
174        :rtype: str
175        """
176        return self._signing_location
177
178    @signing_location.setter
179    def signing_location(self, signing_location):
180        """Sets the signing_location of this CompleteSignRequest.
181
182        Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.  # noqa: E501
183
184        :param signing_location: The signing_location of this CompleteSignRequest.  # noqa: E501
185        :type: str
186        """
187
188        self._signing_location = signing_location
189
190    @property
191    def transaction_id(self):
192        """Gets the transaction_id of this CompleteSignRequest.  # noqa: E501
193
194         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
195
196        :return: The transaction_id of this CompleteSignRequest.  # noqa: E501
197        :rtype: str
198        """
199        return self._transaction_id
200
201    @transaction_id.setter
202    def transaction_id(self, transaction_id):
203        """Sets the transaction_id of this CompleteSignRequest.
204
205         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
206
207        :param transaction_id: The transaction_id of this CompleteSignRequest.  # noqa: E501
208        :type: str
209        """
210
211        self._transaction_id = transaction_id
212
213    def to_dict(self):
214        """Returns the model properties as a dict"""
215        result = {}
216
217        for attr, _ in six.iteritems(self.swagger_types):
218            value = getattr(self, attr)
219            if isinstance(value, list):
220                result[attr] = list(map(
221                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
222                    value
223                ))
224            elif hasattr(value, "to_dict"):
225                result[attr] = value.to_dict()
226            elif isinstance(value, dict):
227                result[attr] = dict(map(
228                    lambda item: (item[0], item[1].to_dict())
229                    if hasattr(item[1], "to_dict") else item,
230                    value.items()
231                ))
232            else:
233                result[attr] = value
234        if issubclass(CompleteSignRequest, dict):
235            for key, value in self.items():
236                result[key] = value
237
238        return result
239
240    def to_str(self):
241        """Returns the string representation of the model"""
242        return pprint.pformat(self.to_dict())
243
244    def __repr__(self):
245        """For `print` and `pprint`"""
246        return self.to_str()
247
248    def __eq__(self, other):
249        """Returns true if both objects are equal"""
250        if not isinstance(other, CompleteSignRequest):
251            return False
252
253        return self.__dict__ == other.__dict__
254
255    def __ne__(self, other):
256        """Returns true if both objects are not equal"""
257        return not self == other