Safe Haskell | None |
---|---|
Language | Haskell2010 |
Contains the different functions to run the operation postAccountPeople
Synopsis
- postAccountPeople :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostAccountPeopleRequestBody -> m (Either HttpException (Response PostAccountPeopleResponse))
- postAccountPeopleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostAccountPeopleRequestBody -> m (Either HttpException (Response ByteString))
- postAccountPeopleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountPeopleResponse))
- postAccountPeopleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostAccountPeopleRequestBody = PostAccountPeopleRequestBody {
- postAccountPeopleRequestBodyAccount :: Maybe Text
- postAccountPeopleRequestBodyAddress :: Maybe PostAccountPeopleRequestBodyAddress'
- postAccountPeopleRequestBodyAddressKana :: Maybe PostAccountPeopleRequestBodyAddressKana'
- postAccountPeopleRequestBodyAddressKanji :: Maybe PostAccountPeopleRequestBodyAddressKanji'
- postAccountPeopleRequestBodyDob :: Maybe PostAccountPeopleRequestBodyDob'Variants
- postAccountPeopleRequestBodyEmail :: Maybe Text
- postAccountPeopleRequestBodyExpand :: Maybe ([] Text)
- postAccountPeopleRequestBodyFirstName :: Maybe Text
- postAccountPeopleRequestBodyFirstNameKana :: Maybe Text
- postAccountPeopleRequestBodyFirstNameKanji :: Maybe Text
- postAccountPeopleRequestBodyGender :: Maybe Text
- postAccountPeopleRequestBodyIdNumber :: Maybe Text
- postAccountPeopleRequestBodyLastName :: Maybe Text
- postAccountPeopleRequestBodyLastNameKana :: Maybe Text
- postAccountPeopleRequestBodyLastNameKanji :: Maybe Text
- postAccountPeopleRequestBodyMaidenName :: Maybe Text
- postAccountPeopleRequestBodyMetadata :: Maybe PostAccountPeopleRequestBodyMetadata'
- postAccountPeopleRequestBodyPersonToken :: Maybe Text
- postAccountPeopleRequestBodyPhone :: Maybe Text
- postAccountPeopleRequestBodyRelationship :: Maybe PostAccountPeopleRequestBodyRelationship'
- postAccountPeopleRequestBodySsnLast_4 :: Maybe Text
- postAccountPeopleRequestBodyVerification :: Maybe PostAccountPeopleRequestBodyVerification'
- data PostAccountPeopleRequestBodyAddress' = PostAccountPeopleRequestBodyAddress' {
- postAccountPeopleRequestBodyAddress'City :: Maybe Text
- postAccountPeopleRequestBodyAddress'Country :: Maybe Text
- postAccountPeopleRequestBodyAddress'Line1 :: Maybe Text
- postAccountPeopleRequestBodyAddress'Line2 :: Maybe Text
- postAccountPeopleRequestBodyAddress'PostalCode :: Maybe Text
- postAccountPeopleRequestBodyAddress'State :: Maybe Text
- data PostAccountPeopleRequestBodyAddressKana' = PostAccountPeopleRequestBodyAddressKana' {
- postAccountPeopleRequestBodyAddressKana'City :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'Country :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'Line1 :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'Line2 :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'PostalCode :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'State :: Maybe Text
- postAccountPeopleRequestBodyAddressKana'Town :: Maybe Text
- data PostAccountPeopleRequestBodyAddressKanji' = PostAccountPeopleRequestBodyAddressKanji' {
- postAccountPeopleRequestBodyAddressKanji'City :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'Country :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'Line1 :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'Line2 :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'PostalCode :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'State :: Maybe Text
- postAccountPeopleRequestBodyAddressKanji'Town :: Maybe Text
- data PostAccountPeopleRequestBodyDob'OneOf1
- data PostAccountPeopleRequestBodyDob'OneOf2 = PostAccountPeopleRequestBodyDob'OneOf2 {}
- data PostAccountPeopleRequestBodyDob'Variants
- data PostAccountPeopleRequestBodyMetadata' = PostAccountPeopleRequestBodyMetadata' {
- data PostAccountPeopleRequestBodyRelationship' = PostAccountPeopleRequestBodyRelationship' {
- postAccountPeopleRequestBodyRelationship'Director :: Maybe Bool
- postAccountPeopleRequestBodyRelationship'Executive :: Maybe Bool
- postAccountPeopleRequestBodyRelationship'Owner :: Maybe Bool
- postAccountPeopleRequestBodyRelationship'PercentOwnership :: Maybe PostAccountPeopleRequestBodyRelationship'PercentOwnership'Variants
- postAccountPeopleRequestBodyRelationship'Representative :: Maybe Bool
- postAccountPeopleRequestBodyRelationship'Title :: Maybe Text
- data PostAccountPeopleRequestBodyRelationship'PercentOwnership'OneOf1
- data PostAccountPeopleRequestBodyRelationship'PercentOwnership'Variants
- data PostAccountPeopleRequestBodyVerification' = PostAccountPeopleRequestBodyVerification' {}
- data PostAccountPeopleRequestBodyVerification'AdditionalDocument' = PostAccountPeopleRequestBodyVerification'AdditionalDocument' {}
- data PostAccountPeopleRequestBodyVerification'Document' = PostAccountPeopleRequestBodyVerification'Document' {}
- data PostAccountPeopleResponse
Documentation
:: (MonadHTTP m, SecurityScheme s) | |
=> Configuration s | The configuration to use in the request |
-> Maybe PostAccountPeopleRequestBody | The request body to send |
-> m (Either HttpException (Response PostAccountPeopleResponse)) | Monad containing the result of the operation |
POST /v1/account/people
<p>Creates a new person.</p>
postAccountPeopleRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostAccountPeopleRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/account/people
The same as postAccountPeople
but returns the raw ByteString
postAccountPeopleM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostAccountPeopleResponse)) Source #
POST /v1/account/people
Monadic version of postAccountPeople
(use with runWithConfiguration
)
postAccountPeopleRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostAccountPeopleRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/account/people
Monadic version of postAccountPeopleRaw
(use with runWithConfiguration
)
data PostAccountPeopleRequestBody Source #
Defines the data type for the schema postAccountPeopleRequestBody
PostAccountPeopleRequestBody | |
|
Instances
data PostAccountPeopleRequestBodyAddress' Source #
Defines the data type for the schema postAccountPeopleRequestBodyAddress'
The person's address.
PostAccountPeopleRequestBodyAddress' | |
|
data PostAccountPeopleRequestBodyAddressKana' Source #
Defines the data type for the schema postAccountPeopleRequestBodyAddress_kana'
The Kana variation of the person's address (Japan only).
PostAccountPeopleRequestBodyAddressKana' | |
|
data PostAccountPeopleRequestBodyAddressKanji' Source #
Defines the data type for the schema postAccountPeopleRequestBodyAddress_kanji'
The Kanji variation of the person's address (Japan only).
PostAccountPeopleRequestBodyAddressKanji' | |
|
data PostAccountPeopleRequestBodyDob'OneOf1 Source #
Defines the enum schema postAccountPeopleRequestBodyDob'OneOf1
PostAccountPeopleRequestBodyDob'OneOf1EnumOther Value | |
PostAccountPeopleRequestBodyDob'OneOf1EnumTyped Text | |
PostAccountPeopleRequestBodyDob'OneOf1EnumString_ |
data PostAccountPeopleRequestBodyDob'OneOf2 Source #
Defines the data type for the schema postAccountPeopleRequestBodyDob'OneOf2
data PostAccountPeopleRequestBodyDob'Variants Source #
Define the one-of schema postAccountPeopleRequestBodyDob'
The person's date of birth.
Instances
data PostAccountPeopleRequestBodyMetadata' Source #
Defines the data type for the schema postAccountPeopleRequestBodyMetadata'
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 PostAccountPeopleRequestBodyRelationship' Source #
Defines the data type for the schema postAccountPeopleRequestBodyRelationship'
The relationship that this person has with the account's legal entity.
PostAccountPeopleRequestBodyRelationship' | |
|
data PostAccountPeopleRequestBodyRelationship'PercentOwnership'OneOf1 Source #
Defines the enum schema postAccountPeopleRequestBodyRelationship'Percent_ownership'OneOf1
Instances
data PostAccountPeopleRequestBodyRelationship'PercentOwnership'Variants Source #
Define the one-of schema postAccountPeopleRequestBodyRelationship'Percent_ownership'
Instances
data PostAccountPeopleRequestBodyVerification' Source #
Defines the data type for the schema postAccountPeopleRequestBodyVerification'
The person's verification status.
data PostAccountPeopleRequestBodyVerification'AdditionalDocument' Source #
Defines the data type for the schema postAccountPeopleRequestBodyVerification'Additional_document'
PostAccountPeopleRequestBodyVerification'AdditionalDocument' | |
|
Instances
data PostAccountPeopleRequestBodyVerification'Document' Source #
Defines the data type for the schema postAccountPeopleRequestBodyVerification'Document'
PostAccountPeopleRequestBodyVerification'Document' | |
|
Instances
data PostAccountPeopleResponse Source #
Represents a response of the operation postAccountPeople
.
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), PostAccountPeopleResponseError
is used.
PostAccountPeopleResponseError String | Means either no matching case available or a parse error |
PostAccountPeopleResponse200 Person | Successful response. |
PostAccountPeopleResponseDefault Error | Error response. |