mirror of
https://github.com/stripe/stripe-ruby.git
synced 2025-10-05 00:02:50 -04:00
44 lines
2.6 KiB
Ruby
44 lines
2.6 KiB
Ruby
# File generated from our OpenAPI spec
|
|
# frozen_string_literal: true
|
|
|
|
# typed: true
|
|
module Stripe
|
|
class ExchangeRateService < StripeService
|
|
class ListParams < Stripe::RequestParams
|
|
# A cursor for use in pagination. `ending_before` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with the exchange rate for currency X your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
|
|
sig { returns(T.nilable(String)) }
|
|
attr_accessor :ending_before
|
|
# Specifies which fields in the response should be expanded.
|
|
sig { returns(T.nilable(T::Array[String])) }
|
|
attr_accessor :expand
|
|
# A limit on the number of objects to be returned. Limit can range between 1 and total number of supported payout currencies, and the default is the max.
|
|
sig { returns(T.nilable(Integer)) }
|
|
attr_accessor :limit
|
|
# A cursor for use in pagination. `starting_after` is the currency that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with the exchange rate for currency X, your subsequent call can include `starting_after=X` in order to fetch the next page of the list.
|
|
sig { returns(T.nilable(String)) }
|
|
attr_accessor :starting_after
|
|
sig {
|
|
params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
|
|
}
|
|
def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); end
|
|
end
|
|
class RetrieveParams < Stripe::RequestParams
|
|
# Specifies which fields in the response should be expanded.
|
|
sig { returns(T.nilable(T::Array[String])) }
|
|
attr_accessor :expand
|
|
sig { params(expand: T.nilable(T::Array[String])).void }
|
|
def initialize(expand: nil); end
|
|
end
|
|
# Returns a list of objects that contain the rates at which foreign currencies are converted to one another. Only shows the currencies for which Stripe supports.
|
|
sig {
|
|
params(params: T.any(::Stripe::ExchangeRateService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
|
|
}
|
|
def list(params = {}, opts = {}); end
|
|
|
|
# Retrieves the exchange rates from the given currency to every supported currency.
|
|
sig {
|
|
params(rate_id: String, params: T.any(::Stripe::ExchangeRateService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ExchangeRate)
|
|
}
|
|
def retrieve(rate_id, params = {}, opts = {}); end
|
|
end
|
|
end |