stripe 15.2.0.pre.beta.1 → 15.2.0

data/rbi/stripe/resources/apple_pay_domain.rbi

@@ -0,0 +1,88 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # Domains registered for Apple Pay on the Web
+  class ApplePayDomain < APIResource
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # Attribute for field domain_name
+    sig { returns(String) }
+    attr_reader :domain_name
+    # 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
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+    class DeleteParams < Stripe::RequestParams; end
+    class ListParams < Stripe::RequestParams
+      # Attribute for param field domain_name
+      sig { returns(T.nilable(String)) }
+      attr_accessor :domain_name
+      # 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(domain_name: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
+       }
+      def initialize(
+        domain_name: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      # Attribute for param field domain_name
+      sig { returns(String) }
+      attr_accessor :domain_name
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      sig { params(domain_name: String, expand: T.nilable(T::Array[String])).void }
+      def initialize(domain_name: nil, expand: nil); end
+    end
+    # Create an apple pay domain.
+    sig {
+      params(params: T.any(::Stripe::ApplePayDomain::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # Delete an apple pay domain.
+    sig {
+      params(domain: String, params: T.any(::Stripe::ApplePayDomain::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
+     }
+    def self.delete(domain, params = {}, opts = {}); end
+
+    # Delete an apple pay domain.
+    sig {
+      params(params: T.any(::Stripe::ApplePayDomain::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ApplePayDomain)
+     }
+    def delete(params = {}, opts = {}); end
+
+    # List apple pay domains.
+    sig {
+      params(params: T.any(::Stripe::ApplePayDomain::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/application.rbi

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class Application < APIResource
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # The name of the application.
+    sig { returns(T.nilable(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
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+  end
+end

data/rbi/stripe/resources/application_fee.rbi

@@ -0,0 +1,118 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class ApplicationFee < APIResource
+    class FeeSource < Stripe::StripeObject
+      # Charge ID that created this application fee.
+      sig { returns(String) }
+      attr_reader :charge
+      # Payout ID that created this application fee.
+      sig { returns(String) }
+      attr_reader :payout
+      # Type of object that created the application fee.
+      sig { returns(String) }
+      attr_reader :type
+    end
+    # ID of the Stripe account this fee was taken from.
+    sig { returns(T.any(String, Stripe::Account)) }
+    attr_reader :account
+    # Amount earned, in cents (or local equivalent).
+    sig { returns(Integer) }
+    attr_reader :amount
+    # Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)
+    sig { returns(Integer) }
+    attr_reader :amount_refunded
+    # ID of the Connect application that earned the fee.
+    sig { returns(T.any(String, Stripe::Application)) }
+    attr_reader :application
+    # Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).
+    sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
+    attr_reader :balance_transaction
+    # ID of the charge that the application fee was taken from.
+    sig { returns(T.any(String, Stripe::Charge)) }
+    attr_reader :charge
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # 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
+    # Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
+    sig { returns(T.nilable(FeeSource)) }
+    attr_reader :fee_source
+    # 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
+    # ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.
+    sig { returns(T.nilable(T.any(String, Stripe::Charge))) }
+    attr_reader :originating_transaction
+    # Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.
+    sig { returns(T::Boolean) }
+    attr_reader :refunded
+    # A list of refunds that have been applied to the fee.
+    sig { returns(Stripe::ListObject) }
+    attr_reader :refunds
+    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 application fees for the charge specified by this charge ID.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :charge
+      # Only return applications fees that were created during the given date interval.
+      sig { returns(T.nilable(T.any(::Stripe::ApplicationFee::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
+      # 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(charge: T.nilable(String), created: T.nilable(T.any(::Stripe::ApplicationFee::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
+       }
+      def initialize(
+        charge: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        limit: nil,
+        starting_after: nil
+      ); end
+    end
+    # Returns a list of application fees you've previously collected. The application fees are returned in sorted order, with the most recent fees appearing first.
+    sig {
+      params(params: T.any(::Stripe::ApplicationFee::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/application_fee_refund.rbi

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # `Application Fee Refund` objects allow you to refund an application fee that
+  # has previously been created but not yet refunded. Funds will be refunded to
+  # the Stripe account from which the fee was originally collected.
+  #
+  # Related guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)
+  class ApplicationFeeRefund < APIResource
+    # Amount, in cents (or local equivalent).
+    sig { returns(Integer) }
+    attr_reader :amount
+    # Balance transaction that describes the impact on your account balance.
+    sig { returns(T.nilable(T.any(String, Stripe::BalanceTransaction))) }
+    attr_reader :balance_transaction
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # 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
+    # ID of the application fee that was refunded.
+    sig { returns(T.any(String, Stripe::ApplicationFee)) }
+    attr_reader :fee
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # 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.nilable(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
+  end
+end

data/rbi/stripe/resources/apps/secret.rbi

@@ -0,0 +1,195 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module Apps
+    # Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.
+    #
+    # The primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.
+    #
+    # All Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.
+    #
+    # A `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.
+    #
+    # Related guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)
+    class Secret < APIResource
+      class Scope < Stripe::StripeObject
+        # The secret scope type.
+        sig { returns(String) }
+        attr_reader :type
+        # The user ID, if type is set to "user"
+        sig { returns(String) }
+        attr_reader :user
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      sig { returns(Integer) }
+      attr_reader :created
+      # If true, indicates that this secret has been deleted
+      sig { returns(T::Boolean) }
+      attr_reader :deleted
+      # The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :expires_at
+      # 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 name for the secret that's unique within the scope.
+      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
+      # The plaintext secret value to be stored.
+      sig { returns(T.nilable(String)) }
+      attr_reader :payload
+      # Attribute for field scope
+      sig { returns(Scope) }
+      attr_reader :scope
+      class ListParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          sig { returns(String) }
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :user
+          sig { params(type: String, user: T.nilable(String)).void }
+          def initialize(type: nil, user: nil); end
+        end
+        # 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
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        sig { returns(::Stripe::Apps::Secret::ListParams::Scope) }
+        attr_accessor :scope
+        # 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(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), scope: ::Stripe::Apps::Secret::ListParams::Scope, starting_after: T.nilable(String)).void
+         }
+        def initialize(
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          scope: nil,
+          starting_after: nil
+        ); end
+      end
+      class CreateParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          sig { returns(String) }
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :user
+          sig { params(type: String, user: T.nilable(String)).void }
+          def initialize(type: nil, user: nil); end
+        end
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # The Unix timestamp for the expiry time of the secret, after which the secret deletes.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :expires_at
+        # A name for the secret that's unique within the scope.
+        sig { returns(String) }
+        attr_accessor :name
+        # The plaintext secret value to be stored.
+        sig { returns(String) }
+        attr_accessor :payload
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        sig { returns(::Stripe::Apps::Secret::CreateParams::Scope) }
+        attr_accessor :scope
+        sig {
+          params(expand: T.nilable(T::Array[String]), expires_at: T.nilable(Integer), name: String, payload: String, scope: ::Stripe::Apps::Secret::CreateParams::Scope).void
+         }
+        def initialize(expand: nil, expires_at: nil, name: nil, payload: nil, scope: nil); end
+      end
+      class FindParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          sig { returns(String) }
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :user
+          sig { params(type: String, user: T.nilable(String)).void }
+          def initialize(type: nil, user: nil); end
+        end
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # A name for the secret that's unique within the scope.
+        sig { returns(String) }
+        attr_accessor :name
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        sig { returns(::Stripe::Apps::Secret::FindParams::Scope) }
+        attr_accessor :scope
+        sig {
+          params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::Secret::FindParams::Scope).void
+         }
+        def initialize(expand: nil, name: nil, scope: nil); end
+      end
+      class DeleteWhereParams < Stripe::RequestParams
+        class Scope < Stripe::RequestParams
+          # The secret scope type.
+          sig { returns(String) }
+          attr_accessor :type
+          # The user ID. This field is required if `type` is set to `user`, and should not be provided if `type` is set to `account`.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :user
+          sig { params(type: String, user: T.nilable(String)).void }
+          def initialize(type: nil, user: nil); end
+        end
+        # Specifies which fields in the response should be expanded.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :expand
+        # A name for the secret that's unique within the scope.
+        sig { returns(String) }
+        attr_accessor :name
+        # Specifies the scoping of the secret. Requests originating from UI extensions can only access account-scoped secrets or secrets scoped to their own user.
+        sig { returns(::Stripe::Apps::Secret::DeleteWhereParams::Scope) }
+        attr_accessor :scope
+        sig {
+          params(expand: T.nilable(T::Array[String]), name: String, scope: ::Stripe::Apps::Secret::DeleteWhereParams::Scope).void
+         }
+        def initialize(expand: nil, name: nil, scope: nil); end
+      end
+      # Create or replace a secret in the secret store.
+      sig {
+        params(params: T.any(::Stripe::Apps::Secret::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
+       }
+      def self.create(params = {}, opts = {}); end
+
+      # Deletes a secret from the secret store by name and scope.
+      sig {
+        params(params: T.any(::Stripe::Apps::Secret::DeleteWhereParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
+       }
+      def self.delete_where(params = {}, opts = {}); end
+
+      # Finds a secret in the secret store by name and scope.
+      sig {
+        params(params: T.any(::Stripe::Apps::Secret::FindParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Apps::Secret)
+       }
+      def self.find(params = {}, opts = {}); end
+
+      # List all secrets stored on the given scope.
+      sig {
+        params(params: T.any(::Stripe::Apps::Secret::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+       }
+      def self.list(params = {}, opts = {}); end
+    end
+  end
+end