docusign_esign.models.inline_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 InlineTemplate(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        'custom_fields': 'CustomFields',
 37        'documents': 'list[Document]',
 38        'envelope': 'Envelope',
 39        'recipients': 'Recipients',
 40        'sequence': 'str'
 41    }
 42
 43    attribute_map = {
 44        'custom_fields': 'customFields',
 45        'documents': 'documents',
 46        'envelope': 'envelope',
 47        'recipients': 'recipients',
 48        'sequence': 'sequence'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """InlineTemplate - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._custom_fields = None
 58        self._documents = None
 59        self._envelope = None
 60        self._recipients = None
 61        self._sequence = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
 65        setattr(self, "_{}".format('documents'), kwargs.get('documents', None))
 66        setattr(self, "_{}".format('envelope'), kwargs.get('envelope', None))
 67        setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None))
 68        setattr(self, "_{}".format('sequence'), kwargs.get('sequence', None))
 69
 70    @property
 71    def custom_fields(self):
 72        """Gets the custom_fields of this InlineTemplate.  # noqa: E501
 73
 74        An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.  # noqa: E501
 75
 76        :return: The custom_fields of this InlineTemplate.  # noqa: E501
 77        :rtype: CustomFields
 78        """
 79        return self._custom_fields
 80
 81    @custom_fields.setter
 82    def custom_fields(self, custom_fields):
 83        """Sets the custom_fields of this InlineTemplate.
 84
 85        An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.  # noqa: E501
 86
 87        :param custom_fields: The custom_fields of this InlineTemplate.  # noqa: E501
 88        :type: CustomFields
 89        """
 90
 91        self._custom_fields = custom_fields
 92
 93    @property
 94    def documents(self):
 95        """Gets the documents of this InlineTemplate.  # noqa: E501
 96
 97        Complex element contains the details on the documents in the envelope.  # noqa: E501
 98
 99        :return: The documents of this InlineTemplate.  # noqa: E501
100        :rtype: list[Document]
101        """
102        return self._documents
103
104    @documents.setter
105    def documents(self, documents):
106        """Sets the documents of this InlineTemplate.
107
108        Complex element contains the details on the documents in the envelope.  # noqa: E501
109
110        :param documents: The documents of this InlineTemplate.  # noqa: E501
111        :type: list[Document]
112        """
113
114        self._documents = documents
115
116    @property
117    def envelope(self):
118        """Gets the envelope of this InlineTemplate.  # noqa: E501
119
120        A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.  # noqa: E501
121
122        :return: The envelope of this InlineTemplate.  # noqa: E501
123        :rtype: Envelope
124        """
125        return self._envelope
126
127    @envelope.setter
128    def envelope(self, envelope):
129        """Sets the envelope of this InlineTemplate.
130
131        A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.  # noqa: E501
132
133        :param envelope: The envelope of this InlineTemplate.  # noqa: E501
134        :type: Envelope
135        """
136
137        self._envelope = envelope
138
139    @property
140    def recipients(self):
141        """Gets the recipients of this InlineTemplate.  # noqa: E501
142
143        An array of powerform recipients.  # noqa: E501
144
145        :return: The recipients of this InlineTemplate.  # noqa: E501
146        :rtype: Recipients
147        """
148        return self._recipients
149
150    @recipients.setter
151    def recipients(self, recipients):
152        """Sets the recipients of this InlineTemplate.
153
154        An array of powerform recipients.  # noqa: E501
155
156        :param recipients: The recipients of this InlineTemplate.  # noqa: E501
157        :type: Recipients
158        """
159
160        self._recipients = recipients
161
162    @property
163    def sequence(self):
164        """Gets the sequence of this InlineTemplate.  # noqa: E501
165
166        Specifies the order in which templates are overlaid.  # noqa: E501
167
168        :return: The sequence of this InlineTemplate.  # noqa: E501
169        :rtype: str
170        """
171        return self._sequence
172
173    @sequence.setter
174    def sequence(self, sequence):
175        """Sets the sequence of this InlineTemplate.
176
177        Specifies the order in which templates are overlaid.  # noqa: E501
178
179        :param sequence: The sequence of this InlineTemplate.  # noqa: E501
180        :type: str
181        """
182
183        self._sequence = sequence
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(InlineTemplate, 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, InlineTemplate):
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, InlineTemplate):
230            return True
231
232        return self.to_dict() != other.to_dict()