Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postAccountsAccountPeople
Synopsis
- postAccountsAccountPeople :: forall m. MonadHTTP m => Text -> Maybe PostAccountsAccountPeopleRequestBody -> ClientT m (Response PostAccountsAccountPeopleResponse)
- data PostAccountsAccountPeopleRequestBody = PostAccountsAccountPeopleRequestBody {
- postAccountsAccountPeopleRequestBodyAddress :: Maybe PostAccountsAccountPeopleRequestBodyAddress'
- postAccountsAccountPeopleRequestBodyAddressKana :: Maybe PostAccountsAccountPeopleRequestBodyAddressKana'
- postAccountsAccountPeopleRequestBodyAddressKanji :: Maybe PostAccountsAccountPeopleRequestBodyAddressKanji'
- postAccountsAccountPeopleRequestBodyDob :: Maybe PostAccountsAccountPeopleRequestBodyDob'Variants
- postAccountsAccountPeopleRequestBodyDocuments :: Maybe PostAccountsAccountPeopleRequestBodyDocuments'
- postAccountsAccountPeopleRequestBodyEmail :: Maybe Text
- postAccountsAccountPeopleRequestBodyExpand :: Maybe [Text]
- postAccountsAccountPeopleRequestBodyFirstName :: Maybe Text
- postAccountsAccountPeopleRequestBodyFirstNameKana :: Maybe Text
- postAccountsAccountPeopleRequestBodyFirstNameKanji :: Maybe Text
- postAccountsAccountPeopleRequestBodyGender :: Maybe Text
- postAccountsAccountPeopleRequestBodyIdNumber :: Maybe Text
- postAccountsAccountPeopleRequestBodyLastName :: Maybe Text
- postAccountsAccountPeopleRequestBodyLastNameKana :: Maybe Text
- postAccountsAccountPeopleRequestBodyLastNameKanji :: Maybe Text
- postAccountsAccountPeopleRequestBodyMaidenName :: Maybe Text
- postAccountsAccountPeopleRequestBodyMetadata :: Maybe PostAccountsAccountPeopleRequestBodyMetadata'Variants
- postAccountsAccountPeopleRequestBodyNationality :: Maybe Text
- postAccountsAccountPeopleRequestBodyPersonToken :: Maybe Text
- postAccountsAccountPeopleRequestBodyPhone :: Maybe Text
- postAccountsAccountPeopleRequestBodyPoliticalExposure :: Maybe Text
- postAccountsAccountPeopleRequestBodyRelationship :: Maybe PostAccountsAccountPeopleRequestBodyRelationship'
- postAccountsAccountPeopleRequestBodySsnLast_4 :: Maybe Text
- postAccountsAccountPeopleRequestBodyVerification :: Maybe PostAccountsAccountPeopleRequestBodyVerification'
- mkPostAccountsAccountPeopleRequestBody :: PostAccountsAccountPeopleRequestBody
- data PostAccountsAccountPeopleRequestBodyAddress' = PostAccountsAccountPeopleRequestBodyAddress' {
- postAccountsAccountPeopleRequestBodyAddress'City :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddress'Country :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddress'Line1 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddress'Line2 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddress'PostalCode :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddress'State :: Maybe Text
- mkPostAccountsAccountPeopleRequestBodyAddress' :: PostAccountsAccountPeopleRequestBodyAddress'
- data PostAccountsAccountPeopleRequestBodyAddressKana' = PostAccountsAccountPeopleRequestBodyAddressKana' {
- postAccountsAccountPeopleRequestBodyAddressKana'City :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'Country :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'Line1 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'Line2 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'PostalCode :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'State :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKana'Town :: Maybe Text
- mkPostAccountsAccountPeopleRequestBodyAddressKana' :: PostAccountsAccountPeopleRequestBodyAddressKana'
- data PostAccountsAccountPeopleRequestBodyAddressKanji' = PostAccountsAccountPeopleRequestBodyAddressKanji' {
- postAccountsAccountPeopleRequestBodyAddressKanji'City :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'Country :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'Line1 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'Line2 :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'PostalCode :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'State :: Maybe Text
- postAccountsAccountPeopleRequestBodyAddressKanji'Town :: Maybe Text
- mkPostAccountsAccountPeopleRequestBodyAddressKanji' :: PostAccountsAccountPeopleRequestBodyAddressKanji'
- data PostAccountsAccountPeopleRequestBodyDob'OneOf1 = PostAccountsAccountPeopleRequestBodyDob'OneOf1 {}
- mkPostAccountsAccountPeopleRequestBodyDob'OneOf1 :: Int -> Int -> Int -> PostAccountsAccountPeopleRequestBodyDob'OneOf1
- data PostAccountsAccountPeopleRequestBodyDob'Variants
- data PostAccountsAccountPeopleRequestBodyDocuments' = PostAccountsAccountPeopleRequestBodyDocuments' {
- postAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization :: Maybe PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization'
- postAccountsAccountPeopleRequestBodyDocuments'Passport :: Maybe PostAccountsAccountPeopleRequestBodyDocuments'Passport'
- postAccountsAccountPeopleRequestBodyDocuments'Visa :: Maybe PostAccountsAccountPeopleRequestBodyDocuments'Visa'
- mkPostAccountsAccountPeopleRequestBodyDocuments' :: PostAccountsAccountPeopleRequestBodyDocuments'
- data PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' = PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' {}
- mkPostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization'
- data PostAccountsAccountPeopleRequestBodyDocuments'Passport' = PostAccountsAccountPeopleRequestBodyDocuments'Passport' {}
- mkPostAccountsAccountPeopleRequestBodyDocuments'Passport' :: PostAccountsAccountPeopleRequestBodyDocuments'Passport'
- data PostAccountsAccountPeopleRequestBodyDocuments'Visa' = PostAccountsAccountPeopleRequestBodyDocuments'Visa' {}
- mkPostAccountsAccountPeopleRequestBodyDocuments'Visa' :: PostAccountsAccountPeopleRequestBodyDocuments'Visa'
- data PostAccountsAccountPeopleRequestBodyMetadata'Variants
- data PostAccountsAccountPeopleRequestBodyRelationship' = PostAccountsAccountPeopleRequestBodyRelationship' {
- postAccountsAccountPeopleRequestBodyRelationship'Director :: Maybe Bool
- postAccountsAccountPeopleRequestBodyRelationship'Executive :: Maybe Bool
- postAccountsAccountPeopleRequestBodyRelationship'Owner :: Maybe Bool
- postAccountsAccountPeopleRequestBodyRelationship'PercentOwnership :: Maybe PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Variants
- postAccountsAccountPeopleRequestBodyRelationship'Representative :: Maybe Bool
- postAccountsAccountPeopleRequestBodyRelationship'Title :: Maybe Text
- mkPostAccountsAccountPeopleRequestBodyRelationship' :: PostAccountsAccountPeopleRequestBodyRelationship'
- data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Variants
- data PostAccountsAccountPeopleRequestBodyVerification' = PostAccountsAccountPeopleRequestBodyVerification' {}
- mkPostAccountsAccountPeopleRequestBodyVerification' :: PostAccountsAccountPeopleRequestBodyVerification'
- data PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' = PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' {}
- mkPostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument'
- data PostAccountsAccountPeopleRequestBodyVerification'Document' = PostAccountsAccountPeopleRequestBodyVerification'Document' {}
- mkPostAccountsAccountPeopleRequestBodyVerification'Document' :: PostAccountsAccountPeopleRequestBodyVerification'Document'
- data PostAccountsAccountPeopleResponse
Documentation
postAccountsAccountPeople Source #
:: forall m. MonadHTTP m | |
=> Text | account | Constraints: Maximum length of 5000 |
-> Maybe PostAccountsAccountPeopleRequestBody | The request body to send |
-> ClientT m (Response PostAccountsAccountPeopleResponse) | Monadic computation which returns the result of the operation |
POST /v1/accounts/{account}/people
<p>Creates a new person.</p>
data PostAccountsAccountPeopleRequestBody Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema
in the specification.
PostAccountsAccountPeopleRequestBody | |
|
mkPostAccountsAccountPeopleRequestBody :: PostAccountsAccountPeopleRequestBody Source #
Create a new PostAccountsAccountPeopleRequestBody
with all required fields.
data PostAccountsAccountPeopleRequestBodyAddress' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.address
in the specification.
The person's address.
PostAccountsAccountPeopleRequestBodyAddress' | |
|
mkPostAccountsAccountPeopleRequestBodyAddress' :: PostAccountsAccountPeopleRequestBodyAddress' Source #
Create a new PostAccountsAccountPeopleRequestBodyAddress'
with all required fields.
data PostAccountsAccountPeopleRequestBodyAddressKana' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.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).
PostAccountsAccountPeopleRequestBodyAddressKana' | |
|
Instances
mkPostAccountsAccountPeopleRequestBodyAddressKana' :: PostAccountsAccountPeopleRequestBodyAddressKana' Source #
Create a new PostAccountsAccountPeopleRequestBodyAddressKana'
with all required fields.
data PostAccountsAccountPeopleRequestBodyAddressKanji' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.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).
PostAccountsAccountPeopleRequestBodyAddressKanji' | |
|
Instances
mkPostAccountsAccountPeopleRequestBodyAddressKanji' :: PostAccountsAccountPeopleRequestBodyAddressKanji' Source #
Create a new PostAccountsAccountPeopleRequestBodyAddressKanji'
with all required fields.
data PostAccountsAccountPeopleRequestBodyDob'OneOf1 Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
mkPostAccountsAccountPeopleRequestBodyDob'OneOf1 Source #
Create a new PostAccountsAccountPeopleRequestBodyDob'OneOf1
with all required fields.
data PostAccountsAccountPeopleRequestBodyDob'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.dob.anyOf
in the specification.
The person's date of birth.
Instances
data PostAccountsAccountPeopleRequestBodyDocuments' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents
in the specification.
Documents that may be submitted to satisfy various informational requests.
mkPostAccountsAccountPeopleRequestBodyDocuments' :: PostAccountsAccountPeopleRequestBodyDocuments' Source #
Create a new PostAccountsAccountPeopleRequestBodyDocuments'
with all required fields.
data PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.company_authorization
in the specification.
Instances
mkPostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' :: PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization' Source #
Create a new PostAccountsAccountPeopleRequestBodyDocuments'CompanyAuthorization'
with all required fields.
data PostAccountsAccountPeopleRequestBodyDocuments'Passport' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.passport
in the specification.
Instances
mkPostAccountsAccountPeopleRequestBodyDocuments'Passport' :: PostAccountsAccountPeopleRequestBodyDocuments'Passport' Source #
Create a new PostAccountsAccountPeopleRequestBodyDocuments'Passport'
with all required fields.
data PostAccountsAccountPeopleRequestBodyDocuments'Visa' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.documents.properties.visa
in the specification.
Instances
mkPostAccountsAccountPeopleRequestBodyDocuments'Visa' :: PostAccountsAccountPeopleRequestBodyDocuments'Visa' Source #
Create a new PostAccountsAccountPeopleRequestBodyDocuments'Visa'
with all required fields.
data PostAccountsAccountPeopleRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people.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`.
PostAccountsAccountPeopleRequestBodyMetadata'EmptyString | Represents the JSON value |
PostAccountsAccountPeopleRequestBodyMetadata'Object Object |
Instances
data PostAccountsAccountPeopleRequestBodyRelationship' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.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
mkPostAccountsAccountPeopleRequestBodyRelationship' :: PostAccountsAccountPeopleRequestBodyRelationship' Source #
Create a new PostAccountsAccountPeopleRequestBodyRelationship'
with all required fields.
data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Variants Source #
Defines the oneOf schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.relationship.properties.percent_ownership.anyOf
in the specification.
PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'EmptyString | Represents the JSON value |
PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Double Double |
Instances
data PostAccountsAccountPeopleRequestBodyVerification' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification
in the specification.
The person's verification status.
Instances
mkPostAccountsAccountPeopleRequestBodyVerification' :: PostAccountsAccountPeopleRequestBodyVerification' Source #
Create a new PostAccountsAccountPeopleRequestBodyVerification'
with all required fields.
data PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.additional_document
in the specification.
PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' | |
|
Instances
mkPostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' :: PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' Source #
Create a new PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument'
with all required fields.
data PostAccountsAccountPeopleRequestBodyVerification'Document' Source #
Defines the object schema located at paths./v1/accounts/{account}/people.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.verification.properties.document
in the specification.
PostAccountsAccountPeopleRequestBodyVerification'Document' | |
|
Instances
mkPostAccountsAccountPeopleRequestBodyVerification'Document' :: PostAccountsAccountPeopleRequestBodyVerification'Document' Source #
Create a new PostAccountsAccountPeopleRequestBodyVerification'Document'
with all required fields.
data PostAccountsAccountPeopleResponse Source #
Represents a response of the operation postAccountsAccountPeople
.
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), PostAccountsAccountPeopleResponseError
is used.
PostAccountsAccountPeopleResponseError String | Means either no matching case available or a parse error |
PostAccountsAccountPeopleResponse200 Person | Successful response. |
PostAccountsAccountPeopleResponseDefault Error | Error response. |