docusign_esign.models.recipient_option

  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 RecipientOption(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        'email': 'str',
 37        'name': 'str',
 38        'recipient_label': 'str',
 39        'role_name': 'str',
 40        'signing_group_id': 'str'
 41    }
 42
 43    attribute_map = {
 44        'email': 'email',
 45        'name': 'name',
 46        'recipient_label': 'recipientLabel',
 47        'role_name': 'roleName',
 48        'signing_group_id': 'signingGroupId'
 49    }
 50
 51    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 52        """RecipientOption - a model defined in Swagger"""  # noqa: E501
 53        if _configuration is None:
 54            _configuration = Configuration()
 55        self._configuration = _configuration
 56
 57        self._email = None
 58        self._name = None
 59        self._recipient_label = None
 60        self._role_name = None
 61        self._signing_group_id = None
 62        self.discriminator = None
 63
 64        setattr(self, "_{}".format('email'), kwargs.get('email', None))
 65        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 66        setattr(self, "_{}".format('recipient_label'), kwargs.get('recipient_label', None))
 67        setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None))
 68        setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None))
 69
 70    @property
 71    def email(self):
 72        """Gets the email of this RecipientOption.  # noqa: E501
 73
 74          # noqa: E501
 75
 76        :return: The email of this RecipientOption.  # noqa: E501
 77        :rtype: str
 78        """
 79        return self._email
 80
 81    @email.setter
 82    def email(self, email):
 83        """Sets the email of this RecipientOption.
 84
 85          # noqa: E501
 86
 87        :param email: The email of this RecipientOption.  # noqa: E501
 88        :type: str
 89        """
 90
 91        self._email = email
 92
 93    @property
 94    def name(self):
 95        """Gets the name of this RecipientOption.  # noqa: E501
 96
 97          # noqa: E501
 98
 99        :return: The name of this RecipientOption.  # noqa: E501
100        :rtype: str
101        """
102        return self._name
103
104    @name.setter
105    def name(self, name):
106        """Sets the name of this RecipientOption.
107
108          # noqa: E501
109
110        :param name: The name of this RecipientOption.  # noqa: E501
111        :type: str
112        """
113
114        self._name = name
115
116    @property
117    def recipient_label(self):
118        """Gets the recipient_label of this RecipientOption.  # noqa: E501
119
120          # noqa: E501
121
122        :return: The recipient_label of this RecipientOption.  # noqa: E501
123        :rtype: str
124        """
125        return self._recipient_label
126
127    @recipient_label.setter
128    def recipient_label(self, recipient_label):
129        """Sets the recipient_label of this RecipientOption.
130
131          # noqa: E501
132
133        :param recipient_label: The recipient_label of this RecipientOption.  # noqa: E501
134        :type: str
135        """
136
137        self._recipient_label = recipient_label
138
139    @property
140    def role_name(self):
141        """Gets the role_name of this RecipientOption.  # noqa: E501
142
143        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
144
145        :return: The role_name of this RecipientOption.  # noqa: E501
146        :rtype: str
147        """
148        return self._role_name
149
150    @role_name.setter
151    def role_name(self, role_name):
152        """Sets the role_name of this RecipientOption.
153
154        Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.  # noqa: E501
155
156        :param role_name: The role_name of this RecipientOption.  # noqa: E501
157        :type: str
158        """
159
160        self._role_name = role_name
161
162    @property
163    def signing_group_id(self):
164        """Gets the signing_group_id of this RecipientOption.  # noqa: E501
165
166        When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).  # noqa: E501
167
168        :return: The signing_group_id of this RecipientOption.  # noqa: E501
169        :rtype: str
170        """
171        return self._signing_group_id
172
173    @signing_group_id.setter
174    def signing_group_id(self, signing_group_id):
175        """Sets the signing_group_id of this RecipientOption.
176
177        When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).  # noqa: E501
178
179        :param signing_group_id: The signing_group_id of this RecipientOption.  # noqa: E501
180        :type: str
181        """
182
183        self._signing_group_id = signing_group_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(RecipientOption, 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, RecipientOption):
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, RecipientOption):
230            return True
231
232        return self.to_dict() != other.to_dict()