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 .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
beeNumber: 0,
firstName: String,
lastName: String,
nickname: String,
birthDate: 0001-01-01T00:00:00,
billingAddress:
{
firstName: String,
lastName: String,
addressLine1: String,
addressLine2: String,
addressLine3: String,
addressLine4: String,
addressLine5: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
shippingAddress:
{
firstName: String,
lastName: String,
addressLine1: String,
addressLine2: String,
addressLine3: String,
addressLine4: String,
addressLine5: String,
city: String,
stateCode: String,
postalCode: String,
countryCode: String
},
governmentId: String,
emailAddress: String,
primaryPhone:
{
number: String,
extension: String,
codeIdPhoneType: String,
countryCode: String
},
additionalPhone:
{
number: String,
extension: String,
codeIdPhoneType: String,
countryCode: String
},
onlineStoreAddress: String,
language: String,
publicityPermission: String,
findMeOnline: False,
oldPassword: String,
newPassword: String,
passwordHint: String,
bankAccount:
{
accountName: String,
bankName: String,
accountNumber: String,
routingNumber: String
},
termsAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
electronicAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
agentId: String,
taxExemptCode: String,
customerType: String,
customerTypeEffectiveDate: 0001-01-01T00:00:00,
repAttachmentNumber: 0,
repRelationship: String,
preferredDeliveryMethod: String,
noCode21: String,
noCode30: String,
privacyPolicyAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
websiteTermsOfUseAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
ageVerificationAgreement:
{
version: String,
date: 0001-01-01T00:00:00
},
caslStatementAgreement:
{
agree: String,
date: 0001-01-01T00:00:00
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }