docusign_esign.models.composite_template

  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 CompositeTemplate(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        'composite_template_id': 'str',
 37        'document': 'Document',
 38        'inline_templates': 'list[InlineTemplate]',
 39        'pdf_meta_data_template_sequence': 'str',
 40        'server_templates': 'list[ServerTemplate]'
 41    }
 42
 43    attribute_map = {
 44        'composite_template_id': 'compositeTemplateId',
 45        'document': 'document',
 46        'inline_templates': 'inlineTemplates',
 47        'pdf_meta_data_template_sequence': 'pdfMetaDataTemplateSequence',
 48        'server_templates': 'serverTemplates'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """CompositeTemplate - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._composite_template_id = None
 58        self._document = None
 59        self._inline_templates = None
 60        self._pdf_meta_data_template_sequence = None
 61        self._server_templates = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('composite_template_id'), kwargs.get('composite_template_id', None))
 65        setattr(self, "_{}".format('document'), kwargs.get('document', None))
 66        setattr(self, "_{}".format('inline_templates'), kwargs.get('inline_templates', None))
 67        setattr(self, "_{}".format('pdf_meta_data_template_sequence'), kwargs.get('pdf_meta_data_template_sequence', None))
 68        setattr(self, "_{}".format('server_templates'), kwargs.get('server_templates', None))
 69
 70    @property
 71    def composite_template_id(self):
 72        """Gets the composite_template_id of this CompositeTemplate.  # noqa: E501
 73
 74        The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.  # noqa: E501
 75
 76        :return: The composite_template_id of this CompositeTemplate.  # noqa: E501
 77        :rtype: str
 78        """
 79        return self._composite_template_id
 80
 81    @composite_template_id.setter
 82    def composite_template_id(self, composite_template_id):
 83        """Sets the composite_template_id of this CompositeTemplate.
 84
 85        The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.  # noqa: E501
 86
 87        :param composite_template_id: The composite_template_id of this CompositeTemplate.  # noqa: E501
 88        :type: str
 89        """
 90
 91        self._composite_template_id = composite_template_id
 92
 93    @property
 94    def document(self):
 95        """Gets the document of this CompositeTemplate.  # noqa: E501
 96
 97        An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.  # noqa: E501
 98
 99        :return: The document of this CompositeTemplate.  # noqa: E501
100        :rtype: Document
101        """
102        return self._document
103
104    @document.setter
105    def document(self, document):
106        """Sets the document of this CompositeTemplate.
107
108        An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.  # noqa: E501
109
110        :param document: The document of this CompositeTemplate.  # noqa: E501
111        :type: Document
112        """
113
114        self._document = document
115
116    @property
117    def inline_templates(self):
118        """Gets the inline_templates of this CompositeTemplate.  # noqa: E501
119
120         Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.  # noqa: E501
121
122        :return: The inline_templates of this CompositeTemplate.  # noqa: E501
123        :rtype: list[InlineTemplate]
124        """
125        return self._inline_templates
126
127    @inline_templates.setter
128    def inline_templates(self, inline_templates):
129        """Sets the inline_templates of this CompositeTemplate.
130
131         Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.  # noqa: E501
132
133        :param inline_templates: The inline_templates of this CompositeTemplate.  # noqa: E501
134        :type: list[InlineTemplate]
135        """
136
137        self._inline_templates = inline_templates
138
139    @property
140    def pdf_meta_data_template_sequence(self):
141        """Gets the pdf_meta_data_template_sequence of this CompositeTemplate.  # noqa: E501
142
143          # noqa: E501
144
145        :return: The pdf_meta_data_template_sequence of this CompositeTemplate.  # noqa: E501
146        :rtype: str
147        """
148        return self._pdf_meta_data_template_sequence
149
150    @pdf_meta_data_template_sequence.setter
151    def pdf_meta_data_template_sequence(self, pdf_meta_data_template_sequence):
152        """Sets the pdf_meta_data_template_sequence of this CompositeTemplate.
153
154          # noqa: E501
155
156        :param pdf_meta_data_template_sequence: The pdf_meta_data_template_sequence of this CompositeTemplate.  # noqa: E501
157        :type: str
158        """
159
160        self._pdf_meta_data_template_sequence = pdf_meta_data_template_sequence
161
162    @property
163    def server_templates(self):
164        """Gets the server_templates of this CompositeTemplate.  # noqa: E501
165
166        0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value  # noqa: E501
167
168        :return: The server_templates of this CompositeTemplate.  # noqa: E501
169        :rtype: list[ServerTemplate]
170        """
171        return self._server_templates
172
173    @server_templates.setter
174    def server_templates(self, server_templates):
175        """Sets the server_templates of this CompositeTemplate.
176
177        0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value  # noqa: E501
178
179        :param server_templates: The server_templates of this CompositeTemplate.  # noqa: E501
180        :type: list[ServerTemplate]
181        """
182
183        self._server_templates = server_templates
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(CompositeTemplate, 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, CompositeTemplate):
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, CompositeTemplate):
230            return True
231
232        return self.to_dict() != other.to_dict()