| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostSourcesSource
Description
Contains the different functions to run the operation postSourcesSource
Synopsis
- postSourcesSource :: forall m. MonadHTTP m => Text -> Maybe PostSourcesSourceRequestBody -> ClientT m (Response PostSourcesSourceResponse)
- data PostSourcesSourceRequestBody = PostSourcesSourceRequestBody {
- postSourcesSourceRequestBodyAmount :: Maybe Int
- postSourcesSourceRequestBodyExpand :: Maybe [Text]
- postSourcesSourceRequestBodyMandate :: Maybe PostSourcesSourceRequestBodyMandate'
- postSourcesSourceRequestBodyMetadata :: Maybe PostSourcesSourceRequestBodyMetadata'Variants
- postSourcesSourceRequestBodyOwner :: Maybe PostSourcesSourceRequestBodyOwner'
- postSourcesSourceRequestBodySourceOrder :: Maybe PostSourcesSourceRequestBodySourceOrder'
- mkPostSourcesSourceRequestBody :: PostSourcesSourceRequestBody
- data PostSourcesSourceRequestBodyMandate' = PostSourcesSourceRequestBodyMandate' {
- postSourcesSourceRequestBodyMandate'Acceptance :: Maybe PostSourcesSourceRequestBodyMandate'Acceptance'
- postSourcesSourceRequestBodyMandate'Amount :: Maybe PostSourcesSourceRequestBodyMandate'Amount'Variants
- postSourcesSourceRequestBodyMandate'Currency :: Maybe Text
- postSourcesSourceRequestBodyMandate'Interval :: Maybe PostSourcesSourceRequestBodyMandate'Interval'
- postSourcesSourceRequestBodyMandate'NotificationMethod :: Maybe PostSourcesSourceRequestBodyMandate'NotificationMethod'
- mkPostSourcesSourceRequestBodyMandate' :: PostSourcesSourceRequestBodyMandate'
- data PostSourcesSourceRequestBodyMandate'Acceptance' = PostSourcesSourceRequestBodyMandate'Acceptance' {
- postSourcesSourceRequestBodyMandate'Acceptance'Date :: Maybe Int
- postSourcesSourceRequestBodyMandate'Acceptance'Ip :: Maybe Text
- postSourcesSourceRequestBodyMandate'Acceptance'Offline :: Maybe PostSourcesSourceRequestBodyMandate'Acceptance'Offline'
- postSourcesSourceRequestBodyMandate'Acceptance'Online :: Maybe PostSourcesSourceRequestBodyMandate'Acceptance'Online'
- postSourcesSourceRequestBodyMandate'Acceptance'Status :: PostSourcesSourceRequestBodyMandate'Acceptance'Status'
- postSourcesSourceRequestBodyMandate'Acceptance'Type :: Maybe PostSourcesSourceRequestBodyMandate'Acceptance'Type'
- postSourcesSourceRequestBodyMandate'Acceptance'UserAgent :: Maybe Text
- mkPostSourcesSourceRequestBodyMandate'Acceptance' :: PostSourcesSourceRequestBodyMandate'Acceptance'Status' -> PostSourcesSourceRequestBodyMandate'Acceptance'
- data PostSourcesSourceRequestBodyMandate'Acceptance'Offline' = PostSourcesSourceRequestBodyMandate'Acceptance'Offline' {}
- mkPostSourcesSourceRequestBodyMandate'Acceptance'Offline' :: Text -> PostSourcesSourceRequestBodyMandate'Acceptance'Offline'
- data PostSourcesSourceRequestBodyMandate'Acceptance'Online' = PostSourcesSourceRequestBodyMandate'Acceptance'Online' {}
- mkPostSourcesSourceRequestBodyMandate'Acceptance'Online' :: PostSourcesSourceRequestBodyMandate'Acceptance'Online'
- data PostSourcesSourceRequestBodyMandate'Acceptance'Status'
- = PostSourcesSourceRequestBodyMandate'Acceptance'Status'Other Value
- | PostSourcesSourceRequestBodyMandate'Acceptance'Status'Typed Text
- | PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumAccepted
- | PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumPending
- | PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRefused
- | PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRevoked
- data PostSourcesSourceRequestBodyMandate'Acceptance'Type'
- data PostSourcesSourceRequestBodyMandate'Amount'Variants
- data PostSourcesSourceRequestBodyMandate'Interval'
- data PostSourcesSourceRequestBodyMandate'NotificationMethod'
- = PostSourcesSourceRequestBodyMandate'NotificationMethod'Other Value
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'Typed Text
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumDeprecatedNone
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumEmail
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumManual
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumNone
- | PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumStripeEmail
- data PostSourcesSourceRequestBodyMetadata'Variants
- data PostSourcesSourceRequestBodyOwner' = PostSourcesSourceRequestBodyOwner' {}
- mkPostSourcesSourceRequestBodyOwner' :: PostSourcesSourceRequestBodyOwner'
- data PostSourcesSourceRequestBodyOwner'Address' = PostSourcesSourceRequestBodyOwner'Address' {
- postSourcesSourceRequestBodyOwner'Address'City :: Maybe Text
- postSourcesSourceRequestBodyOwner'Address'Country :: Maybe Text
- postSourcesSourceRequestBodyOwner'Address'Line1 :: Maybe Text
- postSourcesSourceRequestBodyOwner'Address'Line2 :: Maybe Text
- postSourcesSourceRequestBodyOwner'Address'PostalCode :: Maybe Text
- postSourcesSourceRequestBodyOwner'Address'State :: Maybe Text
- mkPostSourcesSourceRequestBodyOwner'Address' :: PostSourcesSourceRequestBodyOwner'Address'
- data PostSourcesSourceRequestBodySourceOrder' = PostSourcesSourceRequestBodySourceOrder' {}
- mkPostSourcesSourceRequestBodySourceOrder' :: PostSourcesSourceRequestBodySourceOrder'
- data PostSourcesSourceRequestBodySourceOrder'Items' = PostSourcesSourceRequestBodySourceOrder'Items' {
- postSourcesSourceRequestBodySourceOrder'Items'Amount :: Maybe Int
- postSourcesSourceRequestBodySourceOrder'Items'Currency :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Items'Description :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Items'Parent :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Items'Quantity :: Maybe Int
- postSourcesSourceRequestBodySourceOrder'Items'Type :: Maybe PostSourcesSourceRequestBodySourceOrder'Items'Type'
- mkPostSourcesSourceRequestBodySourceOrder'Items' :: PostSourcesSourceRequestBodySourceOrder'Items'
- data PostSourcesSourceRequestBodySourceOrder'Items'Type'
- = PostSourcesSourceRequestBodySourceOrder'Items'Type'Other Value
- | PostSourcesSourceRequestBodySourceOrder'Items'Type'Typed Text
- | PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumDiscount
- | PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumShipping
- | PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumSku
- | PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumTax
- data PostSourcesSourceRequestBodySourceOrder'Shipping' = PostSourcesSourceRequestBodySourceOrder'Shipping' {
- postSourcesSourceRequestBodySourceOrder'Shipping'Address :: PostSourcesSourceRequestBodySourceOrder'Shipping'Address'
- postSourcesSourceRequestBodySourceOrder'Shipping'Carrier :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Name :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Phone :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'TrackingNumber :: Maybe Text
- mkPostSourcesSourceRequestBodySourceOrder'Shipping' :: PostSourcesSourceRequestBodySourceOrder'Shipping'Address' -> PostSourcesSourceRequestBodySourceOrder'Shipping'
- data PostSourcesSourceRequestBodySourceOrder'Shipping'Address' = PostSourcesSourceRequestBodySourceOrder'Shipping'Address' {
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'City :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'Country :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'Line1 :: Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'Line2 :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'PostalCode :: Maybe Text
- postSourcesSourceRequestBodySourceOrder'Shipping'Address'State :: Maybe Text
- mkPostSourcesSourceRequestBodySourceOrder'Shipping'Address' :: Text -> PostSourcesSourceRequestBodySourceOrder'Shipping'Address'
- data PostSourcesSourceResponse
Documentation
Arguments
| :: forall m. MonadHTTP m | |
| => Text | source | Constraints: Maximum length of 5000 |
| -> Maybe PostSourcesSourceRequestBody | The request body to send |
| -> ClientT m (Response PostSourcesSourceResponse) | Monadic computation which returns the result of the operation |
POST /v1/sources/{source}<p>Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.</p>
<p>This request accepts the <code>metadata</code> and <code>owner</code> as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our <a href="/docs/sources">payment method guides</a> for more detail.</p>
data PostSourcesSourceRequestBody Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema in the specification.
Constructors
| PostSourcesSourceRequestBody | |
Fields
| |
Instances
mkPostSourcesSourceRequestBody :: PostSourcesSourceRequestBody Source #
Create a new PostSourcesSourceRequestBody with all required fields.
data PostSourcesSourceRequestBodyMandate' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate in the specification.
Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status.
Constructors
| PostSourcesSourceRequestBodyMandate' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodyMandate' :: PostSourcesSourceRequestBodyMandate' Source #
Create a new PostSourcesSourceRequestBodyMandate' with all required fields.
data PostSourcesSourceRequestBodyMandate'Acceptance' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Acceptance' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodyMandate'Acceptance' Source #
Arguments
| :: PostSourcesSourceRequestBodyMandate'Acceptance'Status' | |
| -> PostSourcesSourceRequestBodyMandate'Acceptance' |
Create a new PostSourcesSourceRequestBodyMandate'Acceptance' with all required fields.
data PostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.offline in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Acceptance'Offline' | |
Fields | |
Instances
mkPostSourcesSourceRequestBodyMandate'Acceptance'Offline' Source #
Arguments
| :: Text |
|
| -> PostSourcesSourceRequestBodyMandate'Acceptance'Offline' |
Create a new PostSourcesSourceRequestBodyMandate'Acceptance'Offline' with all required fields.
data PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.online in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Acceptance'Online' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodyMandate'Acceptance'Online' :: PostSourcesSourceRequestBodyMandate'Acceptance'Online' Source #
Create a new PostSourcesSourceRequestBodyMandate'Acceptance'Online' with all required fields.
data PostSourcesSourceRequestBodyMandate'Acceptance'Status' Source #
Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.status in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumAccepted | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumPending | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRefused | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Acceptance'Status'EnumRevoked | Represents the JSON value |
Instances
data PostSourcesSourceRequestBodyMandate'Acceptance'Type' Source #
Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.acceptance.properties.type in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Acceptance'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSourcesSourceRequestBodyMandate'Acceptance'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSourcesSourceRequestBodyMandate'Acceptance'Type'EnumOffline | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Acceptance'Type'EnumOnline | Represents the JSON value |
Instances
data PostSourcesSourceRequestBodyMandate'Amount'Variants Source #
Defines the oneOf schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.amount.anyOf in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Amount'EmptyString | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Amount'Int Int |
Instances
data PostSourcesSourceRequestBodyMandate'Interval' Source #
Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.interval in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'Interval'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSourcesSourceRequestBodyMandate'Interval'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSourcesSourceRequestBodyMandate'Interval'EnumOneTime | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Interval'EnumScheduled | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'Interval'EnumVariable | Represents the JSON value |
Instances
data PostSourcesSourceRequestBodyMandate'NotificationMethod' Source #
Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.mandate.properties.notification_method in the specification.
Constructors
| PostSourcesSourceRequestBodyMandate'NotificationMethod'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumDeprecatedNone | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumEmail | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumManual | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumNone | Represents the JSON value |
| PostSourcesSourceRequestBodyMandate'NotificationMethod'EnumStripeEmail | Represents the JSON value |
Instances
data PostSourcesSourceRequestBodyMetadata'Variants Source #
Defines the oneOf schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.metadata.anyOf in the specification.
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
| PostSourcesSourceRequestBodyMetadata'EmptyString | Represents the JSON value |
| PostSourcesSourceRequestBodyMetadata'Object Object |
Instances
data PostSourcesSourceRequestBodyOwner' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.owner in the specification.
Information about the owner of the payment instrument that may be used or required by particular source types.
Constructors
| PostSourcesSourceRequestBodyOwner' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodyOwner' :: PostSourcesSourceRequestBodyOwner' Source #
Create a new PostSourcesSourceRequestBodyOwner' with all required fields.
data PostSourcesSourceRequestBodyOwner'Address' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.owner.properties.address in the specification.
Constructors
| PostSourcesSourceRequestBodyOwner'Address' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodyOwner'Address' :: PostSourcesSourceRequestBodyOwner'Address' Source #
Create a new PostSourcesSourceRequestBodyOwner'Address' with all required fields.
data PostSourcesSourceRequestBodySourceOrder' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order in the specification.
Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it.
Constructors
| PostSourcesSourceRequestBodySourceOrder' | |
Instances
mkPostSourcesSourceRequestBodySourceOrder' :: PostSourcesSourceRequestBodySourceOrder' Source #
Create a new PostSourcesSourceRequestBodySourceOrder' with all required fields.
data PostSourcesSourceRequestBodySourceOrder'Items' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.items.items in the specification.
Constructors
| PostSourcesSourceRequestBodySourceOrder'Items' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodySourceOrder'Items' :: PostSourcesSourceRequestBodySourceOrder'Items' Source #
Create a new PostSourcesSourceRequestBodySourceOrder'Items' with all required fields.
data PostSourcesSourceRequestBodySourceOrder'Items'Type' Source #
Defines the enum schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.items.items.properties.type in the specification.
Constructors
| PostSourcesSourceRequestBodySourceOrder'Items'Type'Other Value | This case is used if the value encountered during decoding does not match any of the provided cases in the specification. |
| PostSourcesSourceRequestBodySourceOrder'Items'Type'Typed Text | This constructor can be used to send values to the server which are not present in the specification yet. |
| PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumDiscount | Represents the JSON value |
| PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumShipping | Represents the JSON value |
| PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumSku | Represents the JSON value |
| PostSourcesSourceRequestBodySourceOrder'Items'Type'EnumTax | Represents the JSON value |
Instances
data PostSourcesSourceRequestBodySourceOrder'Shipping' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.shipping in the specification.
Constructors
| PostSourcesSourceRequestBodySourceOrder'Shipping' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodySourceOrder'Shipping' Source #
Arguments
| :: PostSourcesSourceRequestBodySourceOrder'Shipping'Address' | |
| -> PostSourcesSourceRequestBodySourceOrder'Shipping' |
Create a new PostSourcesSourceRequestBodySourceOrder'Shipping' with all required fields.
data PostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source #
Defines the object schema located at paths./v1/sources/{source}.POST.requestBody.content.application/x-www-form-urlencoded.schema.properties.source_order.properties.shipping.properties.address in the specification.
Constructors
| PostSourcesSourceRequestBodySourceOrder'Shipping'Address' | |
Fields
| |
Instances
mkPostSourcesSourceRequestBodySourceOrder'Shipping'Address' Source #
Arguments
| :: Text |
|
| -> PostSourcesSourceRequestBodySourceOrder'Shipping'Address' |
Create a new PostSourcesSourceRequestBodySourceOrder'Shipping'Address' with all required fields.
data PostSourcesSourceResponse Source #
Represents a response of the operation postSourcesSource.
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), PostSourcesSourceResponseError is used.
Constructors
| PostSourcesSourceResponseError String | Means either no matching case available or a parse error |
| PostSourcesSourceResponse200 Source | Successful response. |
| PostSourcesSourceResponseDefault Error | Error response. |
Instances
| Eq PostSourcesSourceResponse Source # | |
Defined in StripeAPI.Operations.PostSourcesSource Methods (==) :: PostSourcesSourceResponse -> PostSourcesSourceResponse -> Bool # (/=) :: PostSourcesSourceResponse -> PostSourcesSourceResponse -> Bool # | |
| Show PostSourcesSourceResponse Source # | |
Defined in StripeAPI.Operations.PostSourcesSource Methods showsPrec :: Int -> PostSourcesSourceResponse -> ShowS # show :: PostSourcesSourceResponse -> String # showList :: [PostSourcesSourceResponse] -> ShowS # | |