Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetTreasuryTransactions

Contains the different functions to run the operation getTreasuryTransactions

10 types
6 values

Packagestripeapi-3.0.0.0
Exports16
LanguageHaskell2010
LicenceMIT
SourceGetTreasuryTransactions.hs

valuegetTreasuryTransactions

:: MonadHTTP m
=> GetTreasuryTransactionsParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetTreasuryTransactionsResponse)
Monadic computation which returns the result of the operation

GET /v1/treasury/transactions

<p>Retrieves a list of Transaction objects.</p>

datadata GetTreasuryTransactionsParameters

Defines the object schema located at paths./v1/treasury/transactions.GET.parameters in the specification.

Constructors

GetTreasuryTransactionsParameters
- getTreasuryTransactionsParametersQueryCreated :: Maybe GetTreasuryTransactionsParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
- getTreasuryTransactionsParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named '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
- getTreasuryTransactionsParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getTreasuryTransactionsParametersQueryFinancialAccount :: Text
  queryFinancial_account: Represents the parameter named 'financial_account'
  Returns objects associated with this FinancialAccount.
- getTreasuryTransactionsParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getTreasuryTransactionsParametersQueryOrderBy :: Maybe GetTreasuryTransactionsParametersQueryOrderBy'
  queryOrder_by: Represents the parameter named 'order_by'
  The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
- getTreasuryTransactionsParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named '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
- getTreasuryTransactionsParametersQueryStatus :: Maybe GetTreasuryTransactionsParametersQueryStatus'
  queryStatus: Represents the parameter named 'status'
  Only return Transactions that have the given status: `open`, `posted`, or `void`.
- getTreasuryTransactionsParametersQueryStatusTransitions :: Maybe GetTreasuryTransactionsParametersQueryStatusTransitions'
  queryStatus_transitions: Represents the parameter named 'status_transitions'
  A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

valuemkGetTreasuryTransactionsParameters

:: Text
getTreasuryTransactionsParametersQueryFinancialAccount
-> GetTreasuryTransactionsParameters

Create a new GetTreasuryTransactionsParameters with all required fields.

datadata GetTreasuryTransactionsParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetTreasuryTransactionsParametersQueryCreated'OneOf1
- getTreasuryTransactionsParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getTreasuryTransactionsParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getTreasuryTransactionsParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getTreasuryTransactionsParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

valuemkGetTreasuryTransactionsParametersQueryCreated'OneOf1 :: GetTreasuryTransactionsParametersQueryCreated'OneOf1

Create a new GetTreasuryTransactionsParametersQueryCreated'OneOf1 with all required fields.

datadata GetTreasuryTransactionsParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

Constructors

GetTreasuryTransactionsParametersQueryCreated'GetTreasuryTransactionsParametersQueryCreated'OneOf1 GetTreasuryTransactionsParametersQueryCreated'OneOf1
GetTreasuryTransactionsParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

datadata GetTreasuryTransactionsParametersQueryOrderBy'

Defines the enum schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryOrder_by in the specification.

Represents the parameter named 'order_by'

The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.

Constructors

GetTreasuryTransactionsParametersQueryOrderBy'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryTransactionsParametersQueryOrderBy'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryTransactionsParametersQueryOrderBy'EnumCreated
Represents the JSON value "created"
GetTreasuryTransactionsParametersQueryOrderBy'EnumPostedAt
Represents the JSON value "posted_at"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryOrderBy'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryOrderBy'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryOrderBy'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryOrderBy'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

datadata GetTreasuryTransactionsParametersQueryStatus'

Defines the enum schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryStatus in the specification.

Represents the parameter named 'status'

Only return Transactions that have the given status: `open`, `posted`, or `void`.

Constructors

GetTreasuryTransactionsParametersQueryStatus'Other Value
This case is used if the value encountered during decoding does not match any of the provided cases in the specification.
GetTreasuryTransactionsParametersQueryStatus'Typed Text
This constructor can be used to send values to the server which are not present in the specification yet.
GetTreasuryTransactionsParametersQueryStatus'EnumOpen
Represents the JSON value "open"
GetTreasuryTransactionsParametersQueryStatus'EnumPosted
Represents the JSON value "posted"
GetTreasuryTransactionsParametersQueryStatus'EnumVoid
Represents the JSON value "void"

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryStatus'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

datadata GetTreasuryTransactionsParametersQueryStatusTransitions'

Defines the object schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryStatus_transitions in the specification.

Represents the parameter named 'status_transitions'

A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.

Constructors

GetTreasuryTransactionsParametersQueryStatusTransitions'
- getTreasuryTransactionsParametersQueryStatusTransitions'PostedAt :: Maybe GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'Variants
  posted_at

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryStatusTransitions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryStatusTransitions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryStatusTransitions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryStatusTransitions'Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

valuemkGetTreasuryTransactionsParametersQueryStatusTransitions' :: GetTreasuryTransactionsParametersQueryStatusTransitions'

Create a new GetTreasuryTransactionsParametersQueryStatusTransitions' with all required fields.

datadata GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1

Defines the object schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryStatus_transitions.properties.posted_at.anyOf in the specification.

Constructors

GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

value

mkGetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1 :: GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1

Create a new GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1 with all required fields.

datadata GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'Variants

Defines the oneOf schema located at paths./v1/treasury/transactions.GET.parameters.properties.queryStatus_transitions.properties.posted_at.anyOf in the specification.

Constructors

GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1 GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'OneOf1
GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsParametersQueryStatusTransitions'PostedAt'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

datadata GetTreasuryTransactionsResponse

Represents a response of the operation getTreasuryTransactions.

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), GetTreasuryTransactionsResponseError is used.

Constructors

GetTreasuryTransactionsResponseError String
Means either no matching case available or a parse error
GetTreasuryTransactionsResponse200 GetTreasuryTransactionsResponseBody200
Successful response.
GetTreasuryTransactionsResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetTreasuryTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

datadata GetTreasuryTransactionsResponseBody200

Defines the object schema located at paths./v1/treasury/transactions.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetTreasuryTransactionsResponseBody200
- getTreasuryTransactionsResponseBody200Data :: [Treasury'transaction]
  data: Details about each object.
- getTreasuryTransactionsResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getTreasuryTransactionsResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000

Instances4Eq, Show, FromJSON, ToJSON

Eq GetTreasuryTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
Show GetTreasuryTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
FromJSON GetTreasuryTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions
ToJSON GetTreasuryTransactionsResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetTreasuryTransactions

valuemkGetTreasuryTransactionsResponseBody200

:: [Treasury'transaction]
getTreasuryTransactionsResponseBody200Data
-> Bool
getTreasuryTransactionsResponseBody200HasMore
-> Text
getTreasuryTransactionsResponseBody200Url
-> GetTreasuryTransactionsResponseBody200

Create a new GetTreasuryTransactionsResponseBody200 with all required fields.