StripeAPI.Operations.GetIssuingCards

Contains the different functions to run the operation getIssuingCards

Documentation

getIssuingCards

Arguments

:: (MonadHTTP m, SecurityScheme s)

=> Configuration s

The configuration to use in the request

-> Maybe String

cardholder: Only return cards belonging to the Cardholder with the provided ID. | Constraints: Maximum length of 5000

-> Maybe String

created: Only return cards that were issued during the given date interval.

-> Maybe String

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

-> Maybe Integer

exp_month: Only return cards that have the given expiration month.

-> Maybe Integer

exp_year: Only return cards that have the given expiration year.

-> Maybe String

expand: Specifies which fields in the response should be expanded.

-> Maybe String

last4: Only return cards that have the given last four digits. | Constraints: Maximum length of 5000

-> Maybe Integer

limit: A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

-> Maybe String

name: Only return cards that have the given name. | Constraints: Maximum length of 5000

-> Maybe String

source: Only return cards whose full card number matches that of this card source ID. | Constraints: Maximum length of 5000

-> Maybe String

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

-> Maybe String

status: Only return cards that have the given status. One of `active`, `inactive`, `canceled`, `lost`, or `stolen`. | Constraints: Maximum length of 5000

-> Maybe String

type: Only return cards that have the given type. One of `virtual` or `physical`. | Constraints: Maximum length of 5000

-> GetIssuingCardsRequestBody

The request body to send

-> m (Either HttpException (Response GetIssuingCardsResponse))

Monad containing the result of the operation

GET /v1/issuing/cards

<p>Returns a list of Issuing <code>Card</code> objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.</p>

getIssuingCardsRaw :: forall m s. (MonadHTTP m, SecurityScheme s) => Configuration s -> Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetIssuingCardsRequestBody -> m (Either HttpException (Response ByteString))

GET /v1/issuing/cards

The same as getIssuingCards but returns the raw ByteString

getIssuingCardsM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetIssuingCardsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response GetIssuingCardsResponse))

GET /v1/issuing/cards

Monadic version of getIssuingCards (use with runWithConfiguration)

getIssuingCardsRawM :: forall m s. (MonadHTTP m, SecurityScheme s) => Maybe String -> Maybe String -> Maybe String -> Maybe Integer -> Maybe Integer -> Maybe String -> Maybe String -> Maybe Integer -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> GetIssuingCardsRequestBody -> ReaderT (Configuration s) m (Either HttpException (Response ByteString))

GET /v1/issuing/cards

Monadic version of getIssuingCardsRaw (use with runWithConfiguration)

data GetIssuingCardsRequestBody

Defines the data type for the schema getIssuingCardsRequestBody

Constructors

GetIssuingCardsRequestBody

Instances

Eq GetIssuingCardsRequestBody

Defined in StripeAPI.Operations.GetIssuingCards

Methods

(==) :: GetIssuingCardsRequestBody -> GetIssuingCardsRequestBody -> Bool

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

Show GetIssuingCardsRequestBody

Defined in StripeAPI.Operations.GetIssuingCards

Methods

showsPrec :: Int -> GetIssuingCardsRequestBody -> ShowS

show :: GetIssuingCardsRequestBody -> String

showList :: [GetIssuingCardsRequestBody] -> ShowS

ToJSON GetIssuingCardsRequestBody

Defined in StripeAPI.Operations.GetIssuingCards

Methods

toJSON :: GetIssuingCardsRequestBody -> Value

toEncoding :: GetIssuingCardsRequestBody -> Encoding

toJSONList :: [GetIssuingCardsRequestBody] -> Value

toEncodingList :: [GetIssuingCardsRequestBody] -> Encoding

FromJSON GetIssuingCardsRequestBody

Defined in StripeAPI.Operations.GetIssuingCards

Methods

parseJSON :: Value -> Parser GetIssuingCardsRequestBody

parseJSONList :: Value -> Parser [GetIssuingCardsRequestBody]

data GetIssuingCardsResponse

Represents a response of the operation getIssuingCards.

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

Constructors

GetIssuingCardsResponseError String

Means either no matching case available or a parse error

GetIssuingCardsResponse200 GetIssuingCardsResponseBody200

Successful response.

