StripeAPI.Operations.GetDisputes

Contains the different functions to run the operation getDisputes

Documentation

getDisputes

Arguments

:: forall m. MonadHTTP m

=> GetDisputesParameters

Contains all available parameters of this operation (query and path parameters)

-> ClientT m (Response GetDisputesResponse)

Monadic computation which returns the result of the operation

GET /v1/disputes

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

data GetDisputesParameters

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

Constructors

GetDisputesParameters

Fields

• getDisputesParametersQueryCharge :: Maybe Text

  queryCharge: Represents the parameter named 'charge'

  Only return disputes associated to the charge specified by this charge ID.

  Constraints:

  • Maximum length of 5000
• getDisputesParametersQueryCreated :: Maybe GetDisputesParametersQueryCreated'Variants

  queryCreated: Represents the parameter named 'created'

• getDisputesParametersQueryEndingBefore :: 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
• getDisputesParametersQueryExpand :: Maybe [Text]

  queryExpand: Represents the parameter named 'expand'

  Specifies which fields in the response should be expanded.

• getDisputesParametersQueryLimit :: 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.

• getDisputesParametersQueryPaymentIntent :: Maybe Text

  queryPayment_intent: Represents the parameter named 'payment_intent'

  Only return disputes associated to the PaymentIntent specified by this PaymentIntent ID.

  Constraints:

  • Maximum length of 5000
• getDisputesParametersQueryStartingAfter :: 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

Instances

Eq GetDisputesParameters

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesParameters -> GetDisputesParameters -> Bool

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

Show GetDisputesParameters

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesParameters -> ShowS

show :: GetDisputesParameters -> String

showList :: [GetDisputesParameters] -> ShowS

ToJSON GetDisputesParameters

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesParameters -> Value

toEncoding :: GetDisputesParameters -> Encoding

toJSONList :: [GetDisputesParameters] -> Value

toEncodingList :: [GetDisputesParameters] -> Encoding

FromJSON GetDisputesParameters

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesParameters

parseJSONList :: Value -> Parser [GetDisputesParameters]

mkGetDisputesParameters :: GetDisputesParameters

Create a new GetDisputesParameters with all required fields.

data GetDisputesParametersQueryCreated'OneOf1

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

Constructors

GetDisputesParametersQueryCreated'OneOf1

Fields

• getDisputesParametersQueryCreated'OneOf1Gt :: Maybe Int

  gt

• getDisputesParametersQueryCreated'OneOf1Gte :: Maybe Int

  gte

• getDisputesParametersQueryCreated'OneOf1Lt :: Maybe Int

  lt

• getDisputesParametersQueryCreated'OneOf1Lte :: Maybe Int

  lte

Instances

Eq GetDisputesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesParametersQueryCreated'OneOf1 -> GetDisputesParametersQueryCreated'OneOf1 -> Bool

(/=) :: GetDisputesParametersQueryCreated'OneOf1 -> GetDisputesParametersQueryCreated'OneOf1 -> Bool

Show GetDisputesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesParametersQueryCreated'OneOf1 -> ShowS

show :: GetDisputesParametersQueryCreated'OneOf1 -> String

showList :: [GetDisputesParametersQueryCreated'OneOf1] -> ShowS

ToJSON GetDisputesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesParametersQueryCreated'OneOf1 -> Value

toEncoding :: GetDisputesParametersQueryCreated'OneOf1 -> Encoding

toJSONList :: [GetDisputesParametersQueryCreated'OneOf1] -> Value

toEncodingList :: [GetDisputesParametersQueryCreated'OneOf1] -> Encoding

FromJSON GetDisputesParametersQueryCreated'OneOf1

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesParametersQueryCreated'OneOf1

parseJSONList :: Value -> Parser [GetDisputesParametersQueryCreated'OneOf1]

mkGetDisputesParametersQueryCreated'OneOf1 :: GetDisputesParametersQueryCreated'OneOf1

Create a new GetDisputesParametersQueryCreated'OneOf1 with all required fields.

data GetDisputesParametersQueryCreated'Variants

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

Represents the parameter named 'created'

Constructors

GetDisputesParametersQueryCreated'GetDisputesParametersQueryCreated'OneOf1 GetDisputesParametersQueryCreated'OneOf1

GetDisputesParametersQueryCreated'Int Int

Instances

Eq GetDisputesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetDisputes

Methods

(==) :: GetDisputesParametersQueryCreated'Variants -> GetDisputesParametersQueryCreated'Variants -> Bool

(/=) :: GetDisputesParametersQueryCreated'Variants -> GetDisputesParametersQueryCreated'Variants -> Bool

Show GetDisputesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetDisputes

Methods

showsPrec :: Int -> GetDisputesParametersQueryCreated'Variants -> ShowS

show :: GetDisputesParametersQueryCreated'Variants -> String

showList :: [GetDisputesParametersQueryCreated'Variants] -> ShowS

ToJSON GetDisputesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetDisputes

Methods

toJSON :: GetDisputesParametersQueryCreated'Variants -> Value

toEncoding :: GetDisputesParametersQueryCreated'Variants -> Encoding

toJSONList :: [GetDisputesParametersQueryCreated'Variants] -> Value

toEncodingList :: [GetDisputesParametersQueryCreated'Variants] -> Encoding

FromJSON GetDisputesParametersQueryCreated'Variants

Defined in StripeAPI.Operations.GetDisputes

Methods

parseJSON :: Value -> Parser GetDisputesParametersQueryCreated'Variants

parseJSONList :: Value -> Parser [GetDisputesParametersQueryCreated'Variants]

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 object schema located at paths./v1/disputes.GET.responses.200.content.application/json.schema in the specification.

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.

• 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]

mkGetDisputesResponseBody200

Arguments

:: [Dispute]

getDisputesResponseBody200Data

-> Bool

getDisputesResponseBody200HasMore

-> Text

getDisputesResponseBody200Url

-> GetDisputesResponseBody200

Create a new GetDisputesResponseBody200 with all required fields.