| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.GetAccountPersons
Description
Contains the different functions to run the operation getAccountPersons
Synopsis
- getAccountPersons :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> m (Either HttpException (Response GetAccountPersonsResponse))
- getAccountPersonsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> m (Either HttpException (Response ByteString))
- getAccountPersonsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountPersonsResponse))
- getAccountPersonsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data GetAccountPersonsRequestBody = GetAccountPersonsRequestBody {
- data GetAccountPersonsResponse
- data GetAccountPersonsResponseBody200 = GetAccountPersonsResponseBody200 {}
- data GetAccountPersonsResponseBody200Object'
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> 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 |
| -> GetAccountPersonsRequestBody | The request body to send |
| -> m (Either HttpException (Response GetAccountPersonsResponse)) | Monad containing the result of the operation |
GET /v1/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>
getAccountPersonsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> m (Either HttpException (Response ByteString)) Source #
GET /v1/account/persons
The same as getAccountPersons but returns the raw ByteString
getAccountPersonsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetAccountPersonsResponse)) Source #
GET /v1/account/persons
Monadic version of getAccountPersons (use with runWithConfiguration)
getAccountPersonsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> GetAccountPersonsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
GET /v1/account/persons
Monadic version of getAccountPersonsRaw (use with runWithConfiguration)
data GetAccountPersonsRequestBody Source #
Defines the data type for the schema getAccountPersonsRequestBody
Constructors
| GetAccountPersonsRequestBody | |
Instances
data GetAccountPersonsResponse Source #
Represents a response of the operation getAccountPersons.
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), GetAccountPersonsResponseError is used.
Constructors
| GetAccountPersonsResponseError String | Means either no matching case available or a parse error |
| GetAccountPersonsResponse200 GetAccountPersonsResponseBody200 | Successful response. |
| GetAccountPersonsResponseDefault Error | Error response. |
Instances
| Eq GetAccountPersonsResponse Source # | |
Defined in StripeAPI.Operations.GetAccountPersons Methods (==) :: GetAccountPersonsResponse -> GetAccountPersonsResponse -> Bool # (/=) :: GetAccountPersonsResponse -> GetAccountPersonsResponse -> Bool # | |
| Show GetAccountPersonsResponse Source # | |
Defined in StripeAPI.Operations.GetAccountPersons Methods showsPrec :: Int -> GetAccountPersonsResponse -> ShowS # show :: GetAccountPersonsResponse -> String # showList :: [GetAccountPersonsResponse] -> ShowS # | |
data GetAccountPersonsResponseBody200 Source #
Defines the data type for the schema GetAccountPersonsResponseBody200
Constructors
| GetAccountPersonsResponseBody200 | |
Fields
| |
Instances
data GetAccountPersonsResponseBody200Object' Source #
Defines the enum schema GetAccountPersonsResponseBody200Object'
String representing the object's type. Objects of the same type share the same value. Always has the value `list`.
Constructors
| GetAccountPersonsResponseBody200Object'EnumOther Value | |
| GetAccountPersonsResponseBody200Object'EnumTyped String | |
| GetAccountPersonsResponseBody200Object'EnumStringList |