docusign_esign.models.custom_field_v2

  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.
  7
  8    OpenAPI spec version: v2
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14from pprint import pformat
 15from six import iteritems
 16import re
 17
 18
 19class CustomFieldV2(object):
 20    """
 21    NOTE: This class is auto generated by the swagger code generator program.
 22    Do not edit the class manually.
 23    """
 24    def __init__(self, configuration_type=None, error_details=None, field_id=None, name=None, required=None, show=None, value=None):
 25        """
 26        CustomFieldV2 - a model defined in Swagger
 27
 28        :param dict swaggerTypes: The key is attribute name
 29                                  and the value is attribute type.
 30        :param dict attributeMap: The key is attribute name
 31                                  and the value is json key in definition.
 32        """
 33        self.swagger_types = {
 34            'configuration_type': 'str',
 35            'error_details': 'ErrorDetails',
 36            'field_id': 'str',
 37            'name': 'str',
 38            'required': 'str',
 39            'show': 'str',
 40            'value': 'str'
 41        }
 42
 43        self.attribute_map = {
 44            'configuration_type': 'configurationType',
 45            'error_details': 'errorDetails',
 46            'field_id': 'fieldId',
 47            'name': 'name',
 48            'required': 'required',
 49            'show': 'show',
 50            'value': 'value'
 51        }
 52
 53        self._configuration_type = configuration_type
 54        self._error_details = error_details
 55        self._field_id = field_id
 56        self._name = name
 57        self._required = required
 58        self._show = show
 59        self._value = value
 60
 61    @property
 62    def configuration_type(self):
 63        """
 64        Gets the configuration_type of this CustomFieldV2.
 65        If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
 66
 67        :return: The configuration_type of this CustomFieldV2.
 68        :rtype: str
 69        """
 70        return self._configuration_type
 71
 72    @configuration_type.setter
 73    def configuration_type(self, configuration_type):
 74        """
 75        Sets the configuration_type of this CustomFieldV2.
 76        If merge field's are being used, specifies the type of the merge field. The only  supported value is **salesforce**.
 77
 78        :param configuration_type: The configuration_type of this CustomFieldV2.
 79        :type: str
 80        """
 81
 82        self._configuration_type = configuration_type
 83
 84    @property
 85    def error_details(self):
 86        """
 87        Gets the error_details of this CustomFieldV2.
 88
 89        :return: The error_details of this CustomFieldV2.
 90        :rtype: ErrorDetails
 91        """
 92        return self._error_details
 93
 94    @error_details.setter
 95    def error_details(self, error_details):
 96        """
 97        Sets the error_details of this CustomFieldV2.
 98
 99        :param error_details: The error_details of this CustomFieldV2.
100        :type: ErrorDetails
101        """
102
103        self._error_details = error_details
104
105    @property
106    def field_id(self):
107        """
108        Gets the field_id of this CustomFieldV2.
109        
110
111        :return: The field_id of this CustomFieldV2.
112        :rtype: str
113        """
114        return self._field_id
115
116    @field_id.setter
117    def field_id(self, field_id):
118        """
119        Sets the field_id of this CustomFieldV2.
120        
121
122        :param field_id: The field_id of this CustomFieldV2.
123        :type: str
124        """
125
126        self._field_id = field_id
127
128    @property
129    def name(self):
130        """
131        Gets the name of this CustomFieldV2.
132        
133
134        :return: The name of this CustomFieldV2.
135        :rtype: str
136        """
137        return self._name
138
139    @name.setter
140    def name(self, name):
141        """
142        Sets the name of this CustomFieldV2.
143        
144
145        :param name: The name of this CustomFieldV2.
146        :type: str
147        """
148
149        self._name = name
150
151    @property
152    def required(self):
153        """
154        Gets the required of this CustomFieldV2.
155        When set to **true**, the signer is required to fill out this tab
156
157        :return: The required of this CustomFieldV2.
158        :rtype: str
159        """
160        return self._required
161
162    @required.setter
163    def required(self, required):
164        """
165        Sets the required of this CustomFieldV2.
166        When set to **true**, the signer is required to fill out this tab
167
168        :param required: The required of this CustomFieldV2.
169        :type: str
170        """
171
172        self._required = required
173
174    @property
175    def show(self):
176        """
177        Gets the show of this CustomFieldV2.
178        
179
180        :return: The show of this CustomFieldV2.
181        :rtype: str
182        """
183        return self._show
184
185    @show.setter
186    def show(self, show):
187        """
188        Sets the show of this CustomFieldV2.
189        
190
191        :param show: The show of this CustomFieldV2.
192        :type: str
193        """
194
195        self._show = show
196
197    @property
198    def value(self):
199        """
200        Gets the value of this CustomFieldV2.
201        The value of the custom field.
202
203        :return: The value of this CustomFieldV2.
204        :rtype: str
205        """
206        return self._value
207
208    @value.setter
209    def value(self, value):
210        """
211        Sets the value of this CustomFieldV2.
212        The value of the custom field.
213
214        :param value: The value of this CustomFieldV2.
215        :type: str
216        """
217
218        self._value = value
219
220    def to_dict(self):
221        """
222        Returns the model properties as a dict
223        """
224        result = {}
225
226        for attr, _ in iteritems(self.swagger_types):
227            value = getattr(self, attr)
228            if isinstance(value, list):
229                result[attr] = list(map(
230                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
231                    value
232                ))
233            elif hasattr(value, "to_dict"):
234                result[attr] = value.to_dict()
235            elif isinstance(value, dict):
236                result[attr] = dict(map(
237                    lambda item: (item[0], item[1].to_dict())
238                    if hasattr(item[1], "to_dict") else item,
239                    value.items()
240                ))
241            else:
242                result[attr] = value
243
244        return result
245
246    def to_str(self):
247        """
248        Returns the string representation of the model
249        """
250        return pformat(self.to_dict())
251
252    def __repr__(self):
253        """
254        For `print` and `pprint`
255        """
256        return self.to_str()
257
258    def __eq__(self, other):
259        """
260        Returns true if both objects are equal
261        """
262        return self.__dict__ == other.__dict__
263
264    def __ne__(self, other):
265        """
266        Returns true if both objects are not equal
267        """
268        return not self == other