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        'recipients': 'list[BulkSendingCopyRecipient]'
 41    }
 42
 43    attribute_map = {
 44        'custom_fields': 'customFields',
 45        'doc_gen_form_fields': 'docGenFormFields',
 46        'email_blurb': 'emailBlurb',
 47        'email_subject': 'emailSubject',
 48        'recipients': 'recipients'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """BulkSendingCopy - 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._doc_gen_form_fields = None
 59        self._email_blurb = None
 60        self._email_subject = None
 61        self._recipients = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None))
 65        setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None))
 66        setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None))
 67        setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None))
 68        setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None))
 69
 70    @property
 71    def custom_fields(self):
 72        """Gets the custom_fields of this BulkSendingCopy.  # 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 BulkSendingCopy.  # noqa: E501
 77        :rtype: list[BulkSendingCopyCustomField]
 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 BulkSendingCopy.
 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 BulkSendingCopy.  # noqa: E501
 88        :type: list[BulkSendingCopyCustomField]
 89        """
 90
 91        self._custom_fields = custom_fields
 92
 93    @property
 94    def doc_gen_form_fields(self):
 95        """Gets the doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
 96
 97          # noqa: E501
 98
 99        :return: The doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
100        :rtype: list[BulksendingCopyDocGenFormField]
101        """
102        return self._doc_gen_form_fields
103
104    @doc_gen_form_fields.setter
105    def doc_gen_form_fields(self, doc_gen_form_fields):
106        """Sets the doc_gen_form_fields of this BulkSendingCopy.
107
108          # noqa: E501
109
110        :param doc_gen_form_fields: The doc_gen_form_fields of this BulkSendingCopy.  # noqa: E501
111        :type: list[BulksendingCopyDocGenFormField]
112        """
113
114        self._doc_gen_form_fields = doc_gen_form_fields
115
116    @property
117    def email_blurb(self):
118        """Gets the email_blurb of this BulkSendingCopy.  # noqa: E501
119
120          # noqa: E501
121
122        :return: The email_blurb of this BulkSendingCopy.  # noqa: E501
123        :rtype: str
124        """
125        return self._email_blurb
126
127    @email_blurb.setter
128    def email_blurb(self, email_blurb):
129        """Sets the email_blurb of this BulkSendingCopy.
130
131          # noqa: E501
132
133        :param email_blurb: The email_blurb of this BulkSendingCopy.  # noqa: E501
134        :type: str
135        """
136
137        self._email_blurb = email_blurb
138
139    @property
140    def email_subject(self):
141        """Gets the email_subject of this BulkSendingCopy.  # noqa: E501
142
143        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
144
145        :return: The email_subject of this BulkSendingCopy.  # noqa: E501
146        :rtype: str
147        """
148        return self._email_subject
149
150    @email_subject.setter
151    def email_subject(self, email_subject):
152        """Sets the email_subject of this BulkSendingCopy.
153
154        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
155
156        :param email_subject: The email_subject of this BulkSendingCopy.  # noqa: E501
157        :type: str
158        """
159
160        self._email_subject = email_subject
161
162    @property
163    def recipients(self):
164        """Gets the recipients of this BulkSendingCopy.  # noqa: E501
165
166        An array of powerform recipients.  # noqa: E501
167
168        :return: The recipients of this BulkSendingCopy.  # noqa: E501
169        :rtype: list[BulkSendingCopyRecipient]
170        """
171        return self._recipients
172
173    @recipients.setter
174    def recipients(self, recipients):
175        """Sets the recipients of this BulkSendingCopy.
176
177        An array of powerform recipients.  # noqa: E501
178
179        :param recipients: The recipients of this BulkSendingCopy.  # noqa: E501
180        :type: list[BulkSendingCopyRecipient]
181        """
182
183        self._recipients = recipients
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(BulkSendingCopy, 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, BulkSendingCopy):
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, BulkSendingCopy):
230            return True
231
232        return self.to_dict() != other.to_dict()