stripe 13.4.0 → 13.5.0.pre.beta.1

data/rbi/stripe/resources/shipping_rate.rbi

@@ -0,0 +1,310 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Shipping rates describe the price of shipping presented to your customers and
+  # applied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping).
+  class ShippingRate < APIResource
+    class DeliveryEstimate < Stripe::StripeObject
+      class Maximum < Stripe::StripeObject
+        # A unit of time.
+        sig { returns(String) }
+        attr_reader :unit
+        # Must be greater than 0.
+        sig { returns(Integer) }
+        attr_reader :value
+      end
+      class Minimum < Stripe::StripeObject
+        # A unit of time.
+        sig { returns(String) }
+        attr_reader :unit
+        # Must be greater than 0.
+        sig { returns(Integer) }
+        attr_reader :value
+      end
+      # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+      sig { returns(T.nilable(Maximum)) }
+      attr_reader :maximum
+      # The lower bound of the estimated range. If empty, represents no lower bound.
+      sig { returns(T.nilable(Minimum)) }
+      attr_reader :minimum
+    end
+    class FixedAmount < Stripe::StripeObject
+      class CurrencyOptions < Stripe::StripeObject
+        # A non-negative integer in cents representing how much to charge.
+        sig { returns(Integer) }
+        attr_reader :amount
+        # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+        sig { returns(String) }
+        attr_reader :tax_behavior
+      end
+      # A non-negative integer in cents representing how much to charge.
+      sig { returns(Integer) }
+      attr_reader :amount
+      # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+      sig { returns(String) }
+      attr_reader :currency
+      # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+      sig { returns(T::Hash[String, CurrencyOptions]) }
+      attr_reader :currency_options
+    end
+    # Whether the shipping rate can be used for new purchases. Defaults to `true`.
+    sig { returns(T::Boolean) }
+    attr_reader :active
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+    sig { returns(T.nilable(DeliveryEstimate)) }
+    attr_reader :delivery_estimate
+    # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+    sig { returns(T.nilable(String)) }
+    attr_reader :display_name
+    # Attribute for field fixed_amount
+    sig { returns(FixedAmount) }
+    attr_reader :fixed_amount
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+    # Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
+    sig { returns(T::Hash[String, String]) }
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+    sig { returns(T.nilable(String)) }
+    attr_reader :tax_behavior
+    # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+    sig { returns(T.nilable(T.any(String, Stripe::TaxCode))) }
+    attr_reader :tax_code
+    # The type of calculation to use on the shipping rate.
+    sig { returns(String) }
+    attr_reader :type
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        sig { returns(Integer) }
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        sig { returns(Integer) }
+        attr_accessor :lte
+        sig { params(gt: Integer, gte: Integer, lt: Integer, lte: Integer).void }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return shipping rates that are active or inactive.
+      sig { returns(T::Boolean) }
+      attr_accessor :active
+      # 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.
+      sig { returns(T.any(::Stripe::ShippingRate::ListParams::Created, Integer)) }
+      attr_accessor :created
+      # Only return shipping rates for the given currency.
+      sig { returns(String) }
+      attr_accessor :currency
+      # 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.
+      sig { returns(String) }
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      sig { returns(Integer) }
+      attr_accessor :limit
+      # 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.
+      sig { returns(String) }
+      attr_accessor :starting_after
+      sig {
+        params(active: T::Boolean, created: T.any(::Stripe::ShippingRate::ListParams::Created, Integer), currency: String, ending_before: String, expand: T::Array[String], limit: Integer, starting_after: String).void
+       }
+      def initialize(
+        active: nil,
+        created: nil,
+        currency: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      class DeliveryEstimate < Stripe::RequestParams
+        class Maximum < Stripe::RequestParams
+          # A unit of time.
+          sig { returns(String) }
+          attr_accessor :unit
+          # Must be greater than 0.
+          sig { returns(Integer) }
+          attr_accessor :value
+          sig { params(unit: String, value: Integer).void }
+          def initialize(unit: nil, value: nil); end
+        end
+        class Minimum < Stripe::RequestParams
+          # A unit of time.
+          sig { returns(String) }
+          attr_accessor :unit
+          # Must be greater than 0.
+          sig { returns(Integer) }
+          attr_accessor :value
+          sig { params(unit: String, value: Integer).void }
+          def initialize(unit: nil, value: nil); end
+        end
+        # The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite.
+        sig { returns(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum) }
+        attr_accessor :maximum
+        # The lower bound of the estimated range. If empty, represents no lower bound.
+        sig { returns(::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum) }
+        attr_accessor :minimum
+        sig {
+          params(maximum: ::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Maximum, minimum: ::Stripe::ShippingRate::CreateParams::DeliveryEstimate::Minimum).void
+         }
+        def initialize(maximum: nil, minimum: nil); end
+      end
+      class FixedAmount < Stripe::RequestParams
+        class CurrencyOptions < Stripe::RequestParams
+          # A non-negative integer in cents representing how much to charge.
+          sig { returns(Integer) }
+          attr_accessor :amount
+          # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+          sig { returns(String) }
+          attr_accessor :tax_behavior
+          sig { params(amount: Integer, tax_behavior: String).void }
+          def initialize(amount: nil, tax_behavior: nil); end
+        end
+        # A non-negative integer in cents representing how much to charge.
+        sig { returns(Integer) }
+        attr_accessor :amount
+        # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+        sig { returns(String) }
+        attr_accessor :currency
+        # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+        sig {
+          returns(T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions])
+         }
+        attr_accessor :currency_options
+        sig {
+          params(amount: Integer, currency: String, currency_options: T::Hash[String, ::Stripe::ShippingRate::CreateParams::FixedAmount::CurrencyOptions]).void
+         }
+        def initialize(amount: nil, currency: nil, currency_options: nil); end
+      end
+      # The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions.
+      sig { returns(::Stripe::ShippingRate::CreateParams::DeliveryEstimate) }
+      attr_accessor :delivery_estimate
+      # The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions.
+      sig { returns(String) }
+      attr_accessor :display_name
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+      sig { returns(::Stripe::ShippingRate::CreateParams::FixedAmount) }
+      attr_accessor :fixed_amount
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.
+      sig { returns(T::Hash[String, String]) }
+      attr_accessor :metadata
+      # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+      sig { returns(String) }
+      attr_accessor :tax_behavior
+      # A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`.
+      sig { returns(String) }
+      attr_accessor :tax_code
+      # The type of calculation to use on the shipping rate.
+      sig { returns(String) }
+      attr_accessor :type
+      sig {
+        params(delivery_estimate: ::Stripe::ShippingRate::CreateParams::DeliveryEstimate, display_name: String, expand: T::Array[String], fixed_amount: ::Stripe::ShippingRate::CreateParams::FixedAmount, metadata: T::Hash[String, String], tax_behavior: String, tax_code: String, type: String).void
+       }
+      def initialize(
+        delivery_estimate: nil,
+        display_name: nil,
+        expand: nil,
+        fixed_amount: nil,
+        metadata: nil,
+        tax_behavior: nil,
+        tax_code: nil,
+        type: nil
+      ); end
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      sig { params(expand: T::Array[String]).void }
+      def initialize(expand: nil); end
+    end
+    class UpdateParams < Stripe::RequestParams
+      class FixedAmount < Stripe::RequestParams
+        class CurrencyOptions < Stripe::RequestParams
+          # A non-negative integer in cents representing how much to charge.
+          sig { returns(Integer) }
+          attr_accessor :amount
+          # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+          sig { returns(String) }
+          attr_accessor :tax_behavior
+          sig { params(amount: Integer, tax_behavior: String).void }
+          def initialize(amount: nil, tax_behavior: nil); end
+        end
+        # Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+        sig {
+          returns(T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions])
+         }
+        attr_accessor :currency_options
+        sig {
+          params(currency_options: T::Hash[String, ::Stripe::ShippingRate::UpdateParams::FixedAmount::CurrencyOptions]).void
+         }
+        def initialize(currency_options: nil); end
+      end
+      # Whether the shipping rate can be used for new purchases. Defaults to `true`.
+      sig { returns(T::Boolean) }
+      attr_accessor :active
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T::Array[String]) }
+      attr_accessor :expand
+      # Describes a fixed amount to charge for shipping. Must be present if type is `fixed_amount`.
+      sig { returns(::Stripe::ShippingRate::UpdateParams::FixedAmount) }
+      attr_accessor :fixed_amount
+      # Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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`.
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_accessor :metadata
+      # Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`.
+      sig { returns(String) }
+      attr_accessor :tax_behavior
+      sig {
+        params(active: T::Boolean, expand: T::Array[String], fixed_amount: ::Stripe::ShippingRate::UpdateParams::FixedAmount, metadata: T.nilable(T::Hash[String, String]), tax_behavior: String).void
+       }
+      def initialize(
+        active: nil,
+        expand: nil,
+        fixed_amount: nil,
+        metadata: nil,
+        tax_behavior: nil
+      ); end
+    end
+    # Creates a new shipping rate object.
+    sig {
+      params(params: T.any(::Stripe::ShippingRate::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # Returns a list of your shipping rates.
+    sig {
+      params(params: T.any(::Stripe::ShippingRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+
+    # Updates an existing shipping rate object.
+    sig {
+      params(shipping_rate_token: String, params: T.any(::Stripe::ShippingRate::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ShippingRate)
+     }
+    def self.update(shipping_rate_token, params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/sigma/scheduled_query_run.rbi

@@ -0,0 +1,82 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Sigma
+    # If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll
+    # receive a `sigma.scheduled_query_run.created` webhook each time the query
+    # runs. The webhook contains a `ScheduledQueryRun` object, which you can use to
+    # retrieve the query results.
+    class ScheduledQueryRun < APIResource
+      class Error < Stripe::StripeObject
+        # Information about the run failure.
+        sig { returns(String) }
+        attr_reader :message
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+      # When the query was run, Sigma contained a snapshot of your Stripe data at this time.
+      sig { returns(Integer) }
+      attr_reader :data_load_time
+      # Attribute for field error
+      sig { returns(Error) }
+      attr_reader :error
+      # The file object representing the results of the query.
+      sig { returns(T.nilable(Stripe::File)) }
+      attr_reader :file
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      # Time at which the result expires and is no longer available for download.
+      sig { returns(Integer) }
+      attr_reader :result_available_until
+      # SQL for the query.
+      sig { returns(String) }
+      attr_reader :sql
+      # The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise.
+      sig { returns(String) }
+      attr_reader :status
+      # Title of the query.
+      sig { returns(String) }
+      attr_reader :title
+      class ListParams < Stripe::RequestParams
+        # 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.
+        sig { returns(String) }
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T::Array[String]) }
+        attr_accessor :expand
+        # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+        sig { returns(Integer) }
+        attr_accessor :limit
+        # 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.
+        sig { returns(String) }
+        attr_accessor :starting_after
+        sig {
+          params(ending_before: String, expand: T::Array[String], limit: Integer, starting_after: 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::Array[String]) }
+        attr_accessor :expand
+        sig { params(expand: T::Array[String]).void }
+        def initialize(expand: nil); end
+      end
+      # Returns a list of scheduled query runs.
+      sig {
+        params(params: T.any(::Stripe::Sigma::ScheduledQueryRun::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end