docusign_esign.models.payment_details
DocuSign REST API
The DocuSign 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 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 PaymentDetails(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 'allowed_payment_methods': 'list[str]', 37 'charge_id': 'str', 38 'currency_code': 'str', 39 'currency_code_metadata': 'PropertyMetadata', 40 'customer_id': 'str', 41 'custom_metadata': 'str', 42 'custom_metadata_required': 'bool', 43 'gateway_account_id': 'str', 44 'gateway_account_id_metadata': 'PropertyMetadata', 45 'gateway_display_name': 'str', 46 'gateway_name': 'str', 47 'line_items': 'list[PaymentLineItem]', 48 'payment_option': 'str', 49 'payment_source_id': 'str', 50 'signer_values': 'PaymentSignerValues', 51 'status': 'str', 52 'sub_gateway_name': 'str', 53 'total': 'Money' 54 } 55 56 attribute_map = { 57 'allowed_payment_methods': 'allowedPaymentMethods', 58 'charge_id': 'chargeId', 59 'currency_code': 'currencyCode', 60 'currency_code_metadata': 'currencyCodeMetadata', 61 'customer_id': 'customerId', 62 'custom_metadata': 'customMetadata', 63 'custom_metadata_required': 'customMetadataRequired', 64 'gateway_account_id': 'gatewayAccountId', 65 'gateway_account_id_metadata': 'gatewayAccountIdMetadata', 66 'gateway_display_name': 'gatewayDisplayName', 67 'gateway_name': 'gatewayName', 68 'line_items': 'lineItems', 69 'payment_option': 'paymentOption', 70 'payment_source_id': 'paymentSourceId', 71 'signer_values': 'signerValues', 72 'status': 'status', 73 'sub_gateway_name': 'subGatewayName', 74 'total': 'total' 75 } 76 77 def __init__(self, _configuration=None, **kwargs): # noqa: E501 78 """PaymentDetails - a model defined in Swagger""" # noqa: E501 79 if _configuration is None: 80 _configuration = Configuration() 81 self._configuration = _configuration 82 83 self._allowed_payment_methods = None 84 self._charge_id = None 85 self._currency_code = None 86 self._currency_code_metadata = None 87 self._customer_id = None 88 self._custom_metadata = None 89 self._custom_metadata_required = None 90 self._gateway_account_id = None 91 self._gateway_account_id_metadata = None 92 self._gateway_display_name = None 93 self._gateway_name = None 94 self._line_items = None 95 self._payment_option = None 96 self._payment_source_id = None 97 self._signer_values = None 98 self._status = None 99 self._sub_gateway_name = None 100 self._total = None 101 self.discriminator = None 102 103 setattr(self, "_{}".format('allowed_payment_methods'), kwargs.get('allowed_payment_methods', None)) 104 setattr(self, "_{}".format('charge_id'), kwargs.get('charge_id', None)) 105 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 106 setattr(self, "_{}".format('currency_code_metadata'), kwargs.get('currency_code_metadata', None)) 107 setattr(self, "_{}".format('customer_id'), kwargs.get('customer_id', None)) 108 setattr(self, "_{}".format('custom_metadata'), kwargs.get('custom_metadata', None)) 109 setattr(self, "_{}".format('custom_metadata_required'), kwargs.get('custom_metadata_required', None)) 110 setattr(self, "_{}".format('gateway_account_id'), kwargs.get('gateway_account_id', None)) 111 setattr(self, "_{}".format('gateway_account_id_metadata'), kwargs.get('gateway_account_id_metadata', None)) 112 setattr(self, "_{}".format('gateway_display_name'), kwargs.get('gateway_display_name', None)) 113 setattr(self, "_{}".format('gateway_name'), kwargs.get('gateway_name', None)) 114 setattr(self, "_{}".format('line_items'), kwargs.get('line_items', None)) 115 setattr(self, "_{}".format('payment_option'), kwargs.get('payment_option', None)) 116 setattr(self, "_{}".format('payment_source_id'), kwargs.get('payment_source_id', None)) 117 setattr(self, "_{}".format('signer_values'), kwargs.get('signer_values', None)) 118 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 119 setattr(self, "_{}".format('sub_gateway_name'), kwargs.get('sub_gateway_name', None)) 120 setattr(self, "_{}".format('total'), kwargs.get('total', None)) 121 122 @property 123 def allowed_payment_methods(self): 124 """Gets the allowed_payment_methods of this PaymentDetails. # noqa: E501 125 126 # noqa: E501 127 128 :return: The allowed_payment_methods of this PaymentDetails. # noqa: E501 129 :rtype: list[str] 130 """ 131 return self._allowed_payment_methods 132 133 @allowed_payment_methods.setter 134 def allowed_payment_methods(self, allowed_payment_methods): 135 """Sets the allowed_payment_methods of this PaymentDetails. 136 137 # noqa: E501 138 139 :param allowed_payment_methods: The allowed_payment_methods of this PaymentDetails. # noqa: E501 140 :type: list[str] 141 """ 142 143 self._allowed_payment_methods = allowed_payment_methods 144 145 @property 146 def charge_id(self): 147 """Gets the charge_id of this PaymentDetails. # noqa: E501 148 149 # noqa: E501 150 151 :return: The charge_id of this PaymentDetails. # noqa: E501 152 :rtype: str 153 """ 154 return self._charge_id 155 156 @charge_id.setter 157 def charge_id(self, charge_id): 158 """Sets the charge_id of this PaymentDetails. 159 160 # noqa: E501 161 162 :param charge_id: The charge_id of this PaymentDetails. # noqa: E501 163 :type: str 164 """ 165 166 self._charge_id = charge_id 167 168 @property 169 def currency_code(self): 170 """Gets the currency_code of this PaymentDetails. # noqa: E501 171 172 # noqa: E501 173 174 :return: The currency_code of this PaymentDetails. # noqa: E501 175 :rtype: str 176 """ 177 return self._currency_code 178 179 @currency_code.setter 180 def currency_code(self, currency_code): 181 """Sets the currency_code of this PaymentDetails. 182 183 # noqa: E501 184 185 :param currency_code: The currency_code of this PaymentDetails. # noqa: E501 186 :type: str 187 """ 188 189 self._currency_code = currency_code 190 191 @property 192 def currency_code_metadata(self): 193 """Gets the currency_code_metadata of this PaymentDetails. # noqa: E501 194 195 Metadata that indicates whether the `currencyCode` property is editable. # noqa: E501 196 197 :return: The currency_code_metadata of this PaymentDetails. # noqa: E501 198 :rtype: PropertyMetadata 199 """ 200 return self._currency_code_metadata 201 202 @currency_code_metadata.setter 203 def currency_code_metadata(self, currency_code_metadata): 204 """Sets the currency_code_metadata of this PaymentDetails. 205 206 Metadata that indicates whether the `currencyCode` property is editable. # noqa: E501 207 208 :param currency_code_metadata: The currency_code_metadata of this PaymentDetails. # noqa: E501 209 :type: PropertyMetadata 210 """ 211 212 self._currency_code_metadata = currency_code_metadata 213 214 @property 215 def customer_id(self): 216 """Gets the customer_id of this PaymentDetails. # noqa: E501 217 218 # noqa: E501 219 220 :return: The customer_id of this PaymentDetails. # noqa: E501 221 :rtype: str 222 """ 223 return self._customer_id 224 225 @customer_id.setter 226 def customer_id(self, customer_id): 227 """Sets the customer_id of this PaymentDetails. 228 229 # noqa: E501 230 231 :param customer_id: The customer_id of this PaymentDetails. # noqa: E501 232 :type: str 233 """ 234 235 self._customer_id = customer_id 236 237 @property 238 def custom_metadata(self): 239 """Gets the custom_metadata of this PaymentDetails. # noqa: E501 240 241 # noqa: E501 242 243 :return: The custom_metadata of this PaymentDetails. # noqa: E501 244 :rtype: str 245 """ 246 return self._custom_metadata 247 248 @custom_metadata.setter 249 def custom_metadata(self, custom_metadata): 250 """Sets the custom_metadata of this PaymentDetails. 251 252 # noqa: E501 253 254 :param custom_metadata: The custom_metadata of this PaymentDetails. # noqa: E501 255 :type: str 256 """ 257 258 self._custom_metadata = custom_metadata 259 260 @property 261 def custom_metadata_required(self): 262 """Gets the custom_metadata_required of this PaymentDetails. # noqa: E501 263 264 # noqa: E501 265 266 :return: The custom_metadata_required of this PaymentDetails. # noqa: E501 267 :rtype: bool 268 """ 269 return self._custom_metadata_required 270 271 @custom_metadata_required.setter 272 def custom_metadata_required(self, custom_metadata_required): 273 """Sets the custom_metadata_required of this PaymentDetails. 274 275 # noqa: E501 276 277 :param custom_metadata_required: The custom_metadata_required of this PaymentDetails. # noqa: E501 278 :type: bool 279 """ 280 281 self._custom_metadata_required = custom_metadata_required 282 283 @property 284 def gateway_account_id(self): 285 """Gets the gateway_account_id of this PaymentDetails. # noqa: E501 286 287 # noqa: E501 288 289 :return: The gateway_account_id of this PaymentDetails. # noqa: E501 290 :rtype: str 291 """ 292 return self._gateway_account_id 293 294 @gateway_account_id.setter 295 def gateway_account_id(self, gateway_account_id): 296 """Sets the gateway_account_id of this PaymentDetails. 297 298 # noqa: E501 299 300 :param gateway_account_id: The gateway_account_id of this PaymentDetails. # noqa: E501 301 :type: str 302 """ 303 304 self._gateway_account_id = gateway_account_id 305 306 @property 307 def gateway_account_id_metadata(self): 308 """Gets the gateway_account_id_metadata of this PaymentDetails. # noqa: E501 309 310 Metadata that indicates whether the `gatewayAccountId` property is editable. # noqa: E501 311 312 :return: The gateway_account_id_metadata of this PaymentDetails. # noqa: E501 313 :rtype: PropertyMetadata 314 """ 315 return self._gateway_account_id_metadata 316 317 @gateway_account_id_metadata.setter 318 def gateway_account_id_metadata(self, gateway_account_id_metadata): 319 """Sets the gateway_account_id_metadata of this PaymentDetails. 320 321 Metadata that indicates whether the `gatewayAccountId` property is editable. # noqa: E501 322 323 :param gateway_account_id_metadata: The gateway_account_id_metadata of this PaymentDetails. # noqa: E501 324 :type: PropertyMetadata 325 """ 326 327 self._gateway_account_id_metadata = gateway_account_id_metadata 328 329 @property 330 def gateway_display_name(self): 331 """Gets the gateway_display_name of this PaymentDetails. # noqa: E501 332 333 # noqa: E501 334 335 :return: The gateway_display_name of this PaymentDetails. # noqa: E501 336 :rtype: str 337 """ 338 return self._gateway_display_name 339 340 @gateway_display_name.setter 341 def gateway_display_name(self, gateway_display_name): 342 """Sets the gateway_display_name of this PaymentDetails. 343 344 # noqa: E501 345 346 :param gateway_display_name: The gateway_display_name of this PaymentDetails. # noqa: E501 347 :type: str 348 """ 349 350 self._gateway_display_name = gateway_display_name 351 352 @property 353 def gateway_name(self): 354 """Gets the gateway_name of this PaymentDetails. # noqa: E501 355 356 # noqa: E501 357 358 :return: The gateway_name of this PaymentDetails. # noqa: E501 359 :rtype: str 360 """ 361 return self._gateway_name 362 363 @gateway_name.setter 364 def gateway_name(self, gateway_name): 365 """Sets the gateway_name of this PaymentDetails. 366 367 # noqa: E501 368 369 :param gateway_name: The gateway_name of this PaymentDetails. # noqa: E501 370 :type: str 371 """ 372 373 self._gateway_name = gateway_name 374 375 @property 376 def line_items(self): 377 """Gets the line_items of this PaymentDetails. # noqa: E501 378 379 # noqa: E501 380 381 :return: The line_items of this PaymentDetails. # noqa: E501 382 :rtype: list[PaymentLineItem] 383 """ 384 return self._line_items 385 386 @line_items.setter 387 def line_items(self, line_items): 388 """Sets the line_items of this PaymentDetails. 389 390 # noqa: E501 391 392 :param line_items: The line_items of this PaymentDetails. # noqa: E501 393 :type: list[PaymentLineItem] 394 """ 395 396 self._line_items = line_items 397 398 @property 399 def payment_option(self): 400 """Gets the payment_option of this PaymentDetails. # noqa: E501 401 402 # noqa: E501 403 404 :return: The payment_option of this PaymentDetails. # noqa: E501 405 :rtype: str 406 """ 407 return self._payment_option 408 409 @payment_option.setter 410 def payment_option(self, payment_option): 411 """Sets the payment_option of this PaymentDetails. 412 413 # noqa: E501 414 415 :param payment_option: The payment_option of this PaymentDetails. # noqa: E501 416 :type: str 417 """ 418 419 self._payment_option = payment_option 420 421 @property 422 def payment_source_id(self): 423 """Gets the payment_source_id of this PaymentDetails. # noqa: E501 424 425 # noqa: E501 426 427 :return: The payment_source_id of this PaymentDetails. # noqa: E501 428 :rtype: str 429 """ 430 return self._payment_source_id 431 432 @payment_source_id.setter 433 def payment_source_id(self, payment_source_id): 434 """Sets the payment_source_id of this PaymentDetails. 435 436 # noqa: E501 437 438 :param payment_source_id: The payment_source_id of this PaymentDetails. # noqa: E501 439 :type: str 440 """ 441 442 self._payment_source_id = payment_source_id 443 444 @property 445 def signer_values(self): 446 """Gets the signer_values of this PaymentDetails. # noqa: E501 447 448 # noqa: E501 449 450 :return: The signer_values of this PaymentDetails. # noqa: E501 451 :rtype: PaymentSignerValues 452 """ 453 return self._signer_values 454 455 @signer_values.setter 456 def signer_values(self, signer_values): 457 """Sets the signer_values of this PaymentDetails. 458 459 # noqa: E501 460 461 :param signer_values: The signer_values of this PaymentDetails. # noqa: E501 462 :type: PaymentSignerValues 463 """ 464 465 self._signer_values = signer_values 466 467 @property 468 def status(self): 469 """Gets the status of this PaymentDetails. # noqa: E501 470 471 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 472 473 :return: The status of this PaymentDetails. # noqa: E501 474 :rtype: str 475 """ 476 return self._status 477 478 @status.setter 479 def status(self, status): 480 """Sets the status of this PaymentDetails. 481 482 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 483 484 :param status: The status of this PaymentDetails. # noqa: E501 485 :type: str 486 """ 487 488 self._status = status 489 490 @property 491 def sub_gateway_name(self): 492 """Gets the sub_gateway_name of this PaymentDetails. # noqa: E501 493 494 # noqa: E501 495 496 :return: The sub_gateway_name of this PaymentDetails. # noqa: E501 497 :rtype: str 498 """ 499 return self._sub_gateway_name 500 501 @sub_gateway_name.setter 502 def sub_gateway_name(self, sub_gateway_name): 503 """Sets the sub_gateway_name of this PaymentDetails. 504 505 # noqa: E501 506 507 :param sub_gateway_name: The sub_gateway_name of this PaymentDetails. # noqa: E501 508 :type: str 509 """ 510 511 self._sub_gateway_name = sub_gateway_name 512 513 @property 514 def total(self): 515 """Gets the total of this PaymentDetails. # noqa: E501 516 517 This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. # noqa: E501 518 519 :return: The total of this PaymentDetails. # noqa: E501 520 :rtype: Money 521 """ 522 return self._total 523 524 @total.setter 525 def total(self, total): 526 """Sets the total of this PaymentDetails. 527 528 This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. # noqa: E501 529 530 :param total: The total of this PaymentDetails. # noqa: E501 531 :type: Money 532 """ 533 534 self._total = total 535 536 def to_dict(self): 537 """Returns the model properties as a dict""" 538 result = {} 539 540 for attr, _ in six.iteritems(self.swagger_types): 541 value = getattr(self, attr) 542 if isinstance(value, list): 543 result[attr] = list(map( 544 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 545 value 546 )) 547 elif hasattr(value, "to_dict"): 548 result[attr] = value.to_dict() 549 elif isinstance(value, dict): 550 result[attr] = dict(map( 551 lambda item: (item[0], item[1].to_dict()) 552 if hasattr(item[1], "to_dict") else item, 553 value.items() 554 )) 555 else: 556 result[attr] = value 557 if issubclass(PaymentDetails, dict): 558 for key, value in self.items(): 559 result[key] = value 560 561 return result 562 563 def to_str(self): 564 """Returns the string representation of the model""" 565 return pprint.pformat(self.to_dict()) 566 567 def __repr__(self): 568 """For `print` and `pprint`""" 569 return self.to_str() 570 571 def __eq__(self, other): 572 """Returns true if both objects are equal""" 573 if not isinstance(other, PaymentDetails): 574 return False 575 576 return self.to_dict() == other.to_dict() 577 578 def __ne__(self, other): 579 """Returns true if both objects are not equal""" 580 if not isinstance(other, PaymentDetails): 581 return True 582 583 return self.to_dict() != other.to_dict()
class
PaymentDetails:
23class PaymentDetails(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 'allowed_payment_methods': 'list[str]', 38 'charge_id': 'str', 39 'currency_code': 'str', 40 'currency_code_metadata': 'PropertyMetadata', 41 'customer_id': 'str', 42 'custom_metadata': 'str', 43 'custom_metadata_required': 'bool', 44 'gateway_account_id': 'str', 45 'gateway_account_id_metadata': 'PropertyMetadata', 46 'gateway_display_name': 'str', 47 'gateway_name': 'str', 48 'line_items': 'list[PaymentLineItem]', 49 'payment_option': 'str', 50 'payment_source_id': 'str', 51 'signer_values': 'PaymentSignerValues', 52 'status': 'str', 53 'sub_gateway_name': 'str', 54 'total': 'Money' 55 } 56 57 attribute_map = { 58 'allowed_payment_methods': 'allowedPaymentMethods', 59 'charge_id': 'chargeId', 60 'currency_code': 'currencyCode', 61 'currency_code_metadata': 'currencyCodeMetadata', 62 'customer_id': 'customerId', 63 'custom_metadata': 'customMetadata', 64 'custom_metadata_required': 'customMetadataRequired', 65 'gateway_account_id': 'gatewayAccountId', 66 'gateway_account_id_metadata': 'gatewayAccountIdMetadata', 67 'gateway_display_name': 'gatewayDisplayName', 68 'gateway_name': 'gatewayName', 69 'line_items': 'lineItems', 70 'payment_option': 'paymentOption', 71 'payment_source_id': 'paymentSourceId', 72 'signer_values': 'signerValues', 73 'status': 'status', 74 'sub_gateway_name': 'subGatewayName', 75 'total': 'total' 76 } 77 78 def __init__(self, _configuration=None, **kwargs): # noqa: E501 79 """PaymentDetails - a model defined in Swagger""" # noqa: E501 80 if _configuration is None: 81 _configuration = Configuration() 82 self._configuration = _configuration 83 84 self._allowed_payment_methods = None 85 self._charge_id = None 86 self._currency_code = None 87 self._currency_code_metadata = None 88 self._customer_id = None 89 self._custom_metadata = None 90 self._custom_metadata_required = None 91 self._gateway_account_id = None 92 self._gateway_account_id_metadata = None 93 self._gateway_display_name = None 94 self._gateway_name = None 95 self._line_items = None 96 self._payment_option = None 97 self._payment_source_id = None 98 self._signer_values = None 99 self._status = None 100 self._sub_gateway_name = None 101 self._total = None 102 self.discriminator = None 103 104 setattr(self, "_{}".format('allowed_payment_methods'), kwargs.get('allowed_payment_methods', None)) 105 setattr(self, "_{}".format('charge_id'), kwargs.get('charge_id', None)) 106 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 107 setattr(self, "_{}".format('currency_code_metadata'), kwargs.get('currency_code_metadata', None)) 108 setattr(self, "_{}".format('customer_id'), kwargs.get('customer_id', None)) 109 setattr(self, "_{}".format('custom_metadata'), kwargs.get('custom_metadata', None)) 110 setattr(self, "_{}".format('custom_metadata_required'), kwargs.get('custom_metadata_required', None)) 111 setattr(self, "_{}".format('gateway_account_id'), kwargs.get('gateway_account_id', None)) 112 setattr(self, "_{}".format('gateway_account_id_metadata'), kwargs.get('gateway_account_id_metadata', None)) 113 setattr(self, "_{}".format('gateway_display_name'), kwargs.get('gateway_display_name', None)) 114 setattr(self, "_{}".format('gateway_name'), kwargs.get('gateway_name', None)) 115 setattr(self, "_{}".format('line_items'), kwargs.get('line_items', None)) 116 setattr(self, "_{}".format('payment_option'), kwargs.get('payment_option', None)) 117 setattr(self, "_{}".format('payment_source_id'), kwargs.get('payment_source_id', None)) 118 setattr(self, "_{}".format('signer_values'), kwargs.get('signer_values', None)) 119 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 120 setattr(self, "_{}".format('sub_gateway_name'), kwargs.get('sub_gateway_name', None)) 121 setattr(self, "_{}".format('total'), kwargs.get('total', None)) 122 123 @property 124 def allowed_payment_methods(self): 125 """Gets the allowed_payment_methods of this PaymentDetails. # noqa: E501 126 127 # noqa: E501 128 129 :return: The allowed_payment_methods of this PaymentDetails. # noqa: E501 130 :rtype: list[str] 131 """ 132 return self._allowed_payment_methods 133 134 @allowed_payment_methods.setter 135 def allowed_payment_methods(self, allowed_payment_methods): 136 """Sets the allowed_payment_methods of this PaymentDetails. 137 138 # noqa: E501 139 140 :param allowed_payment_methods: The allowed_payment_methods of this PaymentDetails. # noqa: E501 141 :type: list[str] 142 """ 143 144 self._allowed_payment_methods = allowed_payment_methods 145 146 @property 147 def charge_id(self): 148 """Gets the charge_id of this PaymentDetails. # noqa: E501 149 150 # noqa: E501 151 152 :return: The charge_id of this PaymentDetails. # noqa: E501 153 :rtype: str 154 """ 155 return self._charge_id 156 157 @charge_id.setter 158 def charge_id(self, charge_id): 159 """Sets the charge_id of this PaymentDetails. 160 161 # noqa: E501 162 163 :param charge_id: The charge_id of this PaymentDetails. # noqa: E501 164 :type: str 165 """ 166 167 self._charge_id = charge_id 168 169 @property 170 def currency_code(self): 171 """Gets the currency_code of this PaymentDetails. # noqa: E501 172 173 # noqa: E501 174 175 :return: The currency_code of this PaymentDetails. # noqa: E501 176 :rtype: str 177 """ 178 return self._currency_code 179 180 @currency_code.setter 181 def currency_code(self, currency_code): 182 """Sets the currency_code of this PaymentDetails. 183 184 # noqa: E501 185 186 :param currency_code: The currency_code of this PaymentDetails. # noqa: E501 187 :type: str 188 """ 189 190 self._currency_code = currency_code 191 192 @property 193 def currency_code_metadata(self): 194 """Gets the currency_code_metadata of this PaymentDetails. # noqa: E501 195 196 Metadata that indicates whether the `currencyCode` property is editable. # noqa: E501 197 198 :return: The currency_code_metadata of this PaymentDetails. # noqa: E501 199 :rtype: PropertyMetadata 200 """ 201 return self._currency_code_metadata 202 203 @currency_code_metadata.setter 204 def currency_code_metadata(self, currency_code_metadata): 205 """Sets the currency_code_metadata of this PaymentDetails. 206 207 Metadata that indicates whether the `currencyCode` property is editable. # noqa: E501 208 209 :param currency_code_metadata: The currency_code_metadata of this PaymentDetails. # noqa: E501 210 :type: PropertyMetadata 211 """ 212 213 self._currency_code_metadata = currency_code_metadata 214 215 @property 216 def customer_id(self): 217 """Gets the customer_id of this PaymentDetails. # noqa: E501 218 219 # noqa: E501 220 221 :return: The customer_id of this PaymentDetails. # noqa: E501 222 :rtype: str 223 """ 224 return self._customer_id 225 226 @customer_id.setter 227 def customer_id(self, customer_id): 228 """Sets the customer_id of this PaymentDetails. 229 230 # noqa: E501 231 232 :param customer_id: The customer_id of this PaymentDetails. # noqa: E501 233 :type: str 234 """ 235 236 self._customer_id = customer_id 237 238 @property 239 def custom_metadata(self): 240 """Gets the custom_metadata of this PaymentDetails. # noqa: E501 241 242 # noqa: E501 243 244 :return: The custom_metadata of this PaymentDetails. # noqa: E501 245 :rtype: str 246 """ 247 return self._custom_metadata 248 249 @custom_metadata.setter 250 def custom_metadata(self, custom_metadata): 251 """Sets the custom_metadata of this PaymentDetails. 252 253 # noqa: E501 254 255 :param custom_metadata: The custom_metadata of this PaymentDetails. # noqa: E501 256 :type: str 257 """ 258 259 self._custom_metadata = custom_metadata 260 261 @property 262 def custom_metadata_required(self): 263 """Gets the custom_metadata_required of this PaymentDetails. # noqa: E501 264 265 # noqa: E501 266 267 :return: The custom_metadata_required of this PaymentDetails. # noqa: E501 268 :rtype: bool 269 """ 270 return self._custom_metadata_required 271 272 @custom_metadata_required.setter 273 def custom_metadata_required(self, custom_metadata_required): 274 """Sets the custom_metadata_required of this PaymentDetails. 275 276 # noqa: E501 277 278 :param custom_metadata_required: The custom_metadata_required of this PaymentDetails. # noqa: E501 279 :type: bool 280 """ 281 282 self._custom_metadata_required = custom_metadata_required 283 284 @property 285 def gateway_account_id(self): 286 """Gets the gateway_account_id of this PaymentDetails. # noqa: E501 287 288 # noqa: E501 289 290 :return: The gateway_account_id of this PaymentDetails. # noqa: E501 291 :rtype: str 292 """ 293 return self._gateway_account_id 294 295 @gateway_account_id.setter 296 def gateway_account_id(self, gateway_account_id): 297 """Sets the gateway_account_id of this PaymentDetails. 298 299 # noqa: E501 300 301 :param gateway_account_id: The gateway_account_id of this PaymentDetails. # noqa: E501 302 :type: str 303 """ 304 305 self._gateway_account_id = gateway_account_id 306 307 @property 308 def gateway_account_id_metadata(self): 309 """Gets the gateway_account_id_metadata of this PaymentDetails. # noqa: E501 310 311 Metadata that indicates whether the `gatewayAccountId` property is editable. # noqa: E501 312 313 :return: The gateway_account_id_metadata of this PaymentDetails. # noqa: E501 314 :rtype: PropertyMetadata 315 """ 316 return self._gateway_account_id_metadata 317 318 @gateway_account_id_metadata.setter 319 def gateway_account_id_metadata(self, gateway_account_id_metadata): 320 """Sets the gateway_account_id_metadata of this PaymentDetails. 321 322 Metadata that indicates whether the `gatewayAccountId` property is editable. # noqa: E501 323 324 :param gateway_account_id_metadata: The gateway_account_id_metadata of this PaymentDetails. # noqa: E501 325 :type: PropertyMetadata 326 """ 327 328 self._gateway_account_id_metadata = gateway_account_id_metadata 329 330 @property 331 def gateway_display_name(self): 332 """Gets the gateway_display_name of this PaymentDetails. # noqa: E501 333 334 # noqa: E501 335 336 :return: The gateway_display_name of this PaymentDetails. # noqa: E501 337 :rtype: str 338 """ 339 return self._gateway_display_name 340 341 @gateway_display_name.setter 342 def gateway_display_name(self, gateway_display_name): 343 """Sets the gateway_display_name of this PaymentDetails. 344 345 # noqa: E501 346 347 :param gateway_display_name: The gateway_display_name of this PaymentDetails. # noqa: E501 348 :type: str 349 """ 350 351 self._gateway_display_name = gateway_display_name 352 353 @property 354 def gateway_name(self): 355 """Gets the gateway_name of this PaymentDetails. # noqa: E501 356 357 # noqa: E501 358 359 :return: The gateway_name of this PaymentDetails. # noqa: E501 360 :rtype: str 361 """ 362 return self._gateway_name 363 364 @gateway_name.setter 365 def gateway_name(self, gateway_name): 366 """Sets the gateway_name of this PaymentDetails. 367 368 # noqa: E501 369 370 :param gateway_name: The gateway_name of this PaymentDetails. # noqa: E501 371 :type: str 372 """ 373 374 self._gateway_name = gateway_name 375 376 @property 377 def line_items(self): 378 """Gets the line_items of this PaymentDetails. # noqa: E501 379 380 # noqa: E501 381 382 :return: The line_items of this PaymentDetails. # noqa: E501 383 :rtype: list[PaymentLineItem] 384 """ 385 return self._line_items 386 387 @line_items.setter 388 def line_items(self, line_items): 389 """Sets the line_items of this PaymentDetails. 390 391 # noqa: E501 392 393 :param line_items: The line_items of this PaymentDetails. # noqa: E501 394 :type: list[PaymentLineItem] 395 """ 396 397 self._line_items = line_items 398 399 @property 400 def payment_option(self): 401 """Gets the payment_option of this PaymentDetails. # noqa: E501 402 403 # noqa: E501 404 405 :return: The payment_option of this PaymentDetails. # noqa: E501 406 :rtype: str 407 """ 408 return self._payment_option 409 410 @payment_option.setter 411 def payment_option(self, payment_option): 412 """Sets the payment_option of this PaymentDetails. 413 414 # noqa: E501 415 416 :param payment_option: The payment_option of this PaymentDetails. # noqa: E501 417 :type: str 418 """ 419 420 self._payment_option = payment_option 421 422 @property 423 def payment_source_id(self): 424 """Gets the payment_source_id of this PaymentDetails. # noqa: E501 425 426 # noqa: E501 427 428 :return: The payment_source_id of this PaymentDetails. # noqa: E501 429 :rtype: str 430 """ 431 return self._payment_source_id 432 433 @payment_source_id.setter 434 def payment_source_id(self, payment_source_id): 435 """Sets the payment_source_id of this PaymentDetails. 436 437 # noqa: E501 438 439 :param payment_source_id: The payment_source_id of this PaymentDetails. # noqa: E501 440 :type: str 441 """ 442 443 self._payment_source_id = payment_source_id 444 445 @property 446 def signer_values(self): 447 """Gets the signer_values of this PaymentDetails. # noqa: E501 448 449 # noqa: E501 450 451 :return: The signer_values of this PaymentDetails. # noqa: E501 452 :rtype: PaymentSignerValues 453 """ 454 return self._signer_values 455 456 @signer_values.setter 457 def signer_values(self, signer_values): 458 """Sets the signer_values of this PaymentDetails. 459 460 # noqa: E501 461 462 :param signer_values: The signer_values of this PaymentDetails. # noqa: E501 463 :type: PaymentSignerValues 464 """ 465 466 self._signer_values = signer_values 467 468 @property 469 def status(self): 470 """Gets the status of this PaymentDetails. # noqa: E501 471 472 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 473 474 :return: The status of this PaymentDetails. # noqa: E501 475 :rtype: str 476 """ 477 return self._status 478 479 @status.setter 480 def status(self, status): 481 """Sets the status of this PaymentDetails. 482 483 Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501 484 485 :param status: The status of this PaymentDetails. # noqa: E501 486 :type: str 487 """ 488 489 self._status = status 490 491 @property 492 def sub_gateway_name(self): 493 """Gets the sub_gateway_name of this PaymentDetails. # noqa: E501 494 495 # noqa: E501 496 497 :return: The sub_gateway_name of this PaymentDetails. # noqa: E501 498 :rtype: str 499 """ 500 return self._sub_gateway_name 501 502 @sub_gateway_name.setter 503 def sub_gateway_name(self, sub_gateway_name): 504 """Sets the sub_gateway_name of this PaymentDetails. 505 506 # noqa: E501 507 508 :param sub_gateway_name: The sub_gateway_name of this PaymentDetails. # noqa: E501 509 :type: str 510 """ 511 512 self._sub_gateway_name = sub_gateway_name 513 514 @property 515 def total(self): 516 """Gets the total of this PaymentDetails. # noqa: E501 517 518 This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. # noqa: E501 519 520 :return: The total of this PaymentDetails. # noqa: E501 521 :rtype: Money 522 """ 523 return self._total 524 525 @total.setter 526 def total(self, total): 527 """Sets the total of this PaymentDetails. 528 529 This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. # noqa: E501 530 531 :param total: The total of this PaymentDetails. # noqa: E501 532 :type: Money 533 """ 534 535 self._total = total 536 537 def to_dict(self): 538 """Returns the model properties as a dict""" 539 result = {} 540 541 for attr, _ in six.iteritems(self.swagger_types): 542 value = getattr(self, attr) 543 if isinstance(value, list): 544 result[attr] = list(map( 545 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 546 value 547 )) 548 elif hasattr(value, "to_dict"): 549 result[attr] = value.to_dict() 550 elif isinstance(value, dict): 551 result[attr] = dict(map( 552 lambda item: (item[0], item[1].to_dict()) 553 if hasattr(item[1], "to_dict") else item, 554 value.items() 555 )) 556 else: 557 result[attr] = value 558 if issubclass(PaymentDetails, dict): 559 for key, value in self.items(): 560 result[key] = value 561 562 return result 563 564 def to_str(self): 565 """Returns the string representation of the model""" 566 return pprint.pformat(self.to_dict()) 567 568 def __repr__(self): 569 """For `print` and `pprint`""" 570 return self.to_str() 571 572 def __eq__(self, other): 573 """Returns true if both objects are equal""" 574 if not isinstance(other, PaymentDetails): 575 return False 576 577 return self.to_dict() == other.to_dict() 578 579 def __ne__(self, other): 580 """Returns true if both objects are not equal""" 581 if not isinstance(other, PaymentDetails): 582 return True 583 584 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.
PaymentDetails(_configuration=None, **kwargs)
78 def __init__(self, _configuration=None, **kwargs): # noqa: E501 79 """PaymentDetails - a model defined in Swagger""" # noqa: E501 80 if _configuration is None: 81 _configuration = Configuration() 82 self._configuration = _configuration 83 84 self._allowed_payment_methods = None 85 self._charge_id = None 86 self._currency_code = None 87 self._currency_code_metadata = None 88 self._customer_id = None 89 self._custom_metadata = None 90 self._custom_metadata_required = None 91 self._gateway_account_id = None 92 self._gateway_account_id_metadata = None 93 self._gateway_display_name = None 94 self._gateway_name = None 95 self._line_items = None 96 self._payment_option = None 97 self._payment_source_id = None 98 self._signer_values = None 99 self._status = None 100 self._sub_gateway_name = None 101 self._total = None 102 self.discriminator = None 103 104 setattr(self, "_{}".format('allowed_payment_methods'), kwargs.get('allowed_payment_methods', None)) 105 setattr(self, "_{}".format('charge_id'), kwargs.get('charge_id', None)) 106 setattr(self, "_{}".format('currency_code'), kwargs.get('currency_code', None)) 107 setattr(self, "_{}".format('currency_code_metadata'), kwargs.get('currency_code_metadata', None)) 108 setattr(self, "_{}".format('customer_id'), kwargs.get('customer_id', None)) 109 setattr(self, "_{}".format('custom_metadata'), kwargs.get('custom_metadata', None)) 110 setattr(self, "_{}".format('custom_metadata_required'), kwargs.get('custom_metadata_required', None)) 111 setattr(self, "_{}".format('gateway_account_id'), kwargs.get('gateway_account_id', None)) 112 setattr(self, "_{}".format('gateway_account_id_metadata'), kwargs.get('gateway_account_id_metadata', None)) 113 setattr(self, "_{}".format('gateway_display_name'), kwargs.get('gateway_display_name', None)) 114 setattr(self, "_{}".format('gateway_name'), kwargs.get('gateway_name', None)) 115 setattr(self, "_{}".format('line_items'), kwargs.get('line_items', None)) 116 setattr(self, "_{}".format('payment_option'), kwargs.get('payment_option', None)) 117 setattr(self, "_{}".format('payment_source_id'), kwargs.get('payment_source_id', None)) 118 setattr(self, "_{}".format('signer_values'), kwargs.get('signer_values', None)) 119 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 120 setattr(self, "_{}".format('sub_gateway_name'), kwargs.get('sub_gateway_name', None)) 121 setattr(self, "_{}".format('total'), kwargs.get('total', None))
PaymentDetails - a model defined in Swagger
swagger_types = {'allowed_payment_methods': 'list[str]', 'charge_id': 'str', 'currency_code': 'str', 'currency_code_metadata': 'PropertyMetadata', 'customer_id': 'str', 'custom_metadata': 'str', 'custom_metadata_required': 'bool', 'gateway_account_id': 'str', 'gateway_account_id_metadata': 'PropertyMetadata', 'gateway_display_name': 'str', 'gateway_name': 'str', 'line_items': 'list[PaymentLineItem]', 'payment_option': 'str', 'payment_source_id': 'str', 'signer_values': 'PaymentSignerValues', 'status': 'str', 'sub_gateway_name': 'str', 'total': 'Money'}
attribute_map = {'allowed_payment_methods': 'allowedPaymentMethods', 'charge_id': 'chargeId', 'currency_code': 'currencyCode', 'currency_code_metadata': 'currencyCodeMetadata', 'customer_id': 'customerId', 'custom_metadata': 'customMetadata', 'custom_metadata_required': 'customMetadataRequired', 'gateway_account_id': 'gatewayAccountId', 'gateway_account_id_metadata': 'gatewayAccountIdMetadata', 'gateway_display_name': 'gatewayDisplayName', 'gateway_name': 'gatewayName', 'line_items': 'lineItems', 'payment_option': 'paymentOption', 'payment_source_id': 'paymentSourceId', 'signer_values': 'signerValues', 'status': 'status', 'sub_gateway_name': 'subGatewayName', 'total': 'total'}
allowed_payment_methods
Gets the allowed_payment_methods of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The allowed_payment_methods of this PaymentDetails. # noqa: E501
charge_id
Gets the charge_id of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The charge_id of this PaymentDetails. # noqa: E501
currency_code
Gets the currency_code of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The currency_code of this PaymentDetails. # noqa: E501
currency_code_metadata
Gets the currency_code_metadata of this PaymentDetails. # noqa: E501
Metadata that indicates whether the currencyCode property is editable. # noqa: E501
Returns
The currency_code_metadata of this PaymentDetails. # noqa: E501
customer_id
Gets the customer_id of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The customer_id of this PaymentDetails. # noqa: E501
custom_metadata
Gets the custom_metadata of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The custom_metadata of this PaymentDetails. # noqa: E501
custom_metadata_required
Gets the custom_metadata_required of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The custom_metadata_required of this PaymentDetails. # noqa: E501
gateway_account_id
Gets the gateway_account_id of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The gateway_account_id of this PaymentDetails. # noqa: E501
gateway_account_id_metadata
Gets the gateway_account_id_metadata of this PaymentDetails. # noqa: E501
Metadata that indicates whether the gatewayAccountId property is editable. # noqa: E501
Returns
The gateway_account_id_metadata of this PaymentDetails. # noqa: E501
gateway_display_name
Gets the gateway_display_name of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The gateway_display_name of this PaymentDetails. # noqa: E501
gateway_name
Gets the gateway_name of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The gateway_name of this PaymentDetails. # noqa: E501
line_items
Gets the line_items of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The line_items of this PaymentDetails. # noqa: E501
payment_option
Gets the payment_option of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The payment_option of this PaymentDetails. # noqa: E501
payment_source_id
Gets the payment_source_id of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The payment_source_id of this PaymentDetails. # noqa: E501
signer_values
Gets the signer_values of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The signer_values of this PaymentDetails. # noqa: E501
status
Gets the status of this PaymentDetails. # noqa: E501
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
Returns
The status of this PaymentDetails. # noqa: E501
sub_gateway_name
Gets the sub_gateway_name of this PaymentDetails. # noqa: E501
# noqa: E501
Returns
The sub_gateway_name of this PaymentDetails. # noqa: E501
total
Gets the total of this PaymentDetails. # noqa: E501
This read-only property is a currency-formatted string that represents the total of all the line items. The total is available only after the document is completed, which is when all recipients have paid and have completed all required fields. # noqa: E501
Returns
The total of this PaymentDetails. # noqa: E501
def
to_dict(self)
537 def to_dict(self): 538 """Returns the model properties as a dict""" 539 result = {} 540 541 for attr, _ in six.iteritems(self.swagger_types): 542 value = getattr(self, attr) 543 if isinstance(value, list): 544 result[attr] = list(map( 545 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 546 value 547 )) 548 elif hasattr(value, "to_dict"): 549 result[attr] = value.to_dict() 550 elif isinstance(value, dict): 551 result[attr] = dict(map( 552 lambda item: (item[0], item[1].to_dict()) 553 if hasattr(item[1], "to_dict") else item, 554 value.items() 555 )) 556 else: 557 result[attr] = value 558 if issubclass(PaymentDetails, dict): 559 for key, value in self.items(): 560 result[key] = value 561 562 return result
Returns the model properties as a dict