docusign_esign.models.document_template

  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 DocumentTemplate(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        'document_end_page': 'str',
 37        'document_id': 'str',
 38        'document_start_page': 'str',
 39        'error_details': 'ErrorDetails',
 40        'template_id': 'str'
 41    }
 42
 43    attribute_map = {
 44        'document_end_page': 'documentEndPage',
 45        'document_id': 'documentId',
 46        'document_start_page': 'documentStartPage',
 47        'error_details': 'errorDetails',
 48        'template_id': 'templateId'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """DocumentTemplate - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._document_end_page = None
 58        self._document_id = None
 59        self._document_start_page = None
 60        self._error_details = None
 61        self._template_id = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('document_end_page'), kwargs.get('document_end_page', None))
 65        setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None))
 66        setattr(self, "_{}".format('document_start_page'), kwargs.get('document_start_page', None))
 67        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 68        setattr(self, "_{}".format('template_id'), kwargs.get('template_id', None))
 69
 70    @property
 71    def document_end_page(self):
 72        """Gets the document_end_page of this DocumentTemplate.  # noqa: E501
 73
 74          # noqa: E501
 75
 76        :return: The document_end_page of this DocumentTemplate.  # noqa: E501
 77        :rtype: str
 78        """
 79        return self._document_end_page
 80
 81    @document_end_page.setter
 82    def document_end_page(self, document_end_page):
 83        """Sets the document_end_page of this DocumentTemplate.
 84
 85          # noqa: E501
 86
 87        :param document_end_page: The document_end_page of this DocumentTemplate.  # noqa: E501
 88        :type: str
 89        """
 90
 91        self._document_end_page = document_end_page
 92
 93    @property
 94    def document_id(self):
 95        """Gets the document_id of this DocumentTemplate.  # noqa: E501
 96
 97        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
 98
 99        :return: The document_id of this DocumentTemplate.  # noqa: E501
100        :rtype: str
101        """
102        return self._document_id
103
104    @document_id.setter
105    def document_id(self, document_id):
106        """Sets the document_id of this DocumentTemplate.
107
108        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.  # noqa: E501
109
110        :param document_id: The document_id of this DocumentTemplate.  # noqa: E501
111        :type: str
112        """
113
114        self._document_id = document_id
115
116    @property
117    def document_start_page(self):
118        """Gets the document_start_page of this DocumentTemplate.  # noqa: E501
119
120          # noqa: E501
121
122        :return: The document_start_page of this DocumentTemplate.  # noqa: E501
123        :rtype: str
124        """
125        return self._document_start_page
126
127    @document_start_page.setter
128    def document_start_page(self, document_start_page):
129        """Sets the document_start_page of this DocumentTemplate.
130
131          # noqa: E501
132
133        :param document_start_page: The document_start_page of this DocumentTemplate.  # noqa: E501
134        :type: str
135        """
136
137        self._document_start_page = document_start_page
138
139    @property
140    def error_details(self):
141        """Gets the error_details of this DocumentTemplate.  # noqa: E501
142
143        Array or errors.  # noqa: E501
144
145        :return: The error_details of this DocumentTemplate.  # noqa: E501
146        :rtype: ErrorDetails
147        """
148        return self._error_details
149
150    @error_details.setter
151    def error_details(self, error_details):
152        """Sets the error_details of this DocumentTemplate.
153
154        Array or errors.  # noqa: E501
155
156        :param error_details: The error_details of this DocumentTemplate.  # noqa: E501
157        :type: ErrorDetails
158        """
159
160        self._error_details = error_details
161
162    @property
163    def template_id(self):
164        """Gets the template_id of this DocumentTemplate.  # noqa: E501
165
166        The unique identifier of the template. If this is not provided, DocuSign will generate a value.   # noqa: E501
167
168        :return: The template_id of this DocumentTemplate.  # noqa: E501
169        :rtype: str
170        """
171        return self._template_id
172
173    @template_id.setter
174    def template_id(self, template_id):
175        """Sets the template_id of this DocumentTemplate.
176
177        The unique identifier of the template. If this is not provided, DocuSign will generate a value.   # noqa: E501
178
179        :param template_id: The template_id of this DocumentTemplate.  # noqa: E501
180        :type: str
181        """
182
183        self._template_id = template_id
184
185    def to_dict(self):
186        """Returns the model properties as a dict"""
187        result = {}
188
189        for attr, _ in six.iteritems(self.swagger_types):
190            value = getattr(self, attr)
191            if isinstance(value, list):
192                result[attr] = list(map(
193                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
194                    value
195                ))
196            elif hasattr(value, "to_dict"):
197                result[attr] = value.to_dict()
198            elif isinstance(value, dict):
199                result[attr] = dict(map(
200                    lambda item: (item[0], item[1].to_dict())
201                    if hasattr(item[1], "to_dict") else item,
202                    value.items()
203                ))
204            else:
205                result[attr] = value
206        if issubclass(DocumentTemplate, dict):
207            for key, value in self.items():
208                result[key] = value
209
210        return result
211
212    def to_str(self):
213        """Returns the string representation of the model"""
214        return pprint.pformat(self.to_dict())
215
216    def __repr__(self):
217        """For `print` and `pprint`"""
218        return self.to_str()
219
220    def __eq__(self, other):
221        """Returns true if both objects are equal"""
222        if not isinstance(other, DocumentTemplate):
223            return False
224
225        return self.to_dict() == other.to_dict()
226
227    def __ne__(self, other):
228        """Returns true if both objects are not equal"""
229        if not isinstance(other, DocumentTemplate):
230            return True
231
232        return self.to_dict() != other.to_dict()