docusign_esign.models.document_update_info

  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 DocumentUpdateInfo(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        'data': 'str',
 35        'document_id': 'str',
 36        'document_security_store': 'DocumentSecurityStore',
 37        'name': 'str',
 38        'return_format': 'str',
 39        'signature_data_infos': 'list[SignatureDataInfo]',
 40        'time_stamp_field': 'TimeStampField'
 41    }
 42
 43    attribute_map = {
 44        'data': 'data',
 45        'document_id': 'documentId',
 46        'document_security_store': 'documentSecurityStore',
 47        'name': 'name',
 48        'return_format': 'returnFormat',
 49        'signature_data_infos': 'signatureDataInfos',
 50        'time_stamp_field': 'timeStampField'
 51    }
 52
 53    def __init__(self, data=None, document_id=None, document_security_store=None, name=None, return_format=None, signature_data_infos=None, time_stamp_field=None):  # noqa: E501
 54        """DocumentUpdateInfo - a model defined in Swagger"""  # noqa: E501
 55
 56        self._data = None
 57        self._document_id = None
 58        self._document_security_store = None
 59        self._name = None
 60        self._return_format = None
 61        self._signature_data_infos = None
 62        self._time_stamp_field = None
 63        self.discriminator = None
 64
 65        if data is not None:
 66            self.data = data
 67        if document_id is not None:
 68            self.document_id = document_id
 69        if document_security_store is not None:
 70            self.document_security_store = document_security_store
 71        if name is not None:
 72            self.name = name
 73        if return_format is not None:
 74            self.return_format = return_format
 75        if signature_data_infos is not None:
 76            self.signature_data_infos = signature_data_infos
 77        if time_stamp_field is not None:
 78            self.time_stamp_field = time_stamp_field
 79
 80    @property
 81    def data(self):
 82        """Gets the data of this DocumentUpdateInfo.  # noqa: E501
 83
 84          # noqa: E501
 85
 86        :return: The data of this DocumentUpdateInfo.  # noqa: E501
 87        :rtype: str
 88        """
 89        return self._data
 90
 91    @data.setter
 92    def data(self, data):
 93        """Sets the data of this DocumentUpdateInfo.
 94
 95          # noqa: E501
 96
 97        :param data: The data of this DocumentUpdateInfo.  # noqa: E501
 98        :type: str
 99        """
100
101        self._data = data
102
103    @property
104    def document_id(self):
105        """Gets the document_id of this DocumentUpdateInfo.  # noqa: E501
106
107        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
108
109        :return: The document_id of this DocumentUpdateInfo.  # noqa: E501
110        :rtype: str
111        """
112        return self._document_id
113
114    @document_id.setter
115    def document_id(self, document_id):
116        """Sets the document_id of this DocumentUpdateInfo.
117
118        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
119
120        :param document_id: The document_id of this DocumentUpdateInfo.  # noqa: E501
121        :type: str
122        """
123
124        self._document_id = document_id
125
126    @property
127    def document_security_store(self):
128        """Gets the document_security_store of this DocumentUpdateInfo.  # noqa: E501
129
130
131        :return: The document_security_store of this DocumentUpdateInfo.  # noqa: E501
132        :rtype: DocumentSecurityStore
133        """
134        return self._document_security_store
135
136    @document_security_store.setter
137    def document_security_store(self, document_security_store):
138        """Sets the document_security_store of this DocumentUpdateInfo.
139
140
141        :param document_security_store: The document_security_store of this DocumentUpdateInfo.  # noqa: E501
142        :type: DocumentSecurityStore
143        """
144
145        self._document_security_store = document_security_store
146
147    @property
148    def name(self):
149        """Gets the name of this DocumentUpdateInfo.  # noqa: E501
150
151          # noqa: E501
152
153        :return: The name of this DocumentUpdateInfo.  # noqa: E501
154        :rtype: str
155        """
156        return self._name
157
158    @name.setter
159    def name(self, name):
160        """Sets the name of this DocumentUpdateInfo.
161
162          # noqa: E501
163
164        :param name: The name of this DocumentUpdateInfo.  # noqa: E501
165        :type: str
166        """
167
168        self._name = name
169
170    @property
171    def return_format(self):
172        """Gets the return_format of this DocumentUpdateInfo.  # noqa: E501
173
174          # noqa: E501
175
176        :return: The return_format of this DocumentUpdateInfo.  # noqa: E501
177        :rtype: str
178        """
179        return self._return_format
180
181    @return_format.setter
182    def return_format(self, return_format):
183        """Sets the return_format of this DocumentUpdateInfo.
184
185          # noqa: E501
186
187        :param return_format: The return_format of this DocumentUpdateInfo.  # noqa: E501
188        :type: str
189        """
190
191        self._return_format = return_format
192
193    @property
194    def signature_data_infos(self):
195        """Gets the signature_data_infos of this DocumentUpdateInfo.  # noqa: E501
196
197          # noqa: E501
198
199        :return: The signature_data_infos of this DocumentUpdateInfo.  # noqa: E501
200        :rtype: list[SignatureDataInfo]
201        """
202        return self._signature_data_infos
203
204    @signature_data_infos.setter
205    def signature_data_infos(self, signature_data_infos):
206        """Sets the signature_data_infos of this DocumentUpdateInfo.
207
208          # noqa: E501
209
210        :param signature_data_infos: The signature_data_infos of this DocumentUpdateInfo.  # noqa: E501
211        :type: list[SignatureDataInfo]
212        """
213
214        self._signature_data_infos = signature_data_infos
215
216    @property
217    def time_stamp_field(self):
218        """Gets the time_stamp_field of this DocumentUpdateInfo.  # noqa: E501
219
220
221        :return: The time_stamp_field of this DocumentUpdateInfo.  # noqa: E501
222        :rtype: TimeStampField
223        """
224        return self._time_stamp_field
225
226    @time_stamp_field.setter
227    def time_stamp_field(self, time_stamp_field):
228        """Sets the time_stamp_field of this DocumentUpdateInfo.
229
230
231        :param time_stamp_field: The time_stamp_field of this DocumentUpdateInfo.  # noqa: E501
232        :type: TimeStampField
233        """
234
235        self._time_stamp_field = time_stamp_field
236
237    def to_dict(self):
238        """Returns the model properties as a dict"""
239        result = {}
240
241        for attr, _ in six.iteritems(self.swagger_types):
242            value = getattr(self, attr)
243            if isinstance(value, list):
244                result[attr] = list(map(
245                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
246                    value
247                ))
248            elif hasattr(value, "to_dict"):
249                result[attr] = value.to_dict()
250            elif isinstance(value, dict):
251                result[attr] = dict(map(
252                    lambda item: (item[0], item[1].to_dict())
253                    if hasattr(item[1], "to_dict") else item,
254                    value.items()
255                ))
256            else:
257                result[attr] = value
258        if issubclass(DocumentUpdateInfo, dict):
259            for key, value in self.items():
260                result[key] = value
261
262        return result
263
264    def to_str(self):
265        """Returns the string representation of the model"""
266        return pprint.pformat(self.to_dict())
267
268    def __repr__(self):
269        """For `print` and `pprint`"""
270        return self.to_str()
271
272    def __eq__(self, other):
273        """Returns true if both objects are equal"""
274        if not isinstance(other, DocumentUpdateInfo):
275            return False
276
277        return self.__dict__ == other.__dict__
278
279    def __ne__(self, other):
280        """Returns true if both objects are not equal"""
281        return not self == other