Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostDisputesDispute

Description

Contains the different functions to run the operation postDisputesDispute

Synopsis

postDisputesDispute :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostDisputesDisputeRequestBody -> m (Either HttpException (Response PostDisputesDisputeResponse))
postDisputesDisputeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostDisputesDisputeRequestBody -> m (Either HttpException (Response ByteString))
postDisputesDisputeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostDisputesDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostDisputesDisputeResponse))
postDisputesDisputeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostDisputesDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostDisputesDisputeRequestBody = PostDisputesDisputeRequestBody {
}
data PostDisputesDisputeRequestBodyEvidence' = PostDisputesDisputeRequestBodyEvidence' {
}
data PostDisputesDisputeRequestBodyMetadata' = PostDisputesDisputeRequestBodyMetadata' {
}
data PostDisputesDisputeResponse

Documentation

postDisputesDispute Source #

Arguments

:: (MonadHTTP m, SecurityScheme s)
=> Configuration s	The configuration to use in the request
-> Text	dispute \| Constraints: Maximum length of 5000
-> Maybe PostDisputesDisputeRequestBody	The request body to send
-> m (Either HttpException (Response PostDisputesDisputeResponse))	Monad containing the result of the operation

POST /v1/disputes/{dispute}

<p>When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your <a href="https://dashboard.stripe.com/disputes">dashboard</a>, but if you prefer, you can use the API to submit evidence programmatically.</p>

<p>Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our <a href="/docs/disputes/categories">guide to dispute types</a>.</p>

postDisputesDisputeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostDisputesDisputeRequestBody -> m (Either HttpException (Response ByteString)) Source #

POST /v1/disputes/{dispute}

The same as postDisputesDispute but returns the raw ByteString

postDisputesDisputeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostDisputesDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostDisputesDisputeResponse)) Source #

POST /v1/disputes/{dispute}

Monadic version of postDisputesDispute (use with runWithConfiguration)

postDisputesDisputeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostDisputesDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #

POST /v1/disputes/{dispute}

Monadic version of postDisputesDisputeRaw (use with runWithConfiguration)

data PostDisputesDisputeRequestBody Source #

Defines the data type for the schema postDisputesDisputeRequestBody

Constructors

PostDisputesDisputeRequestBody

Fields

postDisputesDisputeRequestBodyEvidence :: Maybe PostDisputesDisputeRequestBodyEvidence'
evidence: Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.
postDisputesDisputeRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postDisputesDisputeRequestBodyMetadata :: Maybe PostDisputesDisputeRequestBodyMetadata'
metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
postDisputesDisputeRequestBodySubmit :: Maybe Bool
submit: Whether to immediately submit evidence to the bank. If `false`, evidence is staged on the dispute. Staged evidence is visible in the API and Dashboard, and can be submitted to the bank by making another request with this attribute set to `true` (the default).

Instances

Eq PostDisputesDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods (==) :: PostDisputesDisputeRequestBody -> PostDisputesDisputeRequestBody -> Bool # (/=) :: PostDisputesDisputeRequestBody -> PostDisputesDisputeRequestBody -> Bool #
Show PostDisputesDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods showsPrec :: Int -> PostDisputesDisputeRequestBody -> ShowS # show :: PostDisputesDisputeRequestBody -> String # showList :: [PostDisputesDisputeRequestBody] -> ShowS #
ToJSON PostDisputesDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods toJSON :: PostDisputesDisputeRequestBody -> Value # toEncoding :: PostDisputesDisputeRequestBody -> Encoding # toJSONList :: [PostDisputesDisputeRequestBody] -> Value # toEncodingList :: [PostDisputesDisputeRequestBody] -> Encoding #
FromJSON PostDisputesDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods parseJSON :: Value -> Parser PostDisputesDisputeRequestBody # parseJSONList :: Value -> Parser [PostDisputesDisputeRequestBody] #

data PostDisputesDisputeRequestBodyEvidence' Source #

Defines the data type for the schema postDisputesDisputeRequestBodyEvidence'

Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000.

Constructors

PostDisputesDisputeRequestBodyEvidence'

Fields

