docusign_esign.models.bulk_sending_copy

  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 BulkSendingCopy(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': 'list[BulkSendingCopyCustomField]',
 37        'doc_gen_form_fields': 'list[BulksendingCopyDocGenFormField]',
 38        'email_blurb': 'str',
 39        'email_subject': 'str',
 40        'prefill_tabs': 'list[BulkSendingCopyPrefillTab]',
 41        'recipients': 'list[BulkSendingCopyRecipient]'
 42    }
 43
 44    attribute_map = {
 45        'custom_fields': 'customFields',
 46        'doc_gen_form_fields': 'docGenFormFields',
 47        'email_blurb': 'emailBlurb',
 48        'email_subject': 'emailSubject',
 49        'prefill_tabs': 'prefillTabs',
 50        'recipients': 'recipients'
 51    }
 52
 53    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 54        """BulkSendingCopy - a model defined in Swagger"""  # noqa: E501
 55        if _configuration is None:
 56            _configuration = Configuration()
 57        self._configuration = _configuration
 58
 59        self._custom_fields = None
 60        self._doc_gen_form_fields = None
 61        self._email_blurb = None
 62        self._email_subject = None
 63        self._prefill_tabs = None
 64        self._recipients = None
 65        self.discriminator = None
 66
 67        setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
 68        setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None))
 69        setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None))
 70        setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None))
 71        setattr(self, "_{}".format('prefill_tabs'), kwargs.get('prefill_tabs', None))
 72        setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None))
 73
 74    @property
 75    def custom_fields(self):
 76        """Gets the custom_fields of this BulkSendingCopy.  # noqa: E501
 77
 78        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
 79
 80        :return: The custom_fields of this BulkSendingCopy.  # noqa: E501
 81        :rtype: list[BulkSendingCopyCustomField]
 82        """
 83        return self._custom_fields
 84
 85    @custom_fields.setter
 86    def custom_fields(self, custom_fields):
 87        """Sets the custom_fields of this BulkSendingCopy.
 88
 89        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
 90
 91        :param custom_fields: The custom_fields of this BulkSendingCopy.  # noqa: E501
 92        :type: list[BulkSendingCopyCustomField]
 93        """
 94
 95        self._custom_fields = custom_fields
 96
 97    @property
 98    def doc_gen_form_fields(self):
 99        """Gets the doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
100
101          # noqa: E501
102
103        :return: The doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
104        :rtype: list[BulksendingCopyDocGenFormField]
105        """
106        return self._doc_gen_form_fields
107
108    @doc_gen_form_fields.setter
109    def doc_gen_form_fields(self, doc_gen_form_fields):
110        """Sets the doc_gen_form_fields of this BulkSendingCopy.
111
112          # noqa: E501
113
114        :param doc_gen_form_fields: The doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
115        :type: list[BulksendingCopyDocGenFormField]
116        """
117
118        self._doc_gen_form_fields = doc_gen_form_fields
119
120    @property
121    def email_blurb(self):
122        """Gets the email_blurb of this BulkSendingCopy.  # noqa: E501
123
124          # noqa: E501
125
126        :return: The email_blurb of this BulkSendingCopy.  # noqa: E501
127        :rtype: str
128        """
129        return self._email_blurb
130
131    @email_blurb.setter
132    def email_blurb(self, email_blurb):
133        """Sets the email_blurb of this BulkSendingCopy.
134
135          # noqa: E501
136
137        :param email_blurb: The email_blurb of this BulkSendingCopy.  # noqa: E501
138        :type: str
139        """
140
141        self._email_blurb = email_blurb
142
143    @property
144    def email_subject(self):
145        """Gets the email_subject of this BulkSendingCopy.  # noqa: E501
146
147        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.  # noqa: E501
148
149        :return: The email_subject of this BulkSendingCopy.  # noqa: E501
150        :rtype: str
151        """
152        return self._email_subject
153
154    @email_subject.setter
155    def email_subject(self, email_subject):
156        """Sets the email_subject of this BulkSendingCopy.
157
158        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.  # noqa: E501
159
160        :param email_subject: The email_subject of this BulkSendingCopy.  # noqa: E501
161        :type: str
162        """
163
164        self._email_subject = email_subject
165
166    @property
167    def prefill_tabs(self):
168        """Gets the prefill_tabs of this BulkSendingCopy.  # noqa: E501
169
170          # noqa: E501
171
172        :return: The prefill_tabs of this BulkSendingCopy.  # noqa: E501
173        :rtype: list[BulkSendingCopyPrefillTab]
174        """
175        return self._prefill_tabs
176
177    @prefill_tabs.setter
178    def prefill_tabs(self, prefill_tabs):
179        """Sets the prefill_tabs of this BulkSendingCopy.
180
181          # noqa: E501
182
183        :param prefill_tabs: The prefill_tabs of this BulkSendingCopy.  # noqa: E501
184        :type: list[BulkSendingCopyPrefillTab]
185        """
186
187        self._prefill_tabs = prefill_tabs
188
189    @property
190    def recipients(self):
191        """Gets the recipients of this BulkSendingCopy.  # noqa: E501
192
193        An array of powerform recipients.  # noqa: E501
194
195        :return: The recipients of this BulkSendingCopy.  # noqa: E501
196        :rtype: list[BulkSendingCopyRecipient]
197        """
198        return self._recipients
199
200    @recipients.setter
201    def recipients(self, recipients):
202        """Sets the recipients of this BulkSendingCopy.
203
204        An array of powerform recipients.  # noqa: E501
205
206        :param recipients: The recipients of this BulkSendingCopy.  # noqa: E501
207        :type: list[BulkSendingCopyRecipient]
208        """
209
210        self._recipients = recipients
211
212    def to_dict(self):
213        """Returns the model properties as a dict"""
214        result = {}
215
216        for attr, _ in six.iteritems(self.swagger_types):
217            value = getattr(self, attr)
218            if isinstance(value, list):
219                result[attr] = list(map(
220                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
221                    value
222                ))
223            elif hasattr(value, "to_dict"):
224                result[attr] = value.to_dict()
225            elif isinstance(value, dict):
226                result[attr] = dict(map(
227                    lambda item: (item[0], item[1].to_dict())
228                    if hasattr(item[1], "to_dict") else item,
229                    value.items()
230                ))
231            else:
232                result[attr] = value
233        if issubclass(BulkSendingCopy, dict):
234            for key, value in self.items():
235                result[key] = value
236
237        return result
238
239    def to_str(self):
240        """Returns the string representation of the model"""
241        return pprint.pformat(self.to_dict())
242
243    def __repr__(self):
244        """For `print` and `pprint`"""
245        return self.to_str()
246
247    def __eq__(self, other):
248        """Returns true if both objects are equal"""
249        if not isinstance(other, BulkSendingCopy):
250            return False
251
252        return self.to_dict() == other.to_dict()
253
254    def __ne__(self, other):
255        """Returns true if both objects are not equal"""
256        if not isinstance(other, BulkSendingCopy):
257            return True
258
259        return self.to_dict() != other.to_dict()