PUT | /profile/{BeeNumber} |
---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileUpdateResponse:
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVAddressUpdate:
first_name: Optional[str] = None
last_name: Optional[str] = None
address_line1: Optional[str] = None
address_line2: Optional[str] = None
address_line3: Optional[str] = None
address_line4: Optional[str] = None
address_line5: Optional[str] = None
city: Optional[str] = None
state_code: Optional[str] = None
postal_code: Optional[str] = None
country_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVPhoneUpdate:
number: Optional[str] = None
extension: Optional[str] = None
code_id_phone_type: Optional[str] = None
country_code: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVBankAccountUpdate:
account_name: Optional[str] = None
bank_name: Optional[str] = None
account_number: Optional[str] = None
routing_number: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVTermsUpdate:
version: Optional[str] = None
date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NAVCASLTermsUpdate:
agree: Optional[str] = None
date: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ProfileUpdate(IPut):
bee_number: Optional[Decimal] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
nickname: Optional[str] = None
birth_date: Optional[datetime.datetime] = None
billing_address: Optional[NAVAddressUpdate] = None
shipping_address: Optional[NAVAddressUpdate] = None
government_id: Optional[str] = None
email_address: Optional[str] = None
primary_phone: Optional[NAVPhoneUpdate] = None
additional_phone: Optional[NAVPhoneUpdate] = None
online_store_address: Optional[str] = None
language: Optional[str] = None
publicity_permission: Optional[str] = None
find_me_online: Optional[bool] = None
old_password: Optional[str] = None
new_password: Optional[str] = None
password_hint: Optional[str] = None
bank_account: Optional[NAVBankAccountUpdate] = None
terms_agreement: Optional[NAVTermsUpdate] = None
electronic_agreement: Optional[NAVTermsUpdate] = None
agent_id: Optional[str] = None
tax_exempt_code: Optional[str] = None
customer_type: Optional[str] = None
customer_type_effective_date: Optional[datetime.datetime] = None
rep_attachment_number: Optional[Decimal] = None
rep_relationship: Optional[str] = None
preferred_delivery_method: Optional[str] = None
no_code21: Optional[str] = None
no_code30: Optional[str] = None
privacy_policy_agreement: Optional[NAVTermsUpdate] = None
website_terms_of_use_agreement: Optional[NAVTermsUpdate] = None
age_verification_agreement: Optional[NAVTermsUpdate] = None
casl_statement_agreement: Optional[NAVCASLTermsUpdate] = None
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /profile/{BeeNumber} HTTP/1.1
Host: extensions.avon.ca
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ProfileUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel">
<AdditionalPhone>
<CodeIdPhoneType>String</CodeIdPhoneType>
<CountryCode>String</CountryCode>
<Extension>String</Extension>
<Number>String</Number>
</AdditionalPhone>
<AgeVerificationAgreement>
<Date>0001-01-01T00:00:00</Date>
<Version>String</Version>
</AgeVerificationAgreement>
<AgentId>String</AgentId>
<BankAccount>
<AccountName>String</AccountName>
<AccountNumber>String</AccountNumber>
<BankName>String</BankName>
<RoutingNumber>String</RoutingNumber>
</BankAccount>
<BeeNumber>0</BeeNumber>
<BillingAddress>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressLine4>String</AddressLine4>
<AddressLine5>String</AddressLine5>
<City>String</City>
<CountryCode>String</CountryCode>
<FirstName>String</FirstName>
<LastName>String</LastName>
<PostalCode>String</PostalCode>
<StateCode>String</StateCode>
</BillingAddress>
<BirthDate>0001-01-01T00:00:00</BirthDate>
<CASLStatementAgreement>
<Agree>String</Agree>
<Date>0001-01-01T00:00:00</Date>
</CASLStatementAgreement>
<CustomerType>String</CustomerType>
<CustomerTypeEffectiveDate>0001-01-01T00:00:00</CustomerTypeEffectiveDate>
<ElectronicAgreement>
<Date>0001-01-01T00:00:00</Date>
<Version>String</Version>
</ElectronicAgreement>
<EmailAddress>String</EmailAddress>
<FindMeOnline>false</FindMeOnline>
<FirstName>String</FirstName>
<GovernmentId>String</GovernmentId>
<Language>String</Language>
<LastName>String</LastName>
<NewPassword>String</NewPassword>
<Nickname>String</Nickname>
<NoCode21>String</NoCode21>
<NoCode30>String</NoCode30>
<OldPassword>String</OldPassword>
<OnlineStoreAddress>String</OnlineStoreAddress>
<PasswordHint>String</PasswordHint>
<PreferredDeliveryMethod>String</PreferredDeliveryMethod>
<PrimaryPhone>
<CodeIdPhoneType>String</CodeIdPhoneType>
<CountryCode>String</CountryCode>
<Extension>String</Extension>
<Number>String</Number>
</PrimaryPhone>
<PrivacyPolicyAgreement>
<Date>0001-01-01T00:00:00</Date>
<Version>String</Version>
</PrivacyPolicyAgreement>
<PublicityPermission>String</PublicityPermission>
<RepAttachmentNumber>0</RepAttachmentNumber>
<RepRelationship>String</RepRelationship>
<ShippingAddress>
<AddressLine1>String</AddressLine1>
<AddressLine2>String</AddressLine2>
<AddressLine3>String</AddressLine3>
<AddressLine4>String</AddressLine4>
<AddressLine5>String</AddressLine5>
<City>String</City>
<CountryCode>String</CountryCode>
<FirstName>String</FirstName>
<LastName>String</LastName>
<PostalCode>String</PostalCode>
<StateCode>String</StateCode>
</ShippingAddress>
<TaxExemptCode>String</TaxExemptCode>
<TermsAgreement>
<Date>0001-01-01T00:00:00</Date>
<Version>String</Version>
</TermsAgreement>
<WebsiteTermsOfUseAgreement>
<Date>0001-01-01T00:00:00</Date>
<Version>String</Version>
</WebsiteTermsOfUseAgreement>
</ProfileUpdate>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <ProfileUpdateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NAV.ServiceModel"> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> </ProfileUpdateResponse>