StripeAPI.Operations.GetDisputes

Contains the different functions to run the operation getDisputes

Documentation

getDisputes

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe Text

charge: Only return disputes associated to the charge specified by this charge ID. | Constraints: Maximum length of 5000

-> Maybe Text

created

-> Maybe Text

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 Text

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 Text

payment_intent: Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID. | Constraints: Maximum length of 5000

-> Maybe Text

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

-> Maybe GetDisputesRequestBody

The request body to send

-> m (Either HttpException (Response GetDisputesResponse))

Monad containing the result of the operation

GET /v1/disputes

<p>Returns a list of your disputes.</p>

getDisputesRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetDisputesRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/disputes

The same as getDisputes but returns the raw ByteString

getDisputesM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetDisputesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetDisputesResponse))

GET /v1/disputes

Monadic version of getDisputes (use with runWithConfiguration)

getDisputesRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe Text -> Maybe Text -> Maybe Text -> Maybe Text -> Maybe Integer -> Maybe Text -> Maybe Text -> Maybe GetDisputesRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/disputes

Monadic version of getDisputesRaw (use with runWithConfiguration)

data GetDisputesRequestBody

Defines the data type for the schema getDisputesRequestBody

Constructors

GetDisputesRequestBody

Instances

Eq GetDisputesRequestBody

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesRequestBody -> GetDisputesRequestBody -> Bool

(/=) :: GetDisputesRequestBody -> GetDisputesRequestBody -> Bool

Show GetDisputesRequestBody

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesRequestBody -> ShowS

show :: GetDisputesRequestBody -> String

showList :: [GetDisputesRequestBody] -> ShowS

ToJSON GetDisputesRequestBody

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesRequestBody -> Value

toEncoding :: GetDisputesRequestBody -> Encoding

toJSONList :: [GetDisputesRequestBody] -> Value

toEncodingList :: [GetDisputesRequestBody] -> Encoding

FromJSON GetDisputesRequestBody

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesRequestBody

parseJSONList :: Value -> Parser [GetDisputesRequestBody]

data GetDisputesResponse

Represents a response of the operation getDisputes.

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

Constructors

GetDisputesResponseError String

Means either no matching case available or a parse error

GetDisputesResponse200 GetDisputesResponseBody200

Successful response.

GetDisputesResponseDefault Error

Error response.

Instances

Eq GetDisputesResponse

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesResponse -> GetDisputesResponse -> Bool

(/=) :: GetDisputesResponse -> GetDisputesResponse -> Bool

Show GetDisputesResponse

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesResponse -> ShowS

show :: GetDisputesResponse -> String

showList :: [GetDisputesResponse] -> ShowS

data GetDisputesResponseBody200

Defines the data type for the schema GetDisputesResponseBody200

Constructors

GetDisputesResponseBody200

Fields

• getDisputesResponseBody200Data :: [] Dispute

  data

• getDisputesResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getDisputesResponseBody200Object :: GetDisputesResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getDisputesResponseBody200Url :: Text

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/disputes'

Instances

Eq GetDisputesResponseBody200

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesResponseBody200 -> GetDisputesResponseBody200 -> Bool

(/=) :: GetDisputesResponseBody200 -> GetDisputesResponseBody200 -> Bool

Show GetDisputesResponseBody200

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesResponseBody200 -> ShowS

show :: GetDisputesResponseBody200 -> String

showList :: [GetDisputesResponseBody200] -> ShowS

ToJSON GetDisputesResponseBody200

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesResponseBody200 -> Value

toEncoding :: GetDisputesResponseBody200 -> Encoding

toJSONList :: [GetDisputesResponseBody200] -> Value

toEncodingList :: [GetDisputesResponseBody200] -> Encoding

FromJSON GetDisputesResponseBody200

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesResponseBody200

parseJSONList :: Value -> Parser [GetDisputesResponseBody200]

data GetDisputesResponseBody200Object'

Defines the enum schema GetDisputesResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetDisputesResponseBody200Object'EnumOther Value

GetDisputesResponseBody200Object'EnumTyped Text

GetDisputesResponseBody200Object'EnumStringList

Instances

Eq GetDisputesResponseBody200Object'

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesResponseBody200Object' -> GetDisputesResponseBody200Object' -> Bool

(/=) :: GetDisputesResponseBody200Object' -> GetDisputesResponseBody200Object' -> Bool

Show GetDisputesResponseBody200Object'

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesResponseBody200Object' -> ShowS

show :: GetDisputesResponseBody200Object' -> String

showList :: [GetDisputesResponseBody200Object'] -> ShowS

ToJSON GetDisputesResponseBody200Object'

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesResponseBody200Object' -> Value

toEncoding :: GetDisputesResponseBody200Object' -> Encoding

toJSONList :: [GetDisputesResponseBody200Object'] -> Value

toEncodingList :: [GetDisputesResponseBody200Object'] -> Encoding

FromJSON GetDisputesResponseBody200Object'

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesResponseBody200Object'

parseJSONList :: Value -> Parser [GetDisputesResponseBody200Object']