GetIssuingCardsResponseDefault Error

Error response.

Instances

Eq GetIssuingCardsResponse

Defined in StripeAPI.Operations.GetIssuingCards

Methods

(==) :: GetIssuingCardsResponse -> GetIssuingCardsResponse -> Bool

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

Show GetIssuingCardsResponse

Defined in StripeAPI.Operations.GetIssuingCards

Methods

showsPrec :: Int -> GetIssuingCardsResponse -> ShowS

show :: GetIssuingCardsResponse -> String

showList :: [GetIssuingCardsResponse] -> ShowS

data GetIssuingCardsResponseBody200

Defines the data type for the schema GetIssuingCardsResponseBody200

Constructors

GetIssuingCardsResponseBody200

Fields

• getIssuingCardsResponseBody200Data :: [] Issuing'card

  data

• getIssuingCardsResponseBody200HasMore :: Bool

  has_more: True if this list has another page of items after this one that can be fetched.

• getIssuingCardsResponseBody200Object :: GetIssuingCardsResponseBody200Object'

  object: String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

• getIssuingCardsResponseBody200Url :: String

  url: The URL where this list can be accessed.

  Constraints:

  • Maximum length of 5000
  • Must match pattern '^/v1/issuing/cards'

Instances

Eq GetIssuingCardsResponseBody200

Defined in StripeAPI.Operations.GetIssuingCards

Methods

(==) :: GetIssuingCardsResponseBody200 -> GetIssuingCardsResponseBody200 -> Bool

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

Show GetIssuingCardsResponseBody200

Defined in StripeAPI.Operations.GetIssuingCards

Methods

showsPrec :: Int -> GetIssuingCardsResponseBody200 -> ShowS

show :: GetIssuingCardsResponseBody200 -> String

showList :: [GetIssuingCardsResponseBody200] -> ShowS

ToJSON GetIssuingCardsResponseBody200

Defined in StripeAPI.Operations.GetIssuingCards

Methods

toJSON :: GetIssuingCardsResponseBody200 -> Value

toEncoding :: GetIssuingCardsResponseBody200 -> Encoding

toJSONList :: [GetIssuingCardsResponseBody200] -> Value

toEncodingList :: [GetIssuingCardsResponseBody200] -> Encoding

FromJSON GetIssuingCardsResponseBody200

Defined in StripeAPI.Operations.GetIssuingCards

Methods

parseJSON :: Value -> Parser GetIssuingCardsResponseBody200

parseJSONList :: Value -> Parser [GetIssuingCardsResponseBody200]

data GetIssuingCardsResponseBody200Object'

Defines the enum schema GetIssuingCardsResponseBody200Object'

String representing the object's type. Objects of the same type share the same value. Always has the value `list`.

Constructors

GetIssuingCardsResponseBody200Object'EnumOther Value

GetIssuingCardsResponseBody200Object'EnumTyped String

GetIssuingCardsResponseBody200Object'EnumStringList

Instances

Eq GetIssuingCardsResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCards

Methods

(==) :: GetIssuingCardsResponseBody200Object' -> GetIssuingCardsResponseBody200Object' -> Bool

(/=) :: GetIssuingCardsResponseBody200Object' -> GetIssuingCardsResponseBody200Object' -> Bool

Show GetIssuingCardsResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCards

Methods

showsPrec :: Int -> GetIssuingCardsResponseBody200Object' -> ShowS

show :: GetIssuingCardsResponseBody200Object' -> String

showList :: [GetIssuingCardsResponseBody200Object'] -> ShowS

ToJSON GetIssuingCardsResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCards

Methods

toJSON :: GetIssuingCardsResponseBody200Object' -> Value

toEncoding :: GetIssuingCardsResponseBody200Object' -> Encoding

toJSONList :: [GetIssuingCardsResponseBody200Object'] -> Value

toEncodingList :: [GetIssuingCardsResponseBody200Object'] -> Encoding

FromJSON GetIssuingCardsResponseBody200Object'

Defined in StripeAPI.Operations.GetIssuingCards

Methods

parseJSON :: Value -> Parser GetIssuingCardsResponseBody200Object'

parseJSONList :: Value -> Parser [GetIssuingCardsResponseBody200Object']