Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postAccountsAccountPeoplePerson
Synopsis
- postAccountsAccountPeoplePerson :: forall m. MonadHTTP m => PostAccountsAccountPeoplePersonParameters -> Maybe PostAccountsAccountPeoplePersonRequestBody -> ClientT m (Response PostAccountsAccountPeoplePersonResponse)
- data PostAccountsAccountPeoplePersonParameters = PostAccountsAccountPeoplePersonParameters {}
- mkPostAccountsAccountPeoplePersonParameters :: Text -> Text -> PostAccountsAccountPeoplePersonParameters
- data PostAccountsAccountPeoplePersonRequestBody = PostAccountsAccountPeoplePersonRequestBody {
- postAccountsAccountPeoplePersonRequestBodyAddress :: Maybe PostAccountsAccountPeoplePersonRequestBodyAddress'
- postAccountsAccountPeoplePersonRequestBodyAddressKana :: Maybe PostAccountsAccountPeoplePersonRequestBodyAddressKana'
- postAccountsAccountPeoplePersonRequestBodyAddressKanji :: Maybe PostAccountsAccountPeoplePersonRequestBodyAddressKanji'
- postAccountsAccountPeoplePersonRequestBodyDob :: Maybe PostAccountsAccountPeoplePersonRequestBodyDob'Variants
- postAccountsAccountPeoplePersonRequestBodyDocuments :: Maybe PostAccountsAccountPeoplePersonRequestBodyDocuments'
- postAccountsAccountPeoplePersonRequestBodyEmail :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyExpand :: Maybe [Text]
- postAccountsAccountPeoplePersonRequestBodyFirstName :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyFirstNameKana :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyFirstNameKanji :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyGender :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyIdNumber :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyLastName :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyLastNameKana :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyLastNameKanji :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyMaidenName :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyMetadata :: Maybe PostAccountsAccountPeoplePersonRequestBodyMetadata'Variants
- postAccountsAccountPeoplePersonRequestBodyNationality :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyPersonToken :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyPhone :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyPoliticalExposure :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyRelationship :: Maybe PostAccountsAccountPeoplePersonRequestBodyRelationship'
- postAccountsAccountPeoplePersonRequestBodySsnLast_4 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyVerification :: Maybe PostAccountsAccountPeoplePersonRequestBodyVerification'
- mkPostAccountsAccountPeoplePersonRequestBody :: PostAccountsAccountPeoplePersonRequestBody
- data PostAccountsAccountPeoplePersonRequestBodyAddress' = PostAccountsAccountPeoplePersonRequestBodyAddress' {
- postAccountsAccountPeoplePersonRequestBodyAddress'City :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddress'Country :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddress'Line1 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddress'Line2 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddress'PostalCode :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddress'State :: Maybe Text
- mkPostAccountsAccountPeoplePersonRequestBodyAddress' :: PostAccountsAccountPeoplePersonRequestBodyAddress'
- data PostAccountsAccountPeoplePersonRequestBodyAddressKana' = PostAccountsAccountPeoplePersonRequestBodyAddressKana' {
- postAccountsAccountPeoplePersonRequestBodyAddressKana'City :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'Country :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'Line1 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'Line2 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'PostalCode :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'State :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKana'Town :: Maybe Text
- mkPostAccountsAccountPeoplePersonRequestBodyAddressKana' :: PostAccountsAccountPeoplePersonRequestBodyAddressKana'
- data PostAccountsAccountPeoplePersonRequestBodyAddressKanji' = PostAccountsAccountPeoplePersonRequestBodyAddressKanji' {
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'City :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'Country :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'Line1 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'Line2 :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'PostalCode :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'State :: Maybe Text
- postAccountsAccountPeoplePersonRequestBodyAddressKanji'Town :: Maybe Text
- mkPostAccountsAccountPeoplePersonRequestBodyAddressKanji' :: PostAccountsAccountPeoplePersonRequestBodyAddressKanji'
- data PostAccountsAccountPeoplePersonRequestBodyDob'OneOf1 = PostAccountsAccountPeoplePersonRequestBodyDob'OneOf1 {}
- mkPostAccountsAccountPeoplePersonRequestBodyDob'OneOf1 :: Int -> Int -> Int -> PostAccountsAccountPeoplePersonRequestBodyDob'OneOf1
- data PostAccountsAccountPeoplePersonRequestBodyDob'Variants
- data PostAccountsAccountPeoplePersonRequestBodyDocuments' = PostAccountsAccountPeoplePersonRequestBodyDocuments' {
- postAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization :: Maybe PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization'
- postAccountsAccountPeoplePersonRequestBodyDocuments'Passport :: Maybe PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport'
- postAccountsAccountPeoplePersonRequestBodyDocuments'Visa :: Maybe PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa'
- mkPostAccountsAccountPeoplePersonRequestBodyDocuments' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'
- data PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' = PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' {}
- mkPostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization'
- data PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' = PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' {}
- mkPostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport'
- data PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' = PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' {}
- mkPostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa'
- data PostAccountsAccountPeoplePersonRequestBodyMetadata'Variants
- data PostAccountsAccountPeoplePersonRequestBodyRelationship' = PostAccountsAccountPeoplePersonRequestBodyRelationship' {
- postAccountsAccountPeoplePersonRequestBodyRelationship'Director :: Maybe Bool
- postAccountsAccountPeoplePersonRequestBodyRelationship'Executive :: Maybe Bool
- postAccountsAccountPeoplePersonRequestBodyRelationship'Owner :: Maybe Bool
- postAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership :: Maybe PostAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership'Variants
- postAccountsAccountPeoplePersonRequestBodyRelationship'Representative :: Maybe Bool
- postAccountsAccountPeoplePersonRequestBodyRelationship'Title :: Maybe Text
- mkPostAccountsAccountPeoplePersonRequestBodyRelationship' :: PostAccountsAccountPeoplePersonRequestBodyRelationship'
- data PostAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership'Variants
- data PostAccountsAccountPeoplePersonRequestBodyVerification' = PostAccountsAccountPeoplePersonRequestBodyVerification' {}
- mkPostAccountsAccountPeoplePersonRequestBodyVerification' :: PostAccountsAccountPeoplePersonRequestBodyVerification'
- data PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' = PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' {}
- mkPostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument'
- data PostAccountsAccountPeoplePersonRequestBodyVerification'Document' = PostAccountsAccountPeoplePersonRequestBodyVerification'Document' {}
- mkPostAccountsAccountPeoplePersonRequestBodyVerification'Document' :: PostAccountsAccountPeoplePersonRequestBodyVerification'Document'
- data PostAccountsAccountPeoplePersonResponse
Documentation
postAccountsAccountPeoplePerson Source #
:: forall m. MonadHTTP m | |
=> PostAccountsAccountPeoplePersonParameters | Contains all available parameters of this operation (query and path parameters) |
-> Maybe PostAccountsAccountPeoplePersonRequestBody | The request body to send |
-> ClientT m (Response PostAccountsAccountPeoplePersonResponse) | Monadic computation which returns the result of the operation |
POST /v1/accounts/{account}/people/{person}
<p>Updates an existing person.</p>
data PostAccountsAccountPeoplePersonParameters Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.parameters
in the specification.
PostAccountsAccountPeoplePersonParameters | |
|
Instances
mkPostAccountsAccountPeoplePersonParameters Source #
Create a new PostAccountsAccountPeoplePersonParameters
with all required fields.
data PostAccountsAccountPeoplePersonRequestBody Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostAccountsAccountPeoplePersonRequestBody | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBody :: PostAccountsAccountPeoplePersonRequestBody Source #
Create a new PostAccountsAccountPeoplePersonRequestBody
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyAddress' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address
in the specification.
The person's address.
PostAccountsAccountPeoplePersonRequestBodyAddress' | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBodyAddress' :: PostAccountsAccountPeoplePersonRequestBodyAddress' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyAddress'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyAddressKana' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address_kana
in the specification.
The Kana variation of the person's address (Japan only).
PostAccountsAccountPeoplePersonRequestBodyAddressKana' | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBodyAddressKana' :: PostAccountsAccountPeoplePersonRequestBodyAddressKana' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyAddressKana'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyAddressKanji' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address_kanji
in the specification.
The Kanji variation of the person's address (Japan only).
PostAccountsAccountPeoplePersonRequestBodyAddressKanji' | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBodyAddressKanji' :: PostAccountsAccountPeoplePersonRequestBodyAddressKanji' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyAddressKanji'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyDob'OneOf1 Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyDob'OneOf1 Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyDob'OneOf1
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyDob'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
The person's date of birth.
Instances
data PostAccountsAccountPeoplePersonRequestBodyDocuments' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents
in the specification.
Documents that may be submitted to satisfy various informational requests.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyDocuments' :: PostAccountsAccountPeoplePersonRequestBodyDocuments' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyDocuments'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.company_authorization
in the specification.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyDocuments'CompanyAuthorization'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.passport
in the specification.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyDocuments'Passport'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.visa
in the specification.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' :: PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyDocuments'Visa'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf
in the specification.
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
PostAccountsAccountPeoplePersonRequestBodyMetadata'EmptyString | Represents the JSON value |
PostAccountsAccountPeoplePersonRequestBodyMetadata'Object Object |
Instances
data PostAccountsAccountPeoplePersonRequestBodyRelationship' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.relationship
in the specification.
The relationship that this person has with the account's legal entity.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyRelationship' :: PostAccountsAccountPeoplePersonRequestBodyRelationship' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyRelationship'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.relationship.properties.percent_ownership.anyOf
in the specification.
PostAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership'EmptyString | Represents the JSON value |
PostAccountsAccountPeoplePersonRequestBodyRelationship'PercentOwnership'Double Double |
Instances
data PostAccountsAccountPeoplePersonRequestBodyVerification' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification
in the specification.
The person's verification status.
Instances
mkPostAccountsAccountPeoplePersonRequestBodyVerification' :: PostAccountsAccountPeoplePersonRequestBodyVerification' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyVerification'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.additional_document
in the specification.
PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyVerification'AdditionalDocument'
with all required fields.
data PostAccountsAccountPeoplePersonRequestBodyVerification'Document' Source #
Defines the object schema located at paths./v1/accounts/{account}/people/{person}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.document
in the specification.
PostAccountsAccountPeoplePersonRequestBodyVerification'Document' | |
|
Instances
mkPostAccountsAccountPeoplePersonRequestBodyVerification'Document' :: PostAccountsAccountPeoplePersonRequestBodyVerification'Document' Source #
Create a new PostAccountsAccountPeoplePersonRequestBodyVerification'Document'
with all required fields.
data PostAccountsAccountPeoplePersonResponse Source #
Represents a response of the operation postAccountsAccountPeoplePerson
.
The response constructor is chosen by the status code of the response. If no case matches (no specific case for the response code, no range case, no default case), PostAccountsAccountPeoplePersonResponseError
is used.
PostAccountsAccountPeoplePersonResponseError String | Means either no matching case available or a parse error |
PostAccountsAccountPeoplePersonResponse200 Person | Successful response. |
PostAccountsAccountPeoplePersonResponseDefault Error | Error response. |