postDisputesDisputeRequestBodyEvidence'AccessActivityLog :: Maybe Text
access_activity_log
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'BillingAddress :: Maybe Text
billing_address
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'CancellationPolicy :: Maybe Text
cancellation_policy
postDisputesDisputeRequestBodyEvidence'CancellationPolicyDisclosure :: Maybe Text
cancellation_policy_disclosure
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'CancellationRebuttal :: Maybe Text
cancellation_rebuttal
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'CustomerCommunication :: Maybe Text
customer_communication
postDisputesDisputeRequestBodyEvidence'CustomerEmailAddress :: Maybe Text
customer_email_address
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'CustomerName :: Maybe Text
customer_name
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'CustomerPurchaseIp :: Maybe Text
customer_purchase_ip
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'CustomerSignature :: Maybe Text
customer_signature
postDisputesDisputeRequestBodyEvidence'DuplicateChargeDocumentation :: Maybe Text
duplicate_charge_documentation
postDisputesDisputeRequestBodyEvidence'DuplicateChargeExplanation :: Maybe Text
duplicate_charge_explanation
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'DuplicateChargeId :: Maybe Text
duplicate_charge_id
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'ProductDescription :: Maybe Text
product_description
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'Receipt :: Maybe Text
receipt
postDisputesDisputeRequestBodyEvidence'RefundPolicy :: Maybe Text
refund_policy
postDisputesDisputeRequestBodyEvidence'RefundPolicyDisclosure :: Maybe Text
refund_policy_disclosure
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'RefundRefusalExplanation :: Maybe Text
refund_refusal_explanation
Constraints:
- Maximum length of 20000
postDisputesDisputeRequestBodyEvidence'ServiceDate :: Maybe Text
service_date
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'ServiceDocumentation :: Maybe Text
service_documentation
postDisputesDisputeRequestBodyEvidence'ShippingAddress :: Maybe Text
shipping_address
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'ShippingCarrier :: Maybe Text
shipping_carrier
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'ShippingDate :: Maybe Text
shipping_date
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'ShippingDocumentation :: Maybe Text
shipping_documentation
postDisputesDisputeRequestBodyEvidence'ShippingTrackingNumber :: Maybe Text
shipping_tracking_number
Constraints:
- Maximum length of 5000
postDisputesDisputeRequestBodyEvidence'UncategorizedFile :: Maybe Text
uncategorized_file
postDisputesDisputeRequestBodyEvidence'UncategorizedText :: Maybe Text
uncategorized_text
Constraints:
- Maximum length of 20000

Instances

Eq PostDisputesDisputeRequestBodyEvidence' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods (==) :: PostDisputesDisputeRequestBodyEvidence' -> PostDisputesDisputeRequestBodyEvidence' -> Bool # (/=) :: PostDisputesDisputeRequestBodyEvidence' -> PostDisputesDisputeRequestBodyEvidence' -> Bool #
Show PostDisputesDisputeRequestBodyEvidence' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods showsPrec :: Int -> PostDisputesDisputeRequestBodyEvidence' -> ShowS # show :: PostDisputesDisputeRequestBodyEvidence' -> String # showList :: [PostDisputesDisputeRequestBodyEvidence'] -> ShowS #
ToJSON PostDisputesDisputeRequestBodyEvidence' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods toJSON :: PostDisputesDisputeRequestBodyEvidence' -> Value # toEncoding :: PostDisputesDisputeRequestBodyEvidence' -> Encoding # toJSONList :: [PostDisputesDisputeRequestBodyEvidence'] -> Value # toEncodingList :: [PostDisputesDisputeRequestBodyEvidence'] -> Encoding #
FromJSON PostDisputesDisputeRequestBodyEvidence' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods parseJSON :: Value -> Parser PostDisputesDisputeRequestBodyEvidence' # parseJSONList :: Value -> Parser [PostDisputesDisputeRequestBodyEvidence'] #

data PostDisputesDisputeRequestBodyMetadata' Source #

Defines the data type for the schema postDisputesDisputeRequestBodyMetadata'

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.

Constructors

PostDisputesDisputeRequestBodyMetadata'

Instances

Eq PostDisputesDisputeRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods (==) :: PostDisputesDisputeRequestBodyMetadata' -> PostDisputesDisputeRequestBodyMetadata' -> Bool # (/=) :: PostDisputesDisputeRequestBodyMetadata' -> PostDisputesDisputeRequestBodyMetadata' -> Bool #
Show PostDisputesDisputeRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods showsPrec :: Int -> PostDisputesDisputeRequestBodyMetadata' -> ShowS # show :: PostDisputesDisputeRequestBodyMetadata' -> String # showList :: [PostDisputesDisputeRequestBodyMetadata'] -> ShowS #
ToJSON PostDisputesDisputeRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods toJSON :: PostDisputesDisputeRequestBodyMetadata' -> Value # toEncoding :: PostDisputesDisputeRequestBodyMetadata' -> Encoding # toJSONList :: [PostDisputesDisputeRequestBodyMetadata'] -> Value # toEncodingList :: [PostDisputesDisputeRequestBodyMetadata'] -> Encoding #
FromJSON PostDisputesDisputeRequestBodyMetadata' Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods parseJSON :: Value -> Parser PostDisputesDisputeRequestBodyMetadata' # parseJSONList :: Value -> Parser [PostDisputesDisputeRequestBodyMetadata'] #

data PostDisputesDisputeResponse Source #

Represents a response of the operation postDisputesDispute.

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

Constructors

PostDisputesDisputeResponseError String	Means either no matching case available or a parse error
PostDisputesDisputeResponse200 Dispute	Successful response.
PostDisputesDisputeResponseDefault Error	Error response.

Instances

Eq PostDisputesDisputeResponse Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods (==) :: PostDisputesDisputeResponse -> PostDisputesDisputeResponse -> Bool # (/=) :: PostDisputesDisputeResponse -> PostDisputesDisputeResponse -> Bool #
Show PostDisputesDisputeResponse Source #
Instance details Defined in StripeAPI.Operations.PostDisputesDispute Methods showsPrec :: Int -> PostDisputesDisputeResponse -> ShowS # show :: PostDisputesDisputeResponse -> String # showList :: [PostDisputesDisputeResponse] -> ShowS #