| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
StripeAPI.Operations.PostCustomers
Description
Contains the different functions to run the operation postCustomers
Synopsis
- postCustomers :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostCustomersRequestBody -> m (Either HttpException (Response PostCustomersResponse))
- postCustomersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostCustomersRequestBody -> m (Either HttpException (Response ByteString))
- postCustomersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersResponse))
- postCustomersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))
- data PostCustomersRequestBody = PostCustomersRequestBody {
- postCustomersRequestBodyAddress :: Maybe PostCustomersRequestBodyAddress'Variants
- postCustomersRequestBodyBalance :: Maybe Integer
- postCustomersRequestBodyCoupon :: Maybe Text
- postCustomersRequestBodyDescription :: Maybe Text
- postCustomersRequestBodyEmail :: Maybe Text
- postCustomersRequestBodyExpand :: Maybe ([] Text)
- postCustomersRequestBodyInvoicePrefix :: Maybe Text
- postCustomersRequestBodyInvoiceSettings :: Maybe PostCustomersRequestBodyInvoiceSettings'
- postCustomersRequestBodyMetadata :: Maybe PostCustomersRequestBodyMetadata'
- postCustomersRequestBodyName :: Maybe Text
- postCustomersRequestBodyNextInvoiceSequence :: Maybe Integer
- postCustomersRequestBodyPaymentMethod :: Maybe Text
- postCustomersRequestBodyPhone :: Maybe Text
- postCustomersRequestBodyPreferredLocales :: Maybe ([] Text)
- postCustomersRequestBodyShipping :: Maybe PostCustomersRequestBodyShipping'Variants
- postCustomersRequestBodySource :: Maybe Text
- postCustomersRequestBodyTaxExempt :: Maybe PostCustomersRequestBodyTaxExempt'
- postCustomersRequestBodyTaxIdData :: Maybe ([] PostCustomersRequestBodyTaxIdData')
- data PostCustomersRequestBodyAddress'OneOf1
- data PostCustomersRequestBodyAddress'OneOf2 = PostCustomersRequestBodyAddress'OneOf2 {
- postCustomersRequestBodyAddress'OneOf2City :: Maybe Text
- postCustomersRequestBodyAddress'OneOf2Country :: Maybe Text
- postCustomersRequestBodyAddress'OneOf2Line1 :: Text
- postCustomersRequestBodyAddress'OneOf2Line2 :: Maybe Text
- postCustomersRequestBodyAddress'OneOf2PostalCode :: Maybe Text
- postCustomersRequestBodyAddress'OneOf2State :: Maybe Text
- data PostCustomersRequestBodyAddress'Variants
- data PostCustomersRequestBodyInvoiceSettings' = PostCustomersRequestBodyInvoiceSettings' {}
- data PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1
- data PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2 = PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2 {}
- data PostCustomersRequestBodyInvoiceSettings'CustomFields'Variants
- = PostCustomersRequestBodyInvoiceSettings'CustomFields'PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1 PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1
- | PostCustomersRequestBodyInvoiceSettings'CustomFields'ListPostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2 ([] PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2)
- data PostCustomersRequestBodyMetadata' = PostCustomersRequestBodyMetadata' {
- data PostCustomersRequestBodyShipping'OneOf1
- data PostCustomersRequestBodyShipping'OneOf2 = PostCustomersRequestBodyShipping'OneOf2 {}
- data PostCustomersRequestBodyShipping'OneOf2Address' = PostCustomersRequestBodyShipping'OneOf2Address' {
- postCustomersRequestBodyShipping'OneOf2Address'City :: Maybe Text
- postCustomersRequestBodyShipping'OneOf2Address'Country :: Maybe Text
- postCustomersRequestBodyShipping'OneOf2Address'Line1 :: Text
- postCustomersRequestBodyShipping'OneOf2Address'Line2 :: Maybe Text
- postCustomersRequestBodyShipping'OneOf2Address'PostalCode :: Maybe Text
- postCustomersRequestBodyShipping'OneOf2Address'State :: Maybe Text
- data PostCustomersRequestBodyShipping'Variants
- data PostCustomersRequestBodyTaxExempt'
- = PostCustomersRequestBodyTaxExempt'EnumOther Value
- | PostCustomersRequestBodyTaxExempt'EnumTyped Text
- | PostCustomersRequestBodyTaxExempt'EnumString_
- | PostCustomersRequestBodyTaxExempt'EnumStringExempt
- | PostCustomersRequestBodyTaxExempt'EnumStringNone
- | PostCustomersRequestBodyTaxExempt'EnumStringReverse
- data PostCustomersRequestBodyTaxIdData' = PostCustomersRequestBodyTaxIdData' {}
- data PostCustomersRequestBodyTaxIdData'Type'
- = PostCustomersRequestBodyTaxIdData'Type'EnumOther Value
- | PostCustomersRequestBodyTaxIdData'Type'EnumTyped Text
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringAuAbn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringCaBn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringCaQst
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringChVat
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringEsCif
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringEuVat
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringHkBr
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringInGst
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringJpCn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringKrBrn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringLiUid
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringMxRfc
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringMyItn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringMySst
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringNoVat
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringNzGst
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringRuInn
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringSgUen
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringThVat
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringTwVat
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringUsEin
- | PostCustomersRequestBodyTaxIdData'Type'EnumStringZaVat
- data PostCustomersResponse
Documentation
Arguments
| :: (MonadHTTP m, SecurityScheme s) | |
| => Configuration s | The configuration to use in the request |
| -> Maybe PostCustomersRequestBody | The request body to send |
| -> m (Either HttpException (Response PostCustomersResponse)) | Monad containing the result of the operation |
POST /v1/customers
<p>Creates a new customer object.</p>
postCustomersRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe PostCustomersRequestBody -> m (Either HttpException (Response ByteString)) Source #
POST /v1/customers
The same as postCustomers but returns the raw ByteString
postCustomersM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response PostCustomersResponse)) Source #
POST /v1/customers
Monadic version of postCustomers (use with runWithConfiguration)
postCustomersRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe PostCustomersRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString)) Source #
POST /v1/customers
Monadic version of postCustomersRaw (use with runWithConfiguration)
data PostCustomersRequestBody Source #
Defines the data type for the schema postCustomersRequestBody
Constructors
| PostCustomersRequestBody | |
Fields
| |
Instances
| Eq PostCustomersRequestBody Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods (==) :: PostCustomersRequestBody -> PostCustomersRequestBody -> Bool # (/=) :: PostCustomersRequestBody -> PostCustomersRequestBody -> Bool # | |
| Show PostCustomersRequestBody Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods showsPrec :: Int -> PostCustomersRequestBody -> ShowS # show :: PostCustomersRequestBody -> String # showList :: [PostCustomersRequestBody] -> ShowS # | |
| ToJSON PostCustomersRequestBody Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods toJSON :: PostCustomersRequestBody -> Value # toEncoding :: PostCustomersRequestBody -> Encoding # toJSONList :: [PostCustomersRequestBody] -> Value # | |
| FromJSON PostCustomersRequestBody Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods parseJSON :: Value -> Parser PostCustomersRequestBody # parseJSONList :: Value -> Parser [PostCustomersRequestBody] # | |
data PostCustomersRequestBodyAddress'OneOf1 Source #
Defines the enum schema postCustomersRequestBodyAddress'OneOf1
Constructors
| PostCustomersRequestBodyAddress'OneOf1EnumOther Value | |
| PostCustomersRequestBodyAddress'OneOf1EnumTyped Text | |
| PostCustomersRequestBodyAddress'OneOf1EnumString_ |
Instances
data PostCustomersRequestBodyAddress'OneOf2 Source #
Defines the data type for the schema postCustomersRequestBodyAddress'OneOf2
Constructors
| PostCustomersRequestBodyAddress'OneOf2 | |
Fields
| |
Instances
data PostCustomersRequestBodyAddress'Variants Source #
Define the one-of schema postCustomersRequestBodyAddress'
The customer's address.
Constructors
Instances
data PostCustomersRequestBodyInvoiceSettings' Source #
Defines the data type for the schema postCustomersRequestBodyInvoice_settings'
Default invoice settings for this customer.
Constructors
| PostCustomersRequestBodyInvoiceSettings' | |
Fields
| |
Instances
data PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf1 Source #
Defines the enum schema postCustomersRequestBodyInvoice_settings'Custom_fields'OneOf1
Constructors
Instances
data PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2 Source #
Defines the data type for the schema postCustomersRequestBodyInvoice_settings'Custom_fields'OneOf2
Constructors
| PostCustomersRequestBodyInvoiceSettings'CustomFields'OneOf2 | |
Fields
| |
Instances
data PostCustomersRequestBodyInvoiceSettings'CustomFields'Variants Source #
Define the one-of schema postCustomersRequestBodyInvoice_settings'Custom_fields'
Constructors
Instances
data PostCustomersRequestBodyMetadata' Source #
Defines the data type for the schema postCustomersRequestBodyMetadata'
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
| PostCustomersRequestBodyMetadata' | |
Instances
data PostCustomersRequestBodyShipping'OneOf1 Source #
Defines the enum schema postCustomersRequestBodyShipping'OneOf1
Constructors
| PostCustomersRequestBodyShipping'OneOf1EnumOther Value | |
| PostCustomersRequestBodyShipping'OneOf1EnumTyped Text | |
| PostCustomersRequestBodyShipping'OneOf1EnumString_ |
Instances
data PostCustomersRequestBodyShipping'OneOf2 Source #
Defines the data type for the schema postCustomersRequestBodyShipping'OneOf2
Constructors
| PostCustomersRequestBodyShipping'OneOf2 | |
Fields
| |
Instances
data PostCustomersRequestBodyShipping'OneOf2Address' Source #
Defines the data type for the schema postCustomersRequestBodyShipping'OneOf2Address'
Constructors
| PostCustomersRequestBodyShipping'OneOf2Address' | |
Fields
| |
Instances
data PostCustomersRequestBodyShipping'Variants Source #
Define the one-of schema postCustomersRequestBodyShipping'
The customer's shipping information. Appears on invoices emailed to this customer.
Constructors
Instances
data PostCustomersRequestBodyTaxExempt' Source #
Defines the enum schema postCustomersRequestBodyTax_exempt'
The customer's tax exemption. One of `none`, `exempt`, or `reverse`.
Constructors
Instances
data PostCustomersRequestBodyTaxIdData' Source #
Defines the data type for the schema postCustomersRequestBodyTax_id_data'
Constructors
| PostCustomersRequestBodyTaxIdData' | |
Fields
| |
Instances
data PostCustomersRequestBodyTaxIdData'Type' Source #
Defines the enum schema postCustomersRequestBodyTax_id_data'Type'
Constructors
Instances
data PostCustomersResponse Source #
Represents a response of the operation postCustomers.
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), PostCustomersResponseError is used.
Constructors
| PostCustomersResponseError String | Means either no matching case available or a parse error |
| PostCustomersResponse200 Customer | Successful response. |
| PostCustomersResponseDefault Error | Error response. |
Instances
| Eq PostCustomersResponse Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods (==) :: PostCustomersResponse -> PostCustomersResponse -> Bool # (/=) :: PostCustomersResponse -> PostCustomersResponse -> Bool # | |
| Show PostCustomersResponse Source # | |
Defined in StripeAPI.Operations.PostCustomers Methods showsPrec :: Int -> PostCustomersResponse -> ShowS # show :: PostCustomersResponse -> String # showList :: [PostCustomersResponse] -> ShowS # | |