Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Updates the properties of a profile. The ProfileId is required for updating a customer profile.
When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.
Synopsis
- data UpdateProfile = UpdateProfile' {
- accountNumber :: Maybe Text
- additionalInformation :: Maybe Text
- address :: Maybe UpdateAddress
- attributes :: Maybe (HashMap Text Text)
- billingAddress :: Maybe UpdateAddress
- birthDate :: Maybe Text
- businessEmailAddress :: Maybe Text
- businessName :: Maybe Text
- businessPhoneNumber :: Maybe Text
- emailAddress :: Maybe Text
- firstName :: Maybe Text
- gender :: Maybe Gender
- genderString :: Maybe Text
- homePhoneNumber :: Maybe Text
- lastName :: Maybe Text
- mailingAddress :: Maybe UpdateAddress
- middleName :: Maybe Text
- mobilePhoneNumber :: Maybe Text
- partyType :: Maybe PartyType
- partyTypeString :: Maybe Text
- personalEmailAddress :: Maybe Text
- phoneNumber :: Maybe Text
- shippingAddress :: Maybe UpdateAddress
- domainName :: Text
- profileId :: Text
- newUpdateProfile :: Text -> Text -> UpdateProfile
- updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text)
- updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text))
- updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text)
- updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_businessName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_firstName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_gender :: Lens' UpdateProfile (Maybe Gender)
- updateProfile_genderString :: Lens' UpdateProfile (Maybe Text)
- updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_lastName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_middleName :: Lens' UpdateProfile (Maybe Text)
- updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType)
- updateProfile_partyTypeString :: Lens' UpdateProfile (Maybe Text)
- updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text)
- updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text)
- updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress)
- updateProfile_domainName :: Lens' UpdateProfile Text
- updateProfile_profileId :: Lens' UpdateProfile Text
- data UpdateProfileResponse = UpdateProfileResponse' {
- httpStatus :: Int
- profileId :: Text
- newUpdateProfileResponse :: Int -> Text -> UpdateProfileResponse
- updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int
- updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text
Creating a Request
data UpdateProfile Source #
See: newUpdateProfile
smart constructor.
UpdateProfile' | |
|
Instances
Create a value of UpdateProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateProfile
, updateProfile_accountNumber
- A unique account number that you have given to the customer.
UpdateProfile
, updateProfile_additionalInformation
- Any additional information relevant to the customer’s profile.
UpdateProfile
, updateProfile_address
- A generic address associated with the customer that is not mailing,
shipping, or billing.
UpdateProfile
, updateProfile_attributes
- A key value pair of attributes of a customer profile.
UpdateProfile
, updateProfile_billingAddress
- The customer’s billing address.
UpdateProfile
, updateProfile_birthDate
- The customer’s birth date.
UpdateProfile
, updateProfile_businessEmailAddress
- The customer’s business email address.
UpdateProfile
, updateProfile_businessName
- The name of the customer’s business.
UpdateProfile
, updateProfile_businessPhoneNumber
- The customer’s business phone number.
UpdateProfile
, updateProfile_emailAddress
- The customer’s email address, which has not been specified as a personal
or business address.
UpdateProfile
, updateProfile_firstName
- The customer’s first name.
UpdateProfile
, updateProfile_gender
- The gender with which the customer identifies.
$sel:genderString:UpdateProfile'
, updateProfile_genderString
- An alternative to Gender
which accepts any string as input.
UpdateProfile
, updateProfile_homePhoneNumber
- The customer’s home phone number.
UpdateProfile
, updateProfile_lastName
- The customer’s last name.
UpdateProfile
, updateProfile_mailingAddress
- The customer’s mailing address.
UpdateProfile
, updateProfile_middleName
- The customer’s middle name.
UpdateProfile
, updateProfile_mobilePhoneNumber
- The customer’s mobile phone number.
UpdateProfile
, updateProfile_partyType
- The type of profile used to describe the customer.
$sel:partyTypeString:UpdateProfile'
, updateProfile_partyTypeString
- An alternative to PartyType
which accepts any string as input.
UpdateProfile
, updateProfile_personalEmailAddress
- The customer’s personal email address.
UpdateProfile
, updateProfile_phoneNumber
- The customer’s phone number, which has not been specified as a mobile,
home, or business number.
UpdateProfile
, updateProfile_shippingAddress
- The customer’s shipping address.
UpdateProfile
, updateProfile_domainName
- The unique name of the domain.
UpdateProfile
, updateProfile_profileId
- The unique identifier of a customer profile.
Request Lenses
updateProfile_accountNumber :: Lens' UpdateProfile (Maybe Text) Source #
A unique account number that you have given to the customer.
updateProfile_additionalInformation :: Lens' UpdateProfile (Maybe Text) Source #
Any additional information relevant to the customer’s profile.
updateProfile_address :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
A generic address associated with the customer that is not mailing, shipping, or billing.
updateProfile_attributes :: Lens' UpdateProfile (Maybe (HashMap Text Text)) Source #
A key value pair of attributes of a customer profile.
updateProfile_billingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s billing address.
updateProfile_birthDate :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s birth date.
updateProfile_businessEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s business email address.
updateProfile_businessName :: Lens' UpdateProfile (Maybe Text) Source #
The name of the customer’s business.
updateProfile_businessPhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s business phone number.
updateProfile_emailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s email address, which has not been specified as a personal or business address.
updateProfile_firstName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s first name.
updateProfile_gender :: Lens' UpdateProfile (Maybe Gender) Source #
The gender with which the customer identifies.
updateProfile_genderString :: Lens' UpdateProfile (Maybe Text) Source #
An alternative to Gender
which accepts any string as input.
updateProfile_homePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s home phone number.
updateProfile_lastName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s last name.
updateProfile_mailingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s mailing address.
updateProfile_middleName :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s middle name.
updateProfile_mobilePhoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s mobile phone number.
updateProfile_partyType :: Lens' UpdateProfile (Maybe PartyType) Source #
The type of profile used to describe the customer.
updateProfile_partyTypeString :: Lens' UpdateProfile (Maybe Text) Source #
An alternative to PartyType
which accepts any string as input.
updateProfile_personalEmailAddress :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s personal email address.
updateProfile_phoneNumber :: Lens' UpdateProfile (Maybe Text) Source #
The customer’s phone number, which has not been specified as a mobile, home, or business number.
updateProfile_shippingAddress :: Lens' UpdateProfile (Maybe UpdateAddress) Source #
The customer’s shipping address.
updateProfile_domainName :: Lens' UpdateProfile Text Source #
The unique name of the domain.
updateProfile_profileId :: Lens' UpdateProfile Text Source #
The unique identifier of a customer profile.
Destructuring the Response
data UpdateProfileResponse Source #
See: newUpdateProfileResponse
smart constructor.
UpdateProfileResponse' | |
|
Instances
newUpdateProfileResponse Source #
Create a value of UpdateProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateProfileResponse'
, updateProfileResponse_httpStatus
- The response's http status code.
UpdateProfile
, updateProfileResponse_profileId
- The unique identifier of a customer profile.
Response Lenses
updateProfileResponse_httpStatus :: Lens' UpdateProfileResponse Int Source #
The response's http status code.
updateProfileResponse_profileId :: Lens' UpdateProfileResponse Text Source #
The unique identifier of a customer profile.