docusign_esign.models.merge_field
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
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 MergeField(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 'allow_sender_to_edit': 'str', 37 'allow_sender_to_edit_metadata': 'PropertyMetadata', 38 'configuration_type': 'str', 39 'configuration_type_metadata': 'PropertyMetadata', 40 'path': 'str', 41 'path_extended': 'list[PathExtendedElement]', 42 'path_extended_metadata': 'PropertyMetadata', 43 'path_metadata': 'PropertyMetadata', 44 'row': 'str', 45 'row_metadata': 'PropertyMetadata', 46 'write_back': 'str', 47 'write_back_metadata': 'PropertyMetadata' 48 } 49 50 attribute_map = { 51 'allow_sender_to_edit': 'allowSenderToEdit', 52 'allow_sender_to_edit_metadata': 'allowSenderToEditMetadata', 53 'configuration_type': 'configurationType', 54 'configuration_type_metadata': 'configurationTypeMetadata', 55 'path': 'path', 56 'path_extended': 'pathExtended', 57 'path_extended_metadata': 'pathExtendedMetadata', 58 'path_metadata': 'pathMetadata', 59 'row': 'row', 60 'row_metadata': 'rowMetadata', 61 'write_back': 'writeBack', 62 'write_back_metadata': 'writeBackMetadata' 63 } 64 65 def __init__(self, _configuration=None, **kwargs): # noqa: E501 66 """MergeField - a model defined in Swagger""" # noqa: E501 67 if _configuration is None: 68 _configuration = Configuration() 69 self._configuration = _configuration 70 71 self._allow_sender_to_edit = None 72 self._allow_sender_to_edit_metadata = None 73 self._configuration_type = None 74 self._configuration_type_metadata = None 75 self._path = None 76 self._path_extended = None 77 self._path_extended_metadata = None 78 self._path_metadata = None 79 self._row = None 80 self._row_metadata = None 81 self._write_back = None 82 self._write_back_metadata = None 83 self.discriminator = None 84 85 setattr(self, "_{}".format('allow_sender_to_edit'), kwargs.get('allow_sender_to_edit', None)) 86 setattr(self, "_{}".format('allow_sender_to_edit_metadata'), kwargs.get('allow_sender_to_edit_metadata', None)) 87 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 88 setattr(self, "_{}".format('configuration_type_metadata'), kwargs.get('configuration_type_metadata', None)) 89 setattr(self, "_{}".format('path'), kwargs.get('path', None)) 90 setattr(self, "_{}".format('path_extended'), kwargs.get('path_extended', None)) 91 setattr(self, "_{}".format('path_extended_metadata'), kwargs.get('path_extended_metadata', None)) 92 setattr(self, "_{}".format('path_metadata'), kwargs.get('path_metadata', None)) 93 setattr(self, "_{}".format('row'), kwargs.get('row', None)) 94 setattr(self, "_{}".format('row_metadata'), kwargs.get('row_metadata', None)) 95 setattr(self, "_{}".format('write_back'), kwargs.get('write_back', None)) 96 setattr(self, "_{}".format('write_back_metadata'), kwargs.get('write_back_metadata', None)) 97 98 @property 99 def allow_sender_to_edit(self): 100 """Gets the allow_sender_to_edit of this MergeField. # noqa: E501 101 102 When set to **true**, the sender can modify the value of the custom tab during the sending process. # noqa: E501 103 104 :return: The allow_sender_to_edit of this MergeField. # noqa: E501 105 :rtype: str 106 """ 107 return self._allow_sender_to_edit 108 109 @allow_sender_to_edit.setter 110 def allow_sender_to_edit(self, allow_sender_to_edit): 111 """Sets the allow_sender_to_edit of this MergeField. 112 113 When set to **true**, the sender can modify the value of the custom tab during the sending process. # noqa: E501 114 115 :param allow_sender_to_edit: The allow_sender_to_edit of this MergeField. # noqa: E501 116 :type: str 117 """ 118 119 self._allow_sender_to_edit = allow_sender_to_edit 120 121 @property 122 def allow_sender_to_edit_metadata(self): 123 """Gets the allow_sender_to_edit_metadata of this MergeField. # noqa: E501 124 125 Metadata that indicates if the sender can edit the `allowSenderToEdit` property. # noqa: E501 126 127 :return: The allow_sender_to_edit_metadata of this MergeField. # noqa: E501 128 :rtype: PropertyMetadata 129 """ 130 return self._allow_sender_to_edit_metadata 131 132 @allow_sender_to_edit_metadata.setter 133 def allow_sender_to_edit_metadata(self, allow_sender_to_edit_metadata): 134 """Sets the allow_sender_to_edit_metadata of this MergeField. 135 136 Metadata that indicates if the sender can edit the `allowSenderToEdit` property. # noqa: E501 137 138 :param allow_sender_to_edit_metadata: The allow_sender_to_edit_metadata of this MergeField. # noqa: E501 139 :type: PropertyMetadata 140 """ 141 142 self._allow_sender_to_edit_metadata = allow_sender_to_edit_metadata 143 144 @property 145 def configuration_type(self): 146 """Gets the configuration_type of this MergeField. # noqa: E501 147 148 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 149 150 :return: The configuration_type of this MergeField. # noqa: E501 151 :rtype: str 152 """ 153 return self._configuration_type 154 155 @configuration_type.setter 156 def configuration_type(self, configuration_type): 157 """Sets the configuration_type of this MergeField. 158 159 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 160 161 :param configuration_type: The configuration_type of this MergeField. # noqa: E501 162 :type: str 163 """ 164 165 self._configuration_type = configuration_type 166 167 @property 168 def configuration_type_metadata(self): 169 """Gets the configuration_type_metadata of this MergeField. # noqa: E501 170 171 Metadata that indicates if the sender can edit the `configurationType` property. # noqa: E501 172 173 :return: The configuration_type_metadata of this MergeField. # noqa: E501 174 :rtype: PropertyMetadata 175 """ 176 return self._configuration_type_metadata 177 178 @configuration_type_metadata.setter 179 def configuration_type_metadata(self, configuration_type_metadata): 180 """Sets the configuration_type_metadata of this MergeField. 181 182 Metadata that indicates if the sender can edit the `configurationType` property. # noqa: E501 183 184 :param configuration_type_metadata: The configuration_type_metadata of this MergeField. # noqa: E501 185 :type: PropertyMetadata 186 """ 187 188 self._configuration_type_metadata = configuration_type_metadata 189 190 @property 191 def path(self): 192 """Gets the path of this MergeField. # noqa: E501 193 194 Sets the object associated with the custom tab. Currently this is the Salesforce Object. # noqa: E501 195 196 :return: The path of this MergeField. # noqa: E501 197 :rtype: str 198 """ 199 return self._path 200 201 @path.setter 202 def path(self, path): 203 """Sets the path of this MergeField. 204 205 Sets the object associated with the custom tab. Currently this is the Salesforce Object. # noqa: E501 206 207 :param path: The path of this MergeField. # noqa: E501 208 :type: str 209 """ 210 211 self._path = path 212 213 @property 214 def path_extended(self): 215 """Gets the path_extended of this MergeField. # noqa: E501 216 217 # noqa: E501 218 219 :return: The path_extended of this MergeField. # noqa: E501 220 :rtype: list[PathExtendedElement] 221 """ 222 return self._path_extended 223 224 @path_extended.setter 225 def path_extended(self, path_extended): 226 """Sets the path_extended of this MergeField. 227 228 # noqa: E501 229 230 :param path_extended: The path_extended of this MergeField. # noqa: E501 231 :type: list[PathExtendedElement] 232 """ 233 234 self._path_extended = path_extended 235 236 @property 237 def path_extended_metadata(self): 238 """Gets the path_extended_metadata of this MergeField. # noqa: E501 239 240 Reserved for DocuSign. # noqa: E501 241 242 :return: The path_extended_metadata of this MergeField. # noqa: E501 243 :rtype: PropertyMetadata 244 """ 245 return self._path_extended_metadata 246 247 @path_extended_metadata.setter 248 def path_extended_metadata(self, path_extended_metadata): 249 """Sets the path_extended_metadata of this MergeField. 250 251 Reserved for DocuSign. # noqa: E501 252 253 :param path_extended_metadata: The path_extended_metadata of this MergeField. # noqa: E501 254 :type: PropertyMetadata 255 """ 256 257 self._path_extended_metadata = path_extended_metadata 258 259 @property 260 def path_metadata(self): 261 """Gets the path_metadata of this MergeField. # noqa: E501 262 263 Metadata that indicates whether the `path` property is editable. # noqa: E501 264 265 :return: The path_metadata of this MergeField. # noqa: E501 266 :rtype: PropertyMetadata 267 """ 268 return self._path_metadata 269 270 @path_metadata.setter 271 def path_metadata(self, path_metadata): 272 """Sets the path_metadata of this MergeField. 273 274 Metadata that indicates whether the `path` property is editable. # noqa: E501 275 276 :param path_metadata: The path_metadata of this MergeField. # noqa: E501 277 :type: PropertyMetadata 278 """ 279 280 self._path_metadata = path_metadata 281 282 @property 283 def row(self): 284 """Gets the row of this MergeField. # noqa: E501 285 286 Specifies the row number in a Salesforce table that the merge field value corresponds to. # noqa: E501 287 288 :return: The row of this MergeField. # noqa: E501 289 :rtype: str 290 """ 291 return self._row 292 293 @row.setter 294 def row(self, row): 295 """Sets the row of this MergeField. 296 297 Specifies the row number in a Salesforce table that the merge field value corresponds to. # noqa: E501 298 299 :param row: The row of this MergeField. # noqa: E501 300 :type: str 301 """ 302 303 self._row = row 304 305 @property 306 def row_metadata(self): 307 """Gets the row_metadata of this MergeField. # noqa: E501 308 309 Metadata that indicates whether the `row` property is editable. # noqa: E501 310 311 :return: The row_metadata of this MergeField. # noqa: E501 312 :rtype: PropertyMetadata 313 """ 314 return self._row_metadata 315 316 @row_metadata.setter 317 def row_metadata(self, row_metadata): 318 """Sets the row_metadata of this MergeField. 319 320 Metadata that indicates whether the `row` property is editable. # noqa: E501 321 322 :param row_metadata: The row_metadata of this MergeField. # noqa: E501 323 :type: PropertyMetadata 324 """ 325 326 self._row_metadata = row_metadata 327 328 @property 329 def write_back(self): 330 """Gets the write_back of this MergeField. # noqa: E501 331 332 When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. # noqa: E501 333 334 :return: The write_back of this MergeField. # noqa: E501 335 :rtype: str 336 """ 337 return self._write_back 338 339 @write_back.setter 340 def write_back(self, write_back): 341 """Sets the write_back of this MergeField. 342 343 When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. # noqa: E501 344 345 :param write_back: The write_back of this MergeField. # noqa: E501 346 :type: str 347 """ 348 349 self._write_back = write_back 350 351 @property 352 def write_back_metadata(self): 353 """Gets the write_back_metadata of this MergeField. # noqa: E501 354 355 Metadata that indicates if the sender can edit the `writeBack` property. # noqa: E501 356 357 :return: The write_back_metadata of this MergeField. # noqa: E501 358 :rtype: PropertyMetadata 359 """ 360 return self._write_back_metadata 361 362 @write_back_metadata.setter 363 def write_back_metadata(self, write_back_metadata): 364 """Sets the write_back_metadata of this MergeField. 365 366 Metadata that indicates if the sender can edit the `writeBack` property. # noqa: E501 367 368 :param write_back_metadata: The write_back_metadata of this MergeField. # noqa: E501 369 :type: PropertyMetadata 370 """ 371 372 self._write_back_metadata = write_back_metadata 373 374 def to_dict(self): 375 """Returns the model properties as a dict""" 376 result = {} 377 378 for attr, _ in six.iteritems(self.swagger_types): 379 value = getattr(self, attr) 380 if isinstance(value, list): 381 result[attr] = list(map( 382 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 383 value 384 )) 385 elif hasattr(value, "to_dict"): 386 result[attr] = value.to_dict() 387 elif isinstance(value, dict): 388 result[attr] = dict(map( 389 lambda item: (item[0], item[1].to_dict()) 390 if hasattr(item[1], "to_dict") else item, 391 value.items() 392 )) 393 else: 394 result[attr] = value 395 if issubclass(MergeField, dict): 396 for key, value in self.items(): 397 result[key] = value 398 399 return result 400 401 def to_str(self): 402 """Returns the string representation of the model""" 403 return pprint.pformat(self.to_dict()) 404 405 def __repr__(self): 406 """For `print` and `pprint`""" 407 return self.to_str() 408 409 def __eq__(self, other): 410 """Returns true if both objects are equal""" 411 if not isinstance(other, MergeField): 412 return False 413 414 return self.to_dict() == other.to_dict() 415 416 def __ne__(self, other): 417 """Returns true if both objects are not equal""" 418 if not isinstance(other, MergeField): 419 return True 420 421 return self.to_dict() != other.to_dict()
class
MergeField:
23class MergeField(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'allow_sender_to_edit': 'str', 38 'allow_sender_to_edit_metadata': 'PropertyMetadata', 39 'configuration_type': 'str', 40 'configuration_type_metadata': 'PropertyMetadata', 41 'path': 'str', 42 'path_extended': 'list[PathExtendedElement]', 43 'path_extended_metadata': 'PropertyMetadata', 44 'path_metadata': 'PropertyMetadata', 45 'row': 'str', 46 'row_metadata': 'PropertyMetadata', 47 'write_back': 'str', 48 'write_back_metadata': 'PropertyMetadata' 49 } 50 51 attribute_map = { 52 'allow_sender_to_edit': 'allowSenderToEdit', 53 'allow_sender_to_edit_metadata': 'allowSenderToEditMetadata', 54 'configuration_type': 'configurationType', 55 'configuration_type_metadata': 'configurationTypeMetadata', 56 'path': 'path', 57 'path_extended': 'pathExtended', 58 'path_extended_metadata': 'pathExtendedMetadata', 59 'path_metadata': 'pathMetadata', 60 'row': 'row', 61 'row_metadata': 'rowMetadata', 62 'write_back': 'writeBack', 63 'write_back_metadata': 'writeBackMetadata' 64 } 65 66 def __init__(self, _configuration=None, **kwargs): # noqa: E501 67 """MergeField - a model defined in Swagger""" # noqa: E501 68 if _configuration is None: 69 _configuration = Configuration() 70 self._configuration = _configuration 71 72 self._allow_sender_to_edit = None 73 self._allow_sender_to_edit_metadata = None 74 self._configuration_type = None 75 self._configuration_type_metadata = None 76 self._path = None 77 self._path_extended = None 78 self._path_extended_metadata = None 79 self._path_metadata = None 80 self._row = None 81 self._row_metadata = None 82 self._write_back = None 83 self._write_back_metadata = None 84 self.discriminator = None 85 86 setattr(self, "_{}".format('allow_sender_to_edit'), kwargs.get('allow_sender_to_edit', None)) 87 setattr(self, "_{}".format('allow_sender_to_edit_metadata'), kwargs.get('allow_sender_to_edit_metadata', None)) 88 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 89 setattr(self, "_{}".format('configuration_type_metadata'), kwargs.get('configuration_type_metadata', None)) 90 setattr(self, "_{}".format('path'), kwargs.get('path', None)) 91 setattr(self, "_{}".format('path_extended'), kwargs.get('path_extended', None)) 92 setattr(self, "_{}".format('path_extended_metadata'), kwargs.get('path_extended_metadata', None)) 93 setattr(self, "_{}".format('path_metadata'), kwargs.get('path_metadata', None)) 94 setattr(self, "_{}".format('row'), kwargs.get('row', None)) 95 setattr(self, "_{}".format('row_metadata'), kwargs.get('row_metadata', None)) 96 setattr(self, "_{}".format('write_back'), kwargs.get('write_back', None)) 97 setattr(self, "_{}".format('write_back_metadata'), kwargs.get('write_back_metadata', None)) 98 99 @property 100 def allow_sender_to_edit(self): 101 """Gets the allow_sender_to_edit of this MergeField. # noqa: E501 102 103 When set to **true**, the sender can modify the value of the custom tab during the sending process. # noqa: E501 104 105 :return: The allow_sender_to_edit of this MergeField. # noqa: E501 106 :rtype: str 107 """ 108 return self._allow_sender_to_edit 109 110 @allow_sender_to_edit.setter 111 def allow_sender_to_edit(self, allow_sender_to_edit): 112 """Sets the allow_sender_to_edit of this MergeField. 113 114 When set to **true**, the sender can modify the value of the custom tab during the sending process. # noqa: E501 115 116 :param allow_sender_to_edit: The allow_sender_to_edit of this MergeField. # noqa: E501 117 :type: str 118 """ 119 120 self._allow_sender_to_edit = allow_sender_to_edit 121 122 @property 123 def allow_sender_to_edit_metadata(self): 124 """Gets the allow_sender_to_edit_metadata of this MergeField. # noqa: E501 125 126 Metadata that indicates if the sender can edit the `allowSenderToEdit` property. # noqa: E501 127 128 :return: The allow_sender_to_edit_metadata of this MergeField. # noqa: E501 129 :rtype: PropertyMetadata 130 """ 131 return self._allow_sender_to_edit_metadata 132 133 @allow_sender_to_edit_metadata.setter 134 def allow_sender_to_edit_metadata(self, allow_sender_to_edit_metadata): 135 """Sets the allow_sender_to_edit_metadata of this MergeField. 136 137 Metadata that indicates if the sender can edit the `allowSenderToEdit` property. # noqa: E501 138 139 :param allow_sender_to_edit_metadata: The allow_sender_to_edit_metadata of this MergeField. # noqa: E501 140 :type: PropertyMetadata 141 """ 142 143 self._allow_sender_to_edit_metadata = allow_sender_to_edit_metadata 144 145 @property 146 def configuration_type(self): 147 """Gets the configuration_type of this MergeField. # noqa: E501 148 149 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 150 151 :return: The configuration_type of this MergeField. # noqa: E501 152 :rtype: str 153 """ 154 return self._configuration_type 155 156 @configuration_type.setter 157 def configuration_type(self, configuration_type): 158 """Sets the configuration_type of this MergeField. 159 160 If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**. # noqa: E501 161 162 :param configuration_type: The configuration_type of this MergeField. # noqa: E501 163 :type: str 164 """ 165 166 self._configuration_type = configuration_type 167 168 @property 169 def configuration_type_metadata(self): 170 """Gets the configuration_type_metadata of this MergeField. # noqa: E501 171 172 Metadata that indicates if the sender can edit the `configurationType` property. # noqa: E501 173 174 :return: The configuration_type_metadata of this MergeField. # noqa: E501 175 :rtype: PropertyMetadata 176 """ 177 return self._configuration_type_metadata 178 179 @configuration_type_metadata.setter 180 def configuration_type_metadata(self, configuration_type_metadata): 181 """Sets the configuration_type_metadata of this MergeField. 182 183 Metadata that indicates if the sender can edit the `configurationType` property. # noqa: E501 184 185 :param configuration_type_metadata: The configuration_type_metadata of this MergeField. # noqa: E501 186 :type: PropertyMetadata 187 """ 188 189 self._configuration_type_metadata = configuration_type_metadata 190 191 @property 192 def path(self): 193 """Gets the path of this MergeField. # noqa: E501 194 195 Sets the object associated with the custom tab. Currently this is the Salesforce Object. # noqa: E501 196 197 :return: The path of this MergeField. # noqa: E501 198 :rtype: str 199 """ 200 return self._path 201 202 @path.setter 203 def path(self, path): 204 """Sets the path of this MergeField. 205 206 Sets the object associated with the custom tab. Currently this is the Salesforce Object. # noqa: E501 207 208 :param path: The path of this MergeField. # noqa: E501 209 :type: str 210 """ 211 212 self._path = path 213 214 @property 215 def path_extended(self): 216 """Gets the path_extended of this MergeField. # noqa: E501 217 218 # noqa: E501 219 220 :return: The path_extended of this MergeField. # noqa: E501 221 :rtype: list[PathExtendedElement] 222 """ 223 return self._path_extended 224 225 @path_extended.setter 226 def path_extended(self, path_extended): 227 """Sets the path_extended of this MergeField. 228 229 # noqa: E501 230 231 :param path_extended: The path_extended of this MergeField. # noqa: E501 232 :type: list[PathExtendedElement] 233 """ 234 235 self._path_extended = path_extended 236 237 @property 238 def path_extended_metadata(self): 239 """Gets the path_extended_metadata of this MergeField. # noqa: E501 240 241 Reserved for DocuSign. # noqa: E501 242 243 :return: The path_extended_metadata of this MergeField. # noqa: E501 244 :rtype: PropertyMetadata 245 """ 246 return self._path_extended_metadata 247 248 @path_extended_metadata.setter 249 def path_extended_metadata(self, path_extended_metadata): 250 """Sets the path_extended_metadata of this MergeField. 251 252 Reserved for DocuSign. # noqa: E501 253 254 :param path_extended_metadata: The path_extended_metadata of this MergeField. # noqa: E501 255 :type: PropertyMetadata 256 """ 257 258 self._path_extended_metadata = path_extended_metadata 259 260 @property 261 def path_metadata(self): 262 """Gets the path_metadata of this MergeField. # noqa: E501 263 264 Metadata that indicates whether the `path` property is editable. # noqa: E501 265 266 :return: The path_metadata of this MergeField. # noqa: E501 267 :rtype: PropertyMetadata 268 """ 269 return self._path_metadata 270 271 @path_metadata.setter 272 def path_metadata(self, path_metadata): 273 """Sets the path_metadata of this MergeField. 274 275 Metadata that indicates whether the `path` property is editable. # noqa: E501 276 277 :param path_metadata: The path_metadata of this MergeField. # noqa: E501 278 :type: PropertyMetadata 279 """ 280 281 self._path_metadata = path_metadata 282 283 @property 284 def row(self): 285 """Gets the row of this MergeField. # noqa: E501 286 287 Specifies the row number in a Salesforce table that the merge field value corresponds to. # noqa: E501 288 289 :return: The row of this MergeField. # noqa: E501 290 :rtype: str 291 """ 292 return self._row 293 294 @row.setter 295 def row(self, row): 296 """Sets the row of this MergeField. 297 298 Specifies the row number in a Salesforce table that the merge field value corresponds to. # noqa: E501 299 300 :param row: The row of this MergeField. # noqa: E501 301 :type: str 302 """ 303 304 self._row = row 305 306 @property 307 def row_metadata(self): 308 """Gets the row_metadata of this MergeField. # noqa: E501 309 310 Metadata that indicates whether the `row` property is editable. # noqa: E501 311 312 :return: The row_metadata of this MergeField. # noqa: E501 313 :rtype: PropertyMetadata 314 """ 315 return self._row_metadata 316 317 @row_metadata.setter 318 def row_metadata(self, row_metadata): 319 """Sets the row_metadata of this MergeField. 320 321 Metadata that indicates whether the `row` property is editable. # noqa: E501 322 323 :param row_metadata: The row_metadata of this MergeField. # noqa: E501 324 :type: PropertyMetadata 325 """ 326 327 self._row_metadata = row_metadata 328 329 @property 330 def write_back(self): 331 """Gets the write_back of this MergeField. # noqa: E501 332 333 When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. # noqa: E501 334 335 :return: The write_back of this MergeField. # noqa: E501 336 :rtype: str 337 """ 338 return self._write_back 339 340 @write_back.setter 341 def write_back(self, write_back): 342 """Sets the write_back of this MergeField. 343 344 When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. # noqa: E501 345 346 :param write_back: The write_back of this MergeField. # noqa: E501 347 :type: str 348 """ 349 350 self._write_back = write_back 351 352 @property 353 def write_back_metadata(self): 354 """Gets the write_back_metadata of this MergeField. # noqa: E501 355 356 Metadata that indicates if the sender can edit the `writeBack` property. # noqa: E501 357 358 :return: The write_back_metadata of this MergeField. # noqa: E501 359 :rtype: PropertyMetadata 360 """ 361 return self._write_back_metadata 362 363 @write_back_metadata.setter 364 def write_back_metadata(self, write_back_metadata): 365 """Sets the write_back_metadata of this MergeField. 366 367 Metadata that indicates if the sender can edit the `writeBack` property. # noqa: E501 368 369 :param write_back_metadata: The write_back_metadata of this MergeField. # noqa: E501 370 :type: PropertyMetadata 371 """ 372 373 self._write_back_metadata = write_back_metadata 374 375 def to_dict(self): 376 """Returns the model properties as a dict""" 377 result = {} 378 379 for attr, _ in six.iteritems(self.swagger_types): 380 value = getattr(self, attr) 381 if isinstance(value, list): 382 result[attr] = list(map( 383 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 384 value 385 )) 386 elif hasattr(value, "to_dict"): 387 result[attr] = value.to_dict() 388 elif isinstance(value, dict): 389 result[attr] = dict(map( 390 lambda item: (item[0], item[1].to_dict()) 391 if hasattr(item[1], "to_dict") else item, 392 value.items() 393 )) 394 else: 395 result[attr] = value 396 if issubclass(MergeField, dict): 397 for key, value in self.items(): 398 result[key] = value 399 400 return result 401 402 def to_str(self): 403 """Returns the string representation of the model""" 404 return pprint.pformat(self.to_dict()) 405 406 def __repr__(self): 407 """For `print` and `pprint`""" 408 return self.to_str() 409 410 def __eq__(self, other): 411 """Returns true if both objects are equal""" 412 if not isinstance(other, MergeField): 413 return False 414 415 return self.to_dict() == other.to_dict() 416 417 def __ne__(self, other): 418 """Returns true if both objects are not equal""" 419 if not isinstance(other, MergeField): 420 return True 421 422 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
MergeField(_configuration=None, **kwargs)
66 def __init__(self, _configuration=None, **kwargs): # noqa: E501 67 """MergeField - a model defined in Swagger""" # noqa: E501 68 if _configuration is None: 69 _configuration = Configuration() 70 self._configuration = _configuration 71 72 self._allow_sender_to_edit = None 73 self._allow_sender_to_edit_metadata = None 74 self._configuration_type = None 75 self._configuration_type_metadata = None 76 self._path = None 77 self._path_extended = None 78 self._path_extended_metadata = None 79 self._path_metadata = None 80 self._row = None 81 self._row_metadata = None 82 self._write_back = None 83 self._write_back_metadata = None 84 self.discriminator = None 85 86 setattr(self, "_{}".format('allow_sender_to_edit'), kwargs.get('allow_sender_to_edit', None)) 87 setattr(self, "_{}".format('allow_sender_to_edit_metadata'), kwargs.get('allow_sender_to_edit_metadata', None)) 88 setattr(self, "_{}".format('configuration_type'), kwargs.get('configuration_type', None)) 89 setattr(self, "_{}".format('configuration_type_metadata'), kwargs.get('configuration_type_metadata', None)) 90 setattr(self, "_{}".format('path'), kwargs.get('path', None)) 91 setattr(self, "_{}".format('path_extended'), kwargs.get('path_extended', None)) 92 setattr(self, "_{}".format('path_extended_metadata'), kwargs.get('path_extended_metadata', None)) 93 setattr(self, "_{}".format('path_metadata'), kwargs.get('path_metadata', None)) 94 setattr(self, "_{}".format('row'), kwargs.get('row', None)) 95 setattr(self, "_{}".format('row_metadata'), kwargs.get('row_metadata', None)) 96 setattr(self, "_{}".format('write_back'), kwargs.get('write_back', None)) 97 setattr(self, "_{}".format('write_back_metadata'), kwargs.get('write_back_metadata', None))
MergeField - a model defined in Swagger
swagger_types = {'allow_sender_to_edit': 'str', 'allow_sender_to_edit_metadata': 'PropertyMetadata', 'configuration_type': 'str', 'configuration_type_metadata': 'PropertyMetadata', 'path': 'str', 'path_extended': 'list[PathExtendedElement]', 'path_extended_metadata': 'PropertyMetadata', 'path_metadata': 'PropertyMetadata', 'row': 'str', 'row_metadata': 'PropertyMetadata', 'write_back': 'str', 'write_back_metadata': 'PropertyMetadata'}
attribute_map = {'allow_sender_to_edit': 'allowSenderToEdit', 'allow_sender_to_edit_metadata': 'allowSenderToEditMetadata', 'configuration_type': 'configurationType', 'configuration_type_metadata': 'configurationTypeMetadata', 'path': 'path', 'path_extended': 'pathExtended', 'path_extended_metadata': 'pathExtendedMetadata', 'path_metadata': 'pathMetadata', 'row': 'row', 'row_metadata': 'rowMetadata', 'write_back': 'writeBack', 'write_back_metadata': 'writeBackMetadata'}
allow_sender_to_edit
Gets the allow_sender_to_edit of this MergeField. # noqa: E501
When set to true, the sender can modify the value of the custom tab during the sending process. # noqa: E501
Returns
The allow_sender_to_edit of this MergeField. # noqa: E501
allow_sender_to_edit_metadata
Gets the allow_sender_to_edit_metadata of this MergeField. # noqa: E501
Metadata that indicates if the sender can edit the allowSenderToEdit property. # noqa: E501
Returns
The allow_sender_to_edit_metadata of this MergeField. # noqa: E501
configuration_type
Gets the configuration_type of this MergeField. # noqa: E501
If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce. # noqa: E501
Returns
The configuration_type of this MergeField. # noqa: E501
configuration_type_metadata
Gets the configuration_type_metadata of this MergeField. # noqa: E501
Metadata that indicates if the sender can edit the configurationType property. # noqa: E501
Returns
The configuration_type_metadata of this MergeField. # noqa: E501
path
Gets the path of this MergeField. # noqa: E501
Sets the object associated with the custom tab. Currently this is the Salesforce Object. # noqa: E501
Returns
The path of this MergeField. # noqa: E501
path_extended
Gets the path_extended of this MergeField. # noqa: E501
# noqa: E501
Returns
The path_extended of this MergeField. # noqa: E501
path_extended_metadata
Gets the path_extended_metadata of this MergeField. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The path_extended_metadata of this MergeField. # noqa: E501
path_metadata
Gets the path_metadata of this MergeField. # noqa: E501
Metadata that indicates whether the path property is editable. # noqa: E501
Returns
The path_metadata of this MergeField. # noqa: E501
row
Gets the row of this MergeField. # noqa: E501
Specifies the row number in a Salesforce table that the merge field value corresponds to. # noqa: E501
Returns
The row of this MergeField. # noqa: E501
row_metadata
Gets the row_metadata of this MergeField. # noqa: E501
Metadata that indicates whether the row property is editable. # noqa: E501
Returns
The row_metadata of this MergeField. # noqa: E501
write_back
Gets the write_back of this MergeField. # noqa: E501
When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. # noqa: E501
Returns
The write_back of this MergeField. # noqa: E501
write_back_metadata
Gets the write_back_metadata of this MergeField. # noqa: E501
Metadata that indicates if the sender can edit the writeBack property. # noqa: E501
Returns
The write_back_metadata of this MergeField. # noqa: E501
def
to_dict(self)
375 def to_dict(self): 376 """Returns the model properties as a dict""" 377 result = {} 378 379 for attr, _ in six.iteritems(self.swagger_types): 380 value = getattr(self, attr) 381 if isinstance(value, list): 382 result[attr] = list(map( 383 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 384 value 385 )) 386 elif hasattr(value, "to_dict"): 387 result[attr] = value.to_dict() 388 elif isinstance(value, dict): 389 result[attr] = dict(map( 390 lambda item: (item[0], item[1].to_dict()) 391 if hasattr(item[1], "to_dict") else item, 392 value.items() 393 )) 394 else: 395 result[attr] = value 396 if issubclass(MergeField, dict): 397 for key, value in self.items(): 398 result[key] = value 399 400 return result
Returns the model properties as a dict