| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetAccountsAccountPersons
Description
Contains the different functions to run the operation getAccountsAccountPersons
Synopsis
- getAccountsAccountPersons :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> m (Either HttpException (Response GetAccountsAccountPersonsResponse))
- getAccountsAccountPersonsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> m (Either HttpException (Response ByteString))
- getAccountsAccountPersonsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountsAccountPersonsResponse))
- getAccountsAccountPersonsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetAccountsAccountPersonsRequestBody = GetAccountsAccountPersonsRequestBody {
- data GetAccountsAccountPersonsResponse
- data GetAccountsAccountPersonsResponseBody200 = GetAccountsAccountPersonsResponseBody200 {}
- data GetAccountsAccountPersonsResponseBody200Object'
Documentation
getAccountsAccountPersons Source #
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> String | account | Constraints: Maximum length of 5000 |
| -> Maybe String | ending_before: A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list. | Constraints: Maximum length of 5000 |
| -> Maybe String | expand: Specifies which fields in the response should be expanded. |
| -> Maybe Integer | limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| -> Maybe String | relationship: Filters on the list of people returned based on the person's relationship to the account's company. |
| -> Maybe String | starting_after: A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list. | Constraints: Maximum length of 5000 |
| -> GetAccountsAccountPersonsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetAccountsAccountPersonsResponse)) | Monad containing the result of the operation |
GET /v1/accounts/{account}/persons<p>Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.</p>
getAccountsAccountPersonsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/accounts/{account}/personsThe same as getAccountsAccountPersons but returns the raw ByteString
getAccountsAccountPersonsM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountsAccountPersonsResponse)) Source #
GET /v1/accounts/{account}/personsMonadic version of getAccountsAccountPersons (use with runWithConfiguration)
getAccountsAccountPersonsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountsAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/accounts/{account}/personsMonadic version of getAccountsAccountPersonsRaw (use with runWithConfiguration)
data GetAccountsAccountPersonsRequestBody Source #
Defines the data type for the schema getAccountsAccountPersonsRequestBody
Constructors
| GetAccountsAccountPersonsRequestBody | |
Instances
data GetAccountsAccountPersonsResponse Source #
Represents a response of the operation getAccountsAccountPersons.
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), GetAccountsAccountPersonsResponseError is used.
Constructors
| GetAccountsAccountPersonsResponseError String | Means either no matching case available or a parse error |
| GetAccountsAccountPersonsResponse200 GetAccountsAccountPersonsResponseBody200 | Successful response. |
| GetAccountsAccountPersonsResponseDefault Error | Error response. |
Instances
data GetAccountsAccountPersonsResponseBody200 Source #
Defines the data type for the schema GetAccountsAccountPersonsResponseBody200
Constructors
| GetAccountsAccountPersonsResponseBody200 | |
Fields
| |
data GetAccountsAccountPersonsResponseBody200Object' Source #
Defines the enum schema GetAccountsAccountPersonsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetAccountsAccountPersonsResponseBody200Object'EnumOther Value | |
| GetAccountsAccountPersonsResponseBody200Object'EnumTyped String | |
| GetAccountsAccountPersonsResponseBody200Object'EnumStringList |