Safe Haskell	None
Language	Haskell2010

StripeAPI.Operations.PostChargesChargeDispute

Description

Contains the different functions to run the operation postChargesChargeDispute

Synopsis

postChargesChargeDispute :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeDisputeRequestBody -> m (Either HttpException (Response PostChargesChargeDisputeResponse))
postChargesChargeDisputeRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Text -> Maybe PostChargesChargeDisputeRequestBody -> m (Either HttpException (Response ByteString))
postChargesChargeDisputeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeDisputeResponse))
postChargesChargeDisputeRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
data PostChargesChargeDisputeRequestBody = PostChargesChargeDisputeRequestBody {
}
data PostChargesChargeDisputeRequestBodyEvidence' = PostChargesChargeDisputeRequestBodyEvidence' {
}
data PostChargesChargeDisputeRequestBodyMetadata' = PostChargesChargeDisputeRequestBodyMetadata' {
}
data PostChargesChargeDisputeResponse

Documentation

postChargesChargeDispute Source #

Arguments

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

POST /v1/charges/{charge}/dispute

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

POST /v1/charges/{charge}/dispute

The same as postChargesChargeDispute but returns the raw ByteString

postChargesChargeDisputeM :: forall m s. (MonadHTTP m, SecurityScheme s) => Text -> Maybe PostChargesChargeDisputeRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostChargesChargeDisputeResponse)) Source #

POST /v1/charges/{charge}/dispute

Monadic version of postChargesChargeDispute (use with runWithConfiguration)

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

POST /v1/charges/{charge}/dispute

Monadic version of postChargesChargeDisputeRaw (use with runWithConfiguration)

data PostChargesChargeDisputeRequestBody Source #

Defines the data type for the schema postChargesChargeDisputeRequestBody

Constructors

PostChargesChargeDisputeRequestBody

Fields

postChargesChargeDisputeRequestBodyEvidence :: Maybe PostChargesChargeDisputeRequestBodyEvidence'
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.
postChargesChargeDisputeRequestBodyExpand :: Maybe ([] Text)
expand: Specifies which fields in the response should be expanded.
postChargesChargeDisputeRequestBodyMetadata :: Maybe PostChargesChargeDisputeRequestBodyMetadata'
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`.
postChargesChargeDisputeRequestBodySubmit :: 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 PostChargesChargeDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeDispute Methods (==) :: PostChargesChargeDisputeRequestBody -> PostChargesChargeDisputeRequestBody -> Bool # (/=) :: PostChargesChargeDisputeRequestBody -> PostChargesChargeDisputeRequestBody -> Bool #
Show PostChargesChargeDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeDispute Methods showsPrec :: Int -> PostChargesChargeDisputeRequestBody -> ShowS # show :: PostChargesChargeDisputeRequestBody -> String # showList :: [PostChargesChargeDisputeRequestBody] -> ShowS #
ToJSON PostChargesChargeDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeDispute Methods toJSON :: PostChargesChargeDisputeRequestBody -> Value # toEncoding :: PostChargesChargeDisputeRequestBody -> Encoding # toJSONList :: [PostChargesChargeDisputeRequestBody] -> Value # toEncodingList :: [PostChargesChargeDisputeRequestBody] -> Encoding #
FromJSON PostChargesChargeDisputeRequestBody Source #
Instance details Defined in StripeAPI.Operations.PostChargesChargeDispute Methods parseJSON :: Value -> Parser PostChargesChargeDisputeRequestBody # parseJSONList :: Value -> Parser [PostChargesChargeDisputeRequestBody] #

data PostChargesChargeDisputeRequestBodyEvidence' Source #

Defines the data type for the schema postChargesChargeDisputeRequestBodyEvidence'

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

PostChargesChargeDisputeRequestBodyEvidence'

Fields

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

Instances

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

data PostChargesChargeDisputeRequestBodyMetadata' Source #

Defines the data type for the schema postChargesChargeDisputeRequestBodyMetadata'

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

PostChargesChargeDisputeRequestBodyMetadata'

Instances

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

data PostChargesChargeDisputeResponse Source #

Represents a response of the operation postChargesChargeDispute.

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

Constructors

PostChargesChargeDisputeResponseError String	Means either no matching case available or a parse error
PostChargesChargeDisputeResponse200 Dispute	Successful response.
PostChargesChargeDisputeResponseDefault Error	Error response.

Instances

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