stripe 14.1.0.pre.beta.1 → 15.0.0

data/rbi/stripe/resources/entitlements/active_entitlement.rbi

@@ -0,0 +1,58 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Entitlements
+    # An active entitlement describes access to a feature for a customer.
+    class ActiveEntitlement < APIResource
+      # The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to.
+      sig { returns(T.any(String, Stripe::Entitlements::Feature)) }
+      attr_reader :feature
+      # 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
+      # A unique key you provide as your own system identifier. This may be up to 80 characters.
+      sig { returns(String) }
+      attr_reader :lookup_key
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      class ListParams < Stripe::RequestParams
+        # The ID of the customer.
+        sig { returns(String) }
+        attr_accessor :customer
+        # 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(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 100, and the default is 10.
+        sig { returns(T.nilable(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(T.nilable(String)) }
+        attr_accessor :starting_after
+        sig {
+          params(customer: String, ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
+         }
+        def initialize(
+          customer: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        ); end
+      end
+      # Retrieve a list of active entitlements for a customer
+      sig {
+        params(params: T.any(::Stripe::Entitlements::ActiveEntitlement::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/entitlements/active_entitlement_summary.rbi

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Entitlements
+    # A summary of a customer's active entitlements.
+    class ActiveEntitlementSummary < APIResource
+      # The customer that is entitled to this feature.
+      sig { returns(String) }
+      attr_reader :customer
+      # The list of entitlements this customer has.
+      sig { returns(Stripe::ListObject) }
+      attr_reader :entitlements
+      # 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
+    end
+  end
+end

data/rbi/stripe/resources/entitlements/feature.rbi

@@ -0,0 +1,117 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Entitlements
+    # A feature represents a monetizable ability or functionality in your system.
+    # Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.
+    class Feature < APIResource
+      # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
+      sig { returns(T::Boolean) }
+      attr_reader :active
+      # 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
+      # A unique key you provide as your own system identifier. This may be up to 80 characters.
+      sig { returns(String) }
+      attr_reader :lookup_key
+      # Set of key-value pairs 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
+      # The feature's name, for your own purpose, not meant to be displayable to the customer.
+      sig { returns(String) }
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value.
+      sig { returns(String) }
+      attr_reader :object
+      class ListParams < Stripe::RequestParams
+        # If set, filter results to only include features with the given archive status.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :archived
+        # 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(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 100, and the default is 10.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :limit
+        # If set, filter results to only include features with the given lookup_key.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :lookup_key
+        # 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(T.nilable(String)) }
+        attr_accessor :starting_after
+        sig {
+          params(archived: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), lookup_key: T.nilable(String), starting_after: T.nilable(String)).void
+         }
+        def initialize(
+          archived: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          lookup_key: nil,
+          starting_after: nil
+        ); end
+      end
+      class CreateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # A unique key you provide as your own system identifier. This may be up to 80 characters.
+        sig { returns(String) }
+        attr_accessor :lookup_key
+        # Set of key-value pairs 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.nilable(T::Hash[String, String])) }
+        attr_accessor :metadata
+        # The feature's name, for your own purpose, not meant to be displayable to the customer.
+        sig { returns(String) }
+        attr_accessor :name
+        sig {
+          params(expand: T.nilable(T::Array[String]), lookup_key: String, metadata: T.nilable(T::Hash[String, String]), name: String).void
+         }
+        def initialize(expand: nil, lookup_key: nil, metadata: nil, name: nil); end
+      end
+      class UpdateParams < Stripe::RequestParams
+        # Inactive features cannot be attached to new products and will not be returned from the features list endpoint.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :active
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # Set of key-value pairs 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.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
+        attr_accessor :metadata
+        # The feature's name, for your own purpose, not meant to be displayable to the customer.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+        sig {
+          params(active: T.nilable(T::Boolean), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String)).void
+         }
+        def initialize(active: nil, expand: nil, metadata: nil, name: nil); end
+      end
+      # Creates a feature
+      sig {
+        params(params: T.any(::Stripe::Entitlements::Feature::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
+       }
+      def self.create(params = {}, opts = {}); end
+
+      # Retrieve a list of features
+      sig {
+        params(params: T.any(::Stripe::Entitlements::Feature::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+
+      # Update a feature's metadata or permanently deactivate it.
+      sig {
+        params(id: String, params: T.any(::Stripe::Entitlements::Feature::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Entitlements::Feature)
+       }
+      def self.update(id, params = {}, opts = {}); end
+    end
+  end
+end

data/rbi/stripe/resources/ephemeral_key.rbi

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class EphemeralKey < APIResource
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # Time at which the key will expire. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :expires
+    # 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
+    # The key's secret. You can use this value to make authorized requests to the Stripe API.
+    sig { returns(String) }
+    attr_reader :secret
+    class DeleteParams < 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
+    # Invalidates a short-lived API key for a given resource.
+    sig {
+      params(key: String, params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
+     }
+    def self.delete(key, params = {}, opts = {}); end
+
+    # Invalidates a short-lived API key for a given resource.
+    sig {
+      params(params: T.any(::Stripe::EphemeralKey::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::EphemeralKey)
+     }
+    def delete(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/event.rbi

@@ -0,0 +1,146 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Events are our way of letting you know when something interesting happens in
+  # your account. When an interesting event occurs, we create a new `Event`
+  # object. For example, when a charge succeeds, we create a `charge.succeeded`
+  # event, and when an invoice payment attempt fails, we create an
+  # `invoice.payment_failed` event. Certain API requests might create multiple
+  # events. For example, if you create a new subscription for a
+  # customer, you receive both a `customer.subscription.created` event and a
+  # `charge.succeeded` event.
+  #
+  # Events occur when the state of another API resource changes. The event's data
+  # field embeds the resource's state at the time of the change. For
+  # example, a `charge.succeeded` event contains a charge, and an
+  # `invoice.payment_failed` event contains an invoice.
+  #
+  # As with other API resources, you can use endpoints to retrieve an
+  # [individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)
+  # from the API. We also have a separate
+  # [webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the
+  # `Event` objects directly to an endpoint on your server. You can manage
+  # webhooks in your
+  # [account settings](https://dashboard.stripe.com/account/webhooks). Learn how
+  # to [listen for events](https://docs.stripe.com/webhooks)
+  # so that your integration can automatically trigger reactions.
+  #
+  # When using [Connect](https://docs.stripe.com/connect), you can also receive event notifications
+  # that occur in connected accounts. For these events, there's an
+  # additional `account` attribute in the received `Event` object.
+  #
+  # We only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)
+  # for 30 days.
+  class Event < APIResource
+    class Data < Stripe::StripeObject
+      # Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key.
+      sig { returns(T::Hash[String, T.untyped]) }
+      attr_reader :object
+      # Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements.
+      sig { returns(T::Hash[String, T.untyped]) }
+      attr_reader :previous_attributes
+    end
+    class Request < Stripe::StripeObject
+      # ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+      # The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+    end
+    # The connected account that originates the event.
+    sig { returns(String) }
+    attr_reader :account
+    # The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.
+    sig { returns(T.nilable(String)) }
+    attr_reader :api_version
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # Attribute for field data
+    sig { returns(Data) }
+    attr_reader :data
+    # 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
+    # Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.
+    sig { returns(Integer) }
+    attr_reader :pending_webhooks
+    # Information on the API request that triggers the event.
+    sig { returns(T.nilable(Request)) }
+    attr_reader :request
+    # Description of the event (for example, `invoice.created` or `charge.refunded`).
+    sig { returns(String) }
+    attr_reader :type
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lte
+        sig {
+          params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
+         }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return events that were created during the given date interval.
+      sig { returns(T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer))) }
+      attr_accessor :created
+      # Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :delivery_success
+      # 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(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 100, and the default is 10.
+      sig { returns(T.nilable(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(T.nilable(String)) }
+      attr_accessor :starting_after
+      # A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+      # An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either `type` or `types`, but not both.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :types
+      sig {
+        params(created: T.nilable(T.any(::Stripe::Event::ListParams::Created, Integer)), delivery_success: T.nilable(T::Boolean), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String), type: T.nilable(String), types: T.nilable(T::Array[String])).void
+       }
+      def initialize(
+        created: nil,
+        delivery_success: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil,
+        type: nil,
+        types: nil
+      ); end
+    end
+    # List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in [event object](https://docs.stripe.com/api/events/object) api_version attribute (not according to your current Stripe API version or Stripe-Version header).
+    sig {
+      params(params: T.any(::Stripe::Event::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/exchange_rate.rbi

@@ -0,0 +1,66 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # `ExchangeRate` objects allow you to determine the rates that Stripe is currently
+  # using to convert from one currency to another. Since this number is variable
+  # throughout the day, there are various reasons why you might want to know the current
+  # rate (for example, to dynamically price an item for a user with a default
+  # payment in a foreign currency).
+  #
+  # Please refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.
+  #
+  # *[Note: this integration path is supported but no longer recommended]* Additionally,
+  # you can guarantee that a charge is made with an exchange rate that you expect is
+  # current. To do so, you must pass in the exchange_rate to charges endpoints. If the
+  # value is no longer up to date, the charge won't go through. Please refer to our
+  # [Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.
+  #
+  # -----
+  #
+  #  
+  #
+  # *This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*
+  #
+  # - *localize prices for processing payments on Stripe*
+  # - *reconcile Stripe transactions*
+  # - *determine how much money to send to a connected account*
+  # - *determine app fees to charge a connected account*
+  #
+  # *Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*
+  class ExchangeRate < APIResource
+    # Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.
+    sig { returns(String) }
+    attr_reader :id
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency.
+    sig { returns(T::Hash[String, Float]) }
+    attr_reader :rates
+    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
+    # 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::ExchangeRate::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/resources/file.rbi

@@ -0,0 +1,143 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # This object represents files hosted on Stripe's servers. You can upload
+  # files with the [create file](https://stripe.com/docs/api#create_file) request
+  # (for example, when uploading dispute evidence). Stripe also
+  # creates files independently (for example, the results of a [Sigma scheduled
+  # query](https://stripe.com/docs/api#scheduled_queries)).
+  #
+  # Related guide: [File upload guide](https://stripe.com/docs/file-upload)
+  class File < APIResource
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # The file expires and isn't available at this time in epoch seconds.
+    sig { returns(T.nilable(Integer)) }
+    attr_reader :expires_at
+    # The suitable name for saving the file to a filesystem.
+    sig { returns(T.nilable(String)) }
+    attr_reader :filename
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # A list of [file links](https://stripe.com/docs/api#file_links) that point at this file.
+    sig { returns(T.nilable(Stripe::ListObject)) }
+    attr_reader :links
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+    sig { returns(String) }
+    attr_reader :purpose
+    # The size of the file object in bytes.
+    sig { returns(Integer) }
+    attr_reader :size
+    # A suitable title for the document.
+    sig { returns(T.nilable(String)) }
+    attr_reader :title
+    # The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).
+    sig { returns(T.nilable(String)) }
+    attr_reader :type
+    # Use your live secret API key to download the file from this URL.
+    sig { returns(T.nilable(String)) }
+    attr_reader :url
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lte
+        sig {
+          params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
+         }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return files that were created during the given date interval.
+      sig { returns(T.nilable(T.any(::Stripe::File::ListParams::Created, Integer))) }
+      attr_accessor :created
+      # 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(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 100, and the default is 10.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :limit
+      # Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :purpose
+      # 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(T.nilable(String)) }
+      attr_accessor :starting_after
+      sig {
+        params(created: T.nilable(T.any(::Stripe::File::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), purpose: T.nilable(String), starting_after: T.nilable(String)).void
+       }
+      def initialize(
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        purpose: nil,
+        starting_after: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      class FileLinkData < Stripe::RequestParams
+        # Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `issuing_regulatory_reporting`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.
+        sig { returns(T::Boolean) }
+        attr_accessor :create
+        # The link isn't available after this future timestamp.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :expires_at
+        # 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.nilable(T.any(String, T::Hash[String, String])))) }
+        attr_accessor :metadata
+        sig {
+          params(create: T::Boolean, expires_at: T.nilable(Integer), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String])))).void
+         }
+        def initialize(create: nil, expires_at: nil, metadata: nil); end
+      end
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.
+      sig { returns(T.untyped) }
+      attr_accessor :file
+      # Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.
+      sig { returns(T.nilable(::Stripe::File::CreateParams::FileLinkData)) }
+      attr_accessor :file_link_data
+      # The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file.
+      sig { returns(String) }
+      attr_accessor :purpose
+      sig {
+        params(expand: T.nilable(T::Array[String]), file: T.untyped, file_link_data: T.nilable(::Stripe::File::CreateParams::FileLinkData), purpose: String).void
+       }
+      def initialize(expand: nil, file: nil, file_link_data: nil, purpose: nil); end
+    end
+    # To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
+    #
+    # All of Stripe's officially supported Client libraries support sending multipart/form-data.
+    sig {
+      params(params: T.any(::Stripe::File::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::File)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
+    sig {
+      params(params: T.any(::Stripe::File::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+  end
+end