docusign_esign.models.template_summary

  1# coding: utf-8
  2
  3"""
  4    Docusign eSignature REST API
  5
  6    The Docusign eSignature 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 TemplateSummary(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        'applied': 'str',
 37        'document_id': 'str',
 38        'document_name': 'str',
 39        'error_details': 'ErrorDetails',
 40        'name': 'str',
 41        'template_id': 'str',
 42        'template_match': 'TemplateMatch',
 43        'uri': 'str'
 44    }
 45
 46    attribute_map = {
 47        'applied': 'applied',
 48        'document_id': 'documentId',
 49        'document_name': 'documentName',
 50        'error_details': 'errorDetails',
 51        'name': 'name',
 52        'template_id': 'templateId',
 53        'template_match': 'templateMatch',
 54        'uri': 'uri'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """TemplateSummary - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._applied = None
 64        self._document_id = None
 65        self._document_name = None
 66        self._error_details = None
 67        self._name = None
 68        self._template_id = None
 69        self._template_match = None
 70        self._uri = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('applied'), kwargs.get('applied', None))
 74        setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
 75        setattr(self, "_{}".format('document_name'), kwargs.get('document_name', None))
 76        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 77        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 78        setattr(self, "_{}".format('template_id'), kwargs.get('template_id', None))
 79        setattr(self, "_{}".format('template_match'), kwargs.get('template_match', None))
 80        setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
 81
 82    @property
 83    def applied(self):
 84        """Gets the applied of this TemplateSummary.  # noqa: E501
 85
 86        Reserved: TBD  # noqa: E501
 87
 88        :return: The applied of this TemplateSummary.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._applied
 92
 93    @applied.setter
 94    def applied(self, applied):
 95        """Sets the applied of this TemplateSummary.
 96
 97        Reserved: TBD  # noqa: E501
 98
 99        :param applied: The applied of this TemplateSummary.  # noqa: E501
100        :type: str
101        """
102
103        self._applied = applied
104
105    @property
106    def document_id(self):
107        """Gets the document_id of this TemplateSummary.  # noqa: E501
108
109        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
110
111        :return: The document_id of this TemplateSummary.  # noqa: E501
112        :rtype: str
113        """
114        return self._document_id
115
116    @document_id.setter
117    def document_id(self, document_id):
118        """Sets the document_id of this TemplateSummary.
119
120        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
121
122        :param document_id: The document_id of this TemplateSummary.  # noqa: E501
123        :type: str
124        """
125
126        self._document_id = document_id
127
128    @property
129    def document_name(self):
130        """Gets the document_name of this TemplateSummary.  # noqa: E501
131
132          # noqa: E501
133
134        :return: The document_name of this TemplateSummary.  # noqa: E501
135        :rtype: str
136        """
137        return self._document_name
138
139    @document_name.setter
140    def document_name(self, document_name):
141        """Sets the document_name of this TemplateSummary.
142
143          # noqa: E501
144
145        :param document_name: The document_name of this TemplateSummary.  # noqa: E501
146        :type: str
147        """
148
149        self._document_name = document_name
150
151    @property
152    def error_details(self):
153        """Gets the error_details of this TemplateSummary.  # noqa: E501
154
155        Array or errors.  # noqa: E501
156
157        :return: The error_details of this TemplateSummary.  # noqa: E501
158        :rtype: ErrorDetails
159        """
160        return self._error_details
161
162    @error_details.setter
163    def error_details(self, error_details):
164        """Sets the error_details of this TemplateSummary.
165
166        Array or errors.  # noqa: E501
167
168        :param error_details: The error_details of this TemplateSummary.  # noqa: E501
169        :type: ErrorDetails
170        """
171
172        self._error_details = error_details
173
174    @property
175    def name(self):
176        """Gets the name of this TemplateSummary.  # noqa: E501
177
178          # noqa: E501
179
180        :return: The name of this TemplateSummary.  # noqa: E501
181        :rtype: str
182        """
183        return self._name
184
185    @name.setter
186    def name(self, name):
187        """Sets the name of this TemplateSummary.
188
189          # noqa: E501
190
191        :param name: The name of this TemplateSummary.  # noqa: E501
192        :type: str
193        """
194
195        self._name = name
196
197    @property
198    def template_id(self):
199        """Gets the template_id of this TemplateSummary.  # noqa: E501
200
201        The unique identifier of the template. If this is not provided, DocuSign will generate a value.   # noqa: E501
202
203        :return: The template_id of this TemplateSummary.  # noqa: E501
204        :rtype: str
205        """
206        return self._template_id
207
208    @template_id.setter
209    def template_id(self, template_id):
210        """Sets the template_id of this TemplateSummary.
211
212        The unique identifier of the template. If this is not provided, DocuSign will generate a value.   # noqa: E501
213
214        :param template_id: The template_id of this TemplateSummary.  # noqa: E501
215        :type: str
216        """
217
218        self._template_id = template_id
219
220    @property
221    def template_match(self):
222        """Gets the template_match of this TemplateSummary.  # noqa: E501
223
224          # noqa: E501
225
226        :return: The template_match of this TemplateSummary.  # noqa: E501
227        :rtype: TemplateMatch
228        """
229        return self._template_match
230
231    @template_match.setter
232    def template_match(self, template_match):
233        """Sets the template_match of this TemplateSummary.
234
235          # noqa: E501
236
237        :param template_match: The template_match of this TemplateSummary.  # noqa: E501
238        :type: TemplateMatch
239        """
240
241        self._template_match = template_match
242
243    @property
244    def uri(self):
245        """Gets the uri of this TemplateSummary.  # noqa: E501
246
247          # noqa: E501
248
249        :return: The uri of this TemplateSummary.  # noqa: E501
250        :rtype: str
251        """
252        return self._uri
253
254    @uri.setter
255    def uri(self, uri):
256        """Sets the uri of this TemplateSummary.
257
258          # noqa: E501
259
260        :param uri: The uri of this TemplateSummary.  # noqa: E501
261        :type: str
262        """
263
264        self._uri = uri
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(TemplateSummary, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, TemplateSummary):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, TemplateSummary):
311            return True
312
313        return self.to_dict() != other.to_dict()