exoapi_stripe v0.1.4

View Source ExOAPI.Stripe.SDK.ShippingRates (exoapi_stripe v0.1.4)

Link to this section Summary

Types

get_shipping_rates_opts()
get_shipping_rates_shipping_rate_token_opts()

Functions

get_shipping_rates(client, opts \\ [])

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

get_shipping_rates_shipping_rate_token(client, shipping_rate_token, opts \\ [])

description: <p>Returns the shipping rate object with the given ID.</p>

post_shipping_rates(client, body)

description: <p>Creates a new shipping rate object.</p>

post_shipping_rates_shipping_rate_token(client, body, shipping_rate_token)

description: <p>Updates an existing shipping rate object.</p>

Link to this section Types

Link to this type

get_shipping_rates_opts()

View Source 
@type get_shipping_rates_opts() ::
  {:starting_after, String.t()}
  | {:limit, String.t()}
  | {:expand, String.t()}
  | {:ending_before, String.t()}
  | {:currency, String.t()}
  | {:created, String.t()}
  | {:active, String.t()}
Link to this type

get_shipping_rates_shipping_rate_token_opts()

View Source 
@type get_shipping_rates_shipping_rate_token_opts() :: {:expand, String.t()}

Link to this section Functions

Link to this function

get_shipping_rates(client, opts \\ [])

View Source 
@spec get_shipping_rates(client :: ExOAPI.Client.t(), [get_shipping_rates_opts()]) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | %{
       url: String.t(),
       object: String.t() | :list,
       has_more: boolean(),
       data: [ExOAPI.Stripe.Schemas.ShippingRate.t()]
     }
   | map()}
  | {:error, any()}

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

Link to this function

get_shipping_rates_shipping_rate_token(client, shipping_rate_token, opts \\ [])

View Source 
@spec get_shipping_rates_shipping_rate_token(
  client :: ExOAPI.Client.t(),
  shipping_rate_token :: String.t(),
  [get_shipping_rates_shipping_rate_token_opts()]
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ShippingRate.t()
   | map()}
  | {:error, any()}

description: <p>Returns the shipping rate object with the given ID.</p>

Link to this function

post_shipping_rates(client, body)

View Source 
@spec post_shipping_rates(
  client :: ExOAPI.Client.t(),
  body ::
    %{
      type: String.t() | :fixed_amount,
      tax_code: String.t(),
      tax_behavior: String.t() | :exclusive | :inclusive | :unspecified,
      metadata: map(),
      fixed_amount: %{currency: String.t(), amount: integer()},
      expand: [String.t()],
      display_name: String.t(),
      delivery_estimate: %{
        minimum: %{
          value: integer(),
          unit: String.t() | :business_day | :day | :hour | :month | :week
        },
        maximum: %{
          value: integer(),
          unit: String.t() | :business_day | :day | :hour | :month | :week
        }
      }
    }
    | map()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ShippingRate.t()
   | map()}
  | {:error, any()}

description: <p>Creates a new shipping rate object.</p>

Link to this function

post_shipping_rates_shipping_rate_token(client, body, shipping_rate_token)

View Source 
@spec post_shipping_rates_shipping_rate_token(
  client :: ExOAPI.Client.t(),
  body ::
    %{metadata: String.t() | map(), expand: [String.t()], active: boolean()}
    | map(),
  shipping_rate_token :: String.t()
) ::
  {:ok,
   ExOAPI.Stripe.Schemas.Error.t()
   | ExOAPI.Stripe.Schemas.ShippingRate.t()
   | map()}
  | {:error, any()}

description: <p>Updates an existing shipping rate object.</p>