docusign_esign.models.recipient_phone_authentication

  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 RecipientPhoneAuthentication(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        'recip_may_provide_number': 'str',
 37        'recip_may_provide_number_metadata': 'PropertyMetadata',
 38        'record_voice_print': 'str',
 39        'record_voice_print_metadata': 'PropertyMetadata',
 40        'sender_provided_numbers': 'list[str]',
 41        'sender_provided_numbers_metadata': 'PropertyMetadata',
 42        'validate_recip_provided_number': 'str',
 43        'validate_recip_provided_number_metadata': 'PropertyMetadata'
 44    }
 45
 46    attribute_map = {
 47        'recip_may_provide_number': 'recipMayProvideNumber',
 48        'recip_may_provide_number_metadata': 'recipMayProvideNumberMetadata',
 49        'record_voice_print': 'recordVoicePrint',
 50        'record_voice_print_metadata': 'recordVoicePrintMetadata',
 51        'sender_provided_numbers': 'senderProvidedNumbers',
 52        'sender_provided_numbers_metadata': 'senderProvidedNumbersMetadata',
 53        'validate_recip_provided_number': 'validateRecipProvidedNumber',
 54        'validate_recip_provided_number_metadata': 'validateRecipProvidedNumberMetadata'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """RecipientPhoneAuthentication - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._recip_may_provide_number = None
 64        self._recip_may_provide_number_metadata = None
 65        self._record_voice_print = None
 66        self._record_voice_print_metadata = None
 67        self._sender_provided_numbers = None
 68        self._sender_provided_numbers_metadata = None
 69        self._validate_recip_provided_number = None
 70        self._validate_recip_provided_number_metadata = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('recip_may_provide_number'), kwargs.get('recip_may_provide_number', None))
 74        setattr(self, "_{}".format('recip_may_provide_number_metadata'), kwargs.get('recip_may_provide_number_metadata', None))
 75        setattr(self, "_{}".format('record_voice_print'), kwargs.get('record_voice_print', None))
 76        setattr(self, "_{}".format('record_voice_print_metadata'), kwargs.get('record_voice_print_metadata', None))
 77        setattr(self, "_{}".format('sender_provided_numbers'), kwargs.get('sender_provided_numbers', None))
 78        setattr(self, "_{}".format('sender_provided_numbers_metadata'), kwargs.get('sender_provided_numbers_metadata', None))
 79        setattr(self, "_{}".format('validate_recip_provided_number'), kwargs.get('validate_recip_provided_number', None))
 80        setattr(self, "_{}".format('validate_recip_provided_number_metadata'), kwargs.get('validate_recip_provided_number_metadata', None))
 81
 82    @property
 83    def recip_may_provide_number(self):
 84        """Gets the recip_may_provide_number of this RecipientPhoneAuthentication.  # noqa: E501
 85
 86        Boolean. When set to **true**, the recipient can supply a phone number their choice.  # noqa: E501
 87
 88        :return: The recip_may_provide_number of this RecipientPhoneAuthentication.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._recip_may_provide_number
 92
 93    @recip_may_provide_number.setter
 94    def recip_may_provide_number(self, recip_may_provide_number):
 95        """Sets the recip_may_provide_number of this RecipientPhoneAuthentication.
 96
 97        Boolean. When set to **true**, the recipient can supply a phone number their choice.  # noqa: E501
 98
 99        :param recip_may_provide_number: The recip_may_provide_number of this RecipientPhoneAuthentication.  # noqa: E501
100        :type: str
101        """
102
103        self._recip_may_provide_number = recip_may_provide_number
104
105    @property
106    def recip_may_provide_number_metadata(self):
107        """Gets the recip_may_provide_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
108
109        Metadata that indicates whether the `recipMayProvideNumber` property can be edited.  # noqa: E501
110
111        :return: The recip_may_provide_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
112        :rtype: PropertyMetadata
113        """
114        return self._recip_may_provide_number_metadata
115
116    @recip_may_provide_number_metadata.setter
117    def recip_may_provide_number_metadata(self, recip_may_provide_number_metadata):
118        """Sets the recip_may_provide_number_metadata of this RecipientPhoneAuthentication.
119
120        Metadata that indicates whether the `recipMayProvideNumber` property can be edited.  # noqa: E501
121
122        :param recip_may_provide_number_metadata: The recip_may_provide_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
123        :type: PropertyMetadata
124        """
125
126        self._recip_may_provide_number_metadata = recip_may_provide_number_metadata
127
128    @property
129    def record_voice_print(self):
130        """Gets the record_voice_print of this RecipientPhoneAuthentication.  # noqa: E501
131
132        Reserved.  # noqa: E501
133
134        :return: The record_voice_print of this RecipientPhoneAuthentication.  # noqa: E501
135        :rtype: str
136        """
137        return self._record_voice_print
138
139    @record_voice_print.setter
140    def record_voice_print(self, record_voice_print):
141        """Sets the record_voice_print of this RecipientPhoneAuthentication.
142
143        Reserved.  # noqa: E501
144
145        :param record_voice_print: The record_voice_print of this RecipientPhoneAuthentication.  # noqa: E501
146        :type: str
147        """
148
149        self._record_voice_print = record_voice_print
150
151    @property
152    def record_voice_print_metadata(self):
153        """Gets the record_voice_print_metadata of this RecipientPhoneAuthentication.  # noqa: E501
154
155        Reserved for DocuSign.  # noqa: E501
156
157        :return: The record_voice_print_metadata of this RecipientPhoneAuthentication.  # noqa: E501
158        :rtype: PropertyMetadata
159        """
160        return self._record_voice_print_metadata
161
162    @record_voice_print_metadata.setter
163    def record_voice_print_metadata(self, record_voice_print_metadata):
164        """Sets the record_voice_print_metadata of this RecipientPhoneAuthentication.
165
166        Reserved for DocuSign.  # noqa: E501
167
168        :param record_voice_print_metadata: The record_voice_print_metadata of this RecipientPhoneAuthentication.  # noqa: E501
169        :type: PropertyMetadata
170        """
171
172        self._record_voice_print_metadata = record_voice_print_metadata
173
174    @property
175    def sender_provided_numbers(self):
176        """Gets the sender_provided_numbers of this RecipientPhoneAuthentication.  # noqa: E501
177
178        An Array containing a list of phone numbers the recipient may use for SMS text authentication.   # noqa: E501
179
180        :return: The sender_provided_numbers of this RecipientPhoneAuthentication.  # noqa: E501
181        :rtype: list[str]
182        """
183        return self._sender_provided_numbers
184
185    @sender_provided_numbers.setter
186    def sender_provided_numbers(self, sender_provided_numbers):
187        """Sets the sender_provided_numbers of this RecipientPhoneAuthentication.
188
189        An Array containing a list of phone numbers the recipient may use for SMS text authentication.   # noqa: E501
190
191        :param sender_provided_numbers: The sender_provided_numbers of this RecipientPhoneAuthentication.  # noqa: E501
192        :type: list[str]
193        """
194
195        self._sender_provided_numbers = sender_provided_numbers
196
197    @property
198    def sender_provided_numbers_metadata(self):
199        """Gets the sender_provided_numbers_metadata of this RecipientPhoneAuthentication.  # noqa: E501
200
201        Metadata that indicates whether the `senderProvidedNumbers` property can be edited.  # noqa: E501
202
203        :return: The sender_provided_numbers_metadata of this RecipientPhoneAuthentication.  # noqa: E501
204        :rtype: PropertyMetadata
205        """
206        return self._sender_provided_numbers_metadata
207
208    @sender_provided_numbers_metadata.setter
209    def sender_provided_numbers_metadata(self, sender_provided_numbers_metadata):
210        """Sets the sender_provided_numbers_metadata of this RecipientPhoneAuthentication.
211
212        Metadata that indicates whether the `senderProvidedNumbers` property can be edited.  # noqa: E501
213
214        :param sender_provided_numbers_metadata: The sender_provided_numbers_metadata of this RecipientPhoneAuthentication.  # noqa: E501
215        :type: PropertyMetadata
216        """
217
218        self._sender_provided_numbers_metadata = sender_provided_numbers_metadata
219
220    @property
221    def validate_recip_provided_number(self):
222        """Gets the validate_recip_provided_number of this RecipientPhoneAuthentication.  # noqa: E501
223
224         Reserved.  # noqa: E501
225
226        :return: The validate_recip_provided_number of this RecipientPhoneAuthentication.  # noqa: E501
227        :rtype: str
228        """
229        return self._validate_recip_provided_number
230
231    @validate_recip_provided_number.setter
232    def validate_recip_provided_number(self, validate_recip_provided_number):
233        """Sets the validate_recip_provided_number of this RecipientPhoneAuthentication.
234
235         Reserved.  # noqa: E501
236
237        :param validate_recip_provided_number: The validate_recip_provided_number of this RecipientPhoneAuthentication.  # noqa: E501
238        :type: str
239        """
240
241        self._validate_recip_provided_number = validate_recip_provided_number
242
243    @property
244    def validate_recip_provided_number_metadata(self):
245        """Gets the validate_recip_provided_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
246
247        Reserved for DocuSign.  # noqa: E501
248
249        :return: The validate_recip_provided_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
250        :rtype: PropertyMetadata
251        """
252        return self._validate_recip_provided_number_metadata
253
254    @validate_recip_provided_number_metadata.setter
255    def validate_recip_provided_number_metadata(self, validate_recip_provided_number_metadata):
256        """Sets the validate_recip_provided_number_metadata of this RecipientPhoneAuthentication.
257
258        Reserved for DocuSign.  # noqa: E501
259
260        :param validate_recip_provided_number_metadata: The validate_recip_provided_number_metadata of this RecipientPhoneAuthentication.  # noqa: E501
261        :type: PropertyMetadata
262        """
263
264        self._validate_recip_provided_number_metadata = validate_recip_provided_number_metadata
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(RecipientPhoneAuthentication, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, RecipientPhoneAuthentication):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, RecipientPhoneAuthentication):
311            return True
312
313        return self.to_dict() != other.to_dict()