Modulestripeapi-3.0.0.0Haskell2010

StripeAPI.Operations.GetShippingRates

Contains the different functions to run the operation getShippingRates

5 types
4 values

Packagestripeapi-3.0.0.0
Exports9
LanguageHaskell2010
LicenceMIT
SourceGetShippingRates.hs

valuegetShippingRates

:: MonadHTTP m
=> GetShippingRatesParameters
Contains all available parameters of this operation (query and path parameters)
-> ClientT m (Response GetShippingRatesResponse)
Monadic computation which returns the result of the operation

GET /v1/shipping_rates

<p>Returns a list of your shipping rates.</p>

datadata GetShippingRatesParameters

Defines the object schema located at paths./v1/shipping_rates.GET.parameters in the specification.

Constructors

GetShippingRatesParameters
- getShippingRatesParametersQueryActive :: Maybe Bool
  queryActive: Represents the parameter named 'active'
  Only return shipping rates that are active or inactive.
- getShippingRatesParametersQueryCreated :: Maybe GetShippingRatesParametersQueryCreated'Variants
  queryCreated: Represents the parameter named 'created'
  A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
- getShippingRatesParametersQueryCurrency :: Maybe Text
  queryCurrency: Represents the parameter named 'currency'
  Only return shipping rates for the given currency.
- getShippingRatesParametersQueryEndingBefore :: Maybe Text
  queryEnding_before: Represents the parameter named '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
- getShippingRatesParametersQueryExpand :: Maybe [Text]
  queryExpand: Represents the parameter named 'expand'
  Specifies which fields in the response should be expanded.
- getShippingRatesParametersQueryLimit :: Maybe Int
  queryLimit: Represents the parameter named 'limit'
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- getShippingRatesParametersQueryStartingAfter :: Maybe Text
  queryStarting_after: Represents the parameter named '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

Instances4Eq, Show, FromJSON, ToJSON

Eq GetShippingRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
Show GetShippingRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
FromJSON GetShippingRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
ToJSON GetShippingRatesParametersDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates

valuemkGetShippingRatesParameters :: GetShippingRatesParameters

Create a new GetShippingRatesParameters with all required fields.

datadata GetShippingRatesParametersQueryCreated'OneOf1

Defines the object schema located at paths./v1/shipping_rates.GET.parameters.properties.queryCreated.anyOf in the specification.

Constructors

GetShippingRatesParametersQueryCreated'OneOf1
- getShippingRatesParametersQueryCreated'OneOf1Gt :: Maybe Int
  gt
- getShippingRatesParametersQueryCreated'OneOf1Gte :: Maybe Int
  gte
- getShippingRatesParametersQueryCreated'OneOf1Lt :: Maybe Int
  lt
- getShippingRatesParametersQueryCreated'OneOf1Lte :: Maybe Int
  lte

Instances4Eq, Show, FromJSON, ToJSON

Eq GetShippingRatesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
Show GetShippingRatesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
FromJSON GetShippingRatesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
ToJSON GetShippingRatesParametersQueryCreated'OneOf1Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates

valuemkGetShippingRatesParametersQueryCreated'OneOf1 :: GetShippingRatesParametersQueryCreated'OneOf1

Create a new GetShippingRatesParametersQueryCreated'OneOf1 with all required fields.

datadata GetShippingRatesParametersQueryCreated'Variants

Defines the oneOf schema located at paths./v1/shipping_rates.GET.parameters.properties.queryCreated.anyOf in the specification.

Represents the parameter named 'created'

A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Constructors

GetShippingRatesParametersQueryCreated'GetShippingRatesParametersQueryCreated'OneOf1 GetShippingRatesParametersQueryCreated'OneOf1
GetShippingRatesParametersQueryCreated'Int Int

Instances4Eq, Show, FromJSON, ToJSON

Eq GetShippingRatesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
Show GetShippingRatesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
FromJSON GetShippingRatesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
ToJSON GetShippingRatesParametersQueryCreated'VariantsDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates

datadata GetShippingRatesResponse

Represents a response of the operation getShippingRates.

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

Constructors

GetShippingRatesResponseError String
Means either no matching case available or a parse error
GetShippingRatesResponse200 GetShippingRatesResponseBody200
Successful response.
GetShippingRatesResponseDefault Error
Error response.

Instances2Eq, Show

Eq GetShippingRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
Show GetShippingRatesResponseDefined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates

datadata GetShippingRatesResponseBody200

Defines the object schema located at paths./v1/shipping_rates.GET.responses.200.content.application/json.schema in the specification.

Constructors

GetShippingRatesResponseBody200
- getShippingRatesResponseBody200Data :: [ShippingRate]
  data
- getShippingRatesResponseBody200HasMore :: Bool
  has_more: True if this list has another page of items after this one that can be fetched.
- getShippingRatesResponseBody200Url :: Text
  url: The URL where this list can be accessed.
  Constraints:
  - Maximum length of 5000
  - Must match pattern '^/v1/shipping_rates'

Instances4Eq, Show, FromJSON, ToJSON

Eq GetShippingRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
Show GetShippingRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
FromJSON GetShippingRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates
ToJSON GetShippingRatesResponseBody200Defined in stripeapi-3.0.0.0 · StripeAPI.Operations.GetShippingRates

valuemkGetShippingRatesResponseBody200

:: [ShippingRate]
getShippingRatesResponseBody200Data
-> Bool
getShippingRatesResponseBody200HasMore
-> Text
getShippingRatesResponseBody200Url
-> GetShippingRatesResponseBody200

Create a new GetShippingRatesResponseBody200 with all required fields.