Source code for worldline.connect.sdk.v1.domain.seller
# -*- coding: utf-8 -*-
#
# This class was auto-generated from the API references found at
# https://apireference.connect.worldline-solutions.com/
#
from worldline.connect.sdk.domain.data_object import DataObject
from worldline.connect.sdk.v1.domain.address import Address
[docs]class Seller(DataObject):
__address = None
__channel_code = None
__description = None
__external_reference_id = None
__geocode = None
__id = None
__invoice_number = None
__is_foreign_retailer = None
__mcc = None
__name = None
__phone_number = None
__type = None
@property
def address(self):
"""
| Object containing the seller address details
Type: :class:`worldline.connect.sdk.v1.domain.address.Address`
"""
return self.__address
@address.setter
def address(self, value):
self.__address = value
@property
def channel_code(self):
"""
| This property is specific to Visa Argentina. Channelcode according to Prisma. Please contact the acquirer to get the full list you need to use.
Type: str
"""
return self.__channel_code
@channel_code.setter
def channel_code(self, value):
self.__channel_code = value
@property
def description(self):
"""
| Description of the seller
Type: str
"""
return self.__description
@description.setter
def description(self, value):
self.__description = value
@property
def external_reference_id(self):
"""
| Seller ID assigned by the Merchant Aggregator
Type: str
"""
return self.__external_reference_id
@external_reference_id.setter
def external_reference_id(self, value):
self.__external_reference_id = value
@property
def geocode(self):
"""
| The sellers geocode
Type: str
"""
return self.__geocode
@geocode.setter
def geocode(self, value):
self.__geocode = value
@property
def id(self):
"""
| The sellers identifier
Type: str
"""
return self.__id
@id.setter
def id(self, value):
self.__id = value
@property
def invoice_number(self):
"""
| Invoice number of the payment
Type: str
"""
return self.__invoice_number
@invoice_number.setter
def invoice_number(self, value):
self.__invoice_number = value
@property
def is_foreign_retailer(self):
"""
| Indicates if the retailer is considered foreign or domestic when compared to the location of the marketplace. Possible values:
* true - The retailer is considered foreign because they are located in a different country than the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the marketplace is within the EEA and UK (and Gibraltar), but the retailer is located outside of the EEA and UK (and Gibraltar)
* false - The retailer is considered domestic because they are located in the same country as the marketplace. For marketplaces located in the European Economic Area (EEA) and UK (and Gibraltar), this includes transactions where the retailer is also located within the EEA and UK (and Gibraltar).
Type: bool
"""
return self.__is_foreign_retailer
@is_foreign_retailer.setter
def is_foreign_retailer(self, value):
self.__is_foreign_retailer = value
@property
def mcc(self):
"""
| Merchant category code
Type: str
"""
return self.__mcc
@mcc.setter
def mcc(self, value):
self.__mcc = value
@property
def name(self):
"""
| Name of the seller
Type: str
"""
return self.__name
@name.setter
def name(self, value):
self.__name = value
@property
def phone_number(self):
"""
| Main Phone Number
Type: str
"""
return self.__phone_number
@phone_number.setter
def phone_number(self, value):
self.__phone_number = value
@property
def type(self):
"""
| Seller type. Possible values:
* passport
* dni
* arg-identity-card
* civic-notebook
* enrollment-book
* cuil
* cuit
* general-register
* election-title
* cpf
* cnpj
* ssn
* citizen-ship
* col-identity-card
* alien-registration
Type: str
"""
return self.__type
@type.setter
def type(self, value):
self.__type = value
[docs] def to_dictionary(self):
dictionary = super(Seller, self).to_dictionary()
if self.address is not None:
dictionary['address'] = self.address.to_dictionary()
if self.channel_code is not None:
dictionary['channelCode'] = self.channel_code
if self.description is not None:
dictionary['description'] = self.description
if self.external_reference_id is not None:
dictionary['externalReferenceId'] = self.external_reference_id
if self.geocode is not None:
dictionary['geocode'] = self.geocode
if self.id is not None:
dictionary['id'] = self.id
if self.invoice_number is not None:
dictionary['invoiceNumber'] = self.invoice_number
if self.is_foreign_retailer is not None:
dictionary['isForeignRetailer'] = self.is_foreign_retailer
if self.mcc is not None:
dictionary['mcc'] = self.mcc
if self.name is not None:
dictionary['name'] = self.name
if self.phone_number is not None:
dictionary['phoneNumber'] = self.phone_number
if self.type is not None:
dictionary['type'] = self.type
return dictionary
[docs] def from_dictionary(self, dictionary):
super(Seller, self).from_dictionary(dictionary)
if 'address' in dictionary:
if not isinstance(dictionary['address'], dict):
raise TypeError('value \'{}\' is not a dictionary'.format(dictionary['address']))
value = Address()
self.address = value.from_dictionary(dictionary['address'])
if 'channelCode' in dictionary:
self.channel_code = dictionary['channelCode']
if 'description' in dictionary:
self.description = dictionary['description']
if 'externalReferenceId' in dictionary:
self.external_reference_id = dictionary['externalReferenceId']
if 'geocode' in dictionary:
self.geocode = dictionary['geocode']
if 'id' in dictionary:
self.id = dictionary['id']
if 'invoiceNumber' in dictionary:
self.invoice_number = dictionary['invoiceNumber']
if 'isForeignRetailer' in dictionary:
self.is_foreign_retailer = dictionary['isForeignRetailer']
if 'mcc' in dictionary:
self.mcc = dictionary['mcc']
if 'name' in dictionary:
self.name = dictionary['name']
if 'phoneNumber' in dictionary:
self.phone_number = dictionary['phoneNumber']
if 'type' in dictionary:
self.type = dictionary['type']
return self