Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postAccountsAccountPeople
Synopsis
- postAccountsAccountPeople :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostAccountsAccountPeopleRequestBody -> m (Either HttpException (Response PostAccountsAccountPeopleResponse))
- postAccountsAccountPeopleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostAccountsAccountPeopleRequestBody -> m (Either HttpException (Response ByteString))
- postAccountsAccountPeopleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountsAccountPeopleResponse))
- postAccountsAccountPeopleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostAccountsAccountPeopleRequestBody = PostAccountsAccountPeopleRequestBody {
- postAccountsAccountPeopleRequestBodyAddress :: Maybe PostAccountsAccountPeopleRequestBodyAddress'
- postAccountsAccountPeopleRequestBodyAddressKana :: Maybe PostAccountsAccountPeopleRequestBodyAddressKana'
- postAccountsAccountPeopleRequestBodyAddressKanji :: Maybe PostAccountsAccountPeopleRequestBodyAddressKanji'
- postAccountsAccountPeopleRequestBodyDob :: Maybe PostAccountsAccountPeopleRequestBodyDob'Variants
- 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'
- postAccountsAccountPeopleRequestBodyPersonToken :: Maybe Text
- postAccountsAccountPeopleRequestBodyPhone :: Maybe Text
- postAccountsAccountPeopleRequestBodyRelationship :: Maybe PostAccountsAccountPeopleRequestBodyRelationship'
- postAccountsAccountPeopleRequestBodySsnLast_4 :: Maybe Text
- postAccountsAccountPeopleRequestBodyVerification :: Maybe PostAccountsAccountPeopleRequestBodyVerification'
- 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
- 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
- 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
- data PostAccountsAccountPeopleRequestBodyDob'OneOf1
- data PostAccountsAccountPeopleRequestBodyDob'OneOf2 = PostAccountsAccountPeopleRequestBodyDob'OneOf2 {}
- data PostAccountsAccountPeopleRequestBodyDob'Variants
- data PostAccountsAccountPeopleRequestBodyMetadata' = PostAccountsAccountPeopleRequestBodyMetadata' {
- 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
- data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'OneOf1
- data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Variants
- data PostAccountsAccountPeopleRequestBodyVerification' = PostAccountsAccountPeopleRequestBodyVerification' {}
- data PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' = PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' {}
- data PostAccountsAccountPeopleRequestBodyVerification'Document' = PostAccountsAccountPeopleRequestBodyVerification'Document' {}
- data PostAccountsAccountPeopleResponse
Documentation
postAccountsAccountPeople Source #
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Text | account | Constraints: Maximum length of 5000 |
-> Maybe PostAccountsAccountPeopleRequestBody | The request body to send |
-> m (Either HttpException (Response PostAccountsAccountPeopleResponse)) | Monad containing the result of the operation |
POST /v1/accounts/{account}/people
<p>Creates a new person.</p>
postAccountsAccountPeopleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostAccountsAccountPeopleRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/accounts/{account}/people
The same as postAccountsAccountPeople
but returns the raw ByteString
postAccountsAccountPeopleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountsAccountPeopleResponse)) Source #
POST /v1/accounts/{account}/people
Monadic version of postAccountsAccountPeople
(use with runWithConfiguration
)
postAccountsAccountPeopleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostAccountsAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/accounts/{account}/people
Monadic version of postAccountsAccountPeopleRaw
(use with runWithConfiguration
)
data PostAccountsAccountPeopleRequestBody Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBody
PostAccountsAccountPeopleRequestBody | |
|
data PostAccountsAccountPeopleRequestBodyAddress' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyAddress'
The person's address.
PostAccountsAccountPeopleRequestBodyAddress' | |
|
data PostAccountsAccountPeopleRequestBodyAddressKana' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyAddress_kana'
The Kana variation of the person's address (Japan only).
PostAccountsAccountPeopleRequestBodyAddressKana' | |
|
Instances
data PostAccountsAccountPeopleRequestBodyAddressKanji' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyAddress_kanji'
The Kanji variation of the person's address (Japan only).
PostAccountsAccountPeopleRequestBodyAddressKanji' | |
|
Instances
data PostAccountsAccountPeopleRequestBodyDob'OneOf1 Source #
Defines the enum schema postAccountsAccountPeopleRequestBodyDob'OneOf1
PostAccountsAccountPeopleRequestBodyDob'OneOf1EnumOther Value | |
PostAccountsAccountPeopleRequestBodyDob'OneOf1EnumTyped Text | |
PostAccountsAccountPeopleRequestBodyDob'OneOf1EnumString_ |
data PostAccountsAccountPeopleRequestBodyDob'OneOf2 Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyDob'OneOf2
data PostAccountsAccountPeopleRequestBodyDob'Variants Source #
Define the one-of schema postAccountsAccountPeopleRequestBodyDob'
The person's date of birth.
Instances
data PostAccountsAccountPeopleRequestBodyMetadata' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyMetadata'
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`.
data PostAccountsAccountPeopleRequestBodyRelationship' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyRelationship'
The relationship that this person has with the account's legal entity.
Instances
data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'OneOf1 Source #
Defines the enum schema postAccountsAccountPeopleRequestBodyRelationship'Percent_ownership'OneOf1
Instances
data PostAccountsAccountPeopleRequestBodyRelationship'PercentOwnership'Variants Source #
Define the one-of schema postAccountsAccountPeopleRequestBodyRelationship'Percent_ownership'
Instances
data PostAccountsAccountPeopleRequestBodyVerification' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyVerification'
The person's verification status.
Instances
data PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyVerification'Additional_document'
PostAccountsAccountPeopleRequestBodyVerification'AdditionalDocument' | |
|
Instances
data PostAccountsAccountPeopleRequestBodyVerification'Document' Source #
Defines the data type for the schema postAccountsAccountPeopleRequestBodyVerification'Document'
PostAccountsAccountPeopleRequestBodyVerification'Document' | |
|
Instances
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. |