stripe 15.4.0 → 15.5.0.pre.beta.2

data/rbi/stripe/resources/billing/alert.rbi

@@ -1,201 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module Billing
-    # A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
-    class Alert < APIResource
-      class UsageThreshold < Stripe::StripeObject
-        class Filter < Stripe::StripeObject
-          # Limit the scope of the alert to this customer ID
-          sig { returns(T.nilable(T.any(String, Stripe::Customer))) }
-          attr_reader :customer
-          # Attribute for field type
-          sig { returns(String) }
-          attr_reader :type
-        end
-        # The filters allow limiting the scope of this usage alert. You can only specify up to one filter at this time.
-        sig { returns(T.nilable(T::Array[Filter])) }
-        attr_reader :filters
-        # The value at which this alert will trigger.
-        sig { returns(Integer) }
-        attr_reader :gte
-        # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
-        sig { returns(T.any(String, Stripe::Billing::Meter)) }
-        attr_reader :meter
-        # Defines how the alert will behave.
-        sig { returns(String) }
-        attr_reader :recurrence
-      end
-      # Defines the type of the alert.
-      sig { returns(String) }
-      attr_reader :alert_type
-      # 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
-      # Status of the alert. This can be active, inactive or archived.
-      sig { returns(T.nilable(String)) }
-      attr_reader :status
-      # Title of the alert.
-      sig { returns(String) }
-      attr_reader :title
-      # Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
-      sig { returns(T.nilable(UsageThreshold)) }
-      attr_reader :usage_threshold
-      class ListParams < Stripe::RequestParams
-        # Filter results to only include this type of alert.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :alert_type
-        # 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 results to only include alerts with the given meter.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :meter
-        # 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(alert_type: T.nilable(String), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), meter: T.nilable(String), starting_after: T.nilable(String)).void
-         }
-        def initialize(
-          alert_type: nil,
-          ending_before: nil,
-          expand: nil,
-          limit: nil,
-          meter: nil,
-          starting_after: nil
-        ); end
-      end
-      class CreateParams < Stripe::RequestParams
-        class UsageThreshold < Stripe::RequestParams
-          class Filter < Stripe::RequestParams
-            # Limit the scope to this usage alert only to this customer.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :customer
-            # What type of filter is being applied to this usage alert.
-            sig { returns(String) }
-            attr_accessor :type
-            sig { params(customer: T.nilable(String), type: String).void }
-            def initialize(customer: nil, type: nil); end
-          end
-          # The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
-          sig {
-            returns(T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]))
-           }
-          attr_accessor :filters
-          # Defines at which value the alert will fire.
-          sig { returns(Integer) }
-          attr_accessor :gte
-          # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
-          sig { returns(String) }
-          attr_accessor :meter
-          # Whether the alert should only fire only once, or once per billing cycle.
-          sig { returns(String) }
-          attr_accessor :recurrence
-          sig {
-            params(filters: T.nilable(T::Array[::Stripe::Billing::Alert::CreateParams::UsageThreshold::Filter]), gte: Integer, meter: String, recurrence: String).void
-           }
-          def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil); end
-        end
-        # The type of alert to create.
-        sig { returns(String) }
-        attr_accessor :alert_type
-        # Specifies which fields in the response should be expanded.
-        sig { returns(T.nilable(T::Array[String])) }
-        attr_accessor :expand
-        # The title of the alert.
-        sig { returns(String) }
-        attr_accessor :title
-        # The configuration of the usage threshold.
-        sig { returns(T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold)) }
-        attr_accessor :usage_threshold
-        sig {
-          params(alert_type: String, expand: T.nilable(T::Array[String]), title: String, usage_threshold: T.nilable(::Stripe::Billing::Alert::CreateParams::UsageThreshold)).void
-         }
-        def initialize(alert_type: nil, expand: nil, title: nil, usage_threshold: nil); end
-      end
-      class ActivateParams < 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
-      class ArchiveParams < 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
-      class DeactivateParams < 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
-      # Reactivates this alert, allowing it to trigger again.
-      sig {
-        params(params: T.any(::Stripe::Billing::Alert::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def activate(params = {}, opts = {}); end
-
-      # Reactivates this alert, allowing it to trigger again.
-      sig {
-        params(id: String, params: T.any(::Stripe::Billing::Alert::ActivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def self.activate(id, params = {}, opts = {}); end
-
-      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
-      sig {
-        params(params: T.any(::Stripe::Billing::Alert::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def archive(params = {}, opts = {}); end
-
-      # Archives this alert, removing it from the list view and APIs. This is non-reversible.
-      sig {
-        params(id: String, params: T.any(::Stripe::Billing::Alert::ArchiveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def self.archive(id, params = {}, opts = {}); end
-
-      # Creates a billing alert
-      sig {
-        params(params: T.any(::Stripe::Billing::Alert::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def self.create(params = {}, opts = {}); end
-
-      # Deactivates this alert, preventing it from triggering.
-      sig {
-        params(params: T.any(::Stripe::Billing::Alert::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def deactivate(params = {}, opts = {}); end
-
-      # Deactivates this alert, preventing it from triggering.
-      sig {
-        params(id: String, params: T.any(::Stripe::Billing::Alert::DeactivateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Billing::Alert)
-       }
-      def self.deactivate(id, params = {}, opts = {}); end
-
-      # Lists billing active and inactive alerts
-      sig {
-        params(params: T.any(::Stripe::Billing::Alert::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/billing/alert_triggered.rbi

@@ -1,28 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module Billing
-    class AlertTriggered < APIResource
-      # A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
-      sig { returns(Stripe::Billing::Alert) }
-      attr_reader :alert
-      # Time at which the object was created. Measured in seconds since the Unix epoch.
-      sig { returns(Integer) }
-      attr_reader :created
-      # ID of customer for which the alert triggered
-      sig { returns(String) }
-      attr_reader :customer
-      # 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 value triggering the alert
-      sig { returns(Integer) }
-      attr_reader :value
-    end
-  end
-end

data/rbi/stripe/resources/billing/credit_balance_summary.rbi

@@ -1,63 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module Billing
-    # Indicates the billing credit balance for billing credits granted to a customer.
-    class CreditBalanceSummary < SingletonAPIResource
-      class Balance < Stripe::StripeObject
-        class AvailableBalance < Stripe::StripeObject
-          class Monetary < Stripe::StripeObject
-            # 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
-            # A positive integer representing the amount.
-            sig { returns(Integer) }
-            attr_reader :value
-          end
-          # The monetary amount.
-          sig { returns(T.nilable(Monetary)) }
-          attr_reader :monetary
-          # The type of this amount. We currently only support `monetary` billing credits.
-          sig { returns(String) }
-          attr_reader :type
-        end
-        class LedgerBalance < Stripe::StripeObject
-          class Monetary < Stripe::StripeObject
-            # 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
-            # A positive integer representing the amount.
-            sig { returns(Integer) }
-            attr_reader :value
-          end
-          # The monetary amount.
-          sig { returns(T.nilable(Monetary)) }
-          attr_reader :monetary
-          # The type of this amount. We currently only support `monetary` billing credits.
-          sig { returns(String) }
-          attr_reader :type
-        end
-        # Attribute for field available_balance
-        sig { returns(AvailableBalance) }
-        attr_reader :available_balance
-        # Attribute for field ledger_balance
-        sig { returns(LedgerBalance) }
-        attr_reader :ledger_balance
-      end
-      # The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry.
-      sig { returns(T::Array[Balance]) }
-      attr_reader :balances
-      # The customer the balance is for.
-      sig { returns(T.any(String, Stripe::Customer)) }
-      attr_reader :customer
-      # 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/billing/credit_balance_transaction.rbi

@@ -1,147 +0,0 @@
-# File generated from our OpenAPI spec
-# frozen_string_literal: true
-
-# typed: true
-module Stripe
-  module Billing
-    # A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.
-    class CreditBalanceTransaction < APIResource
-      class Credit < Stripe::StripeObject
-        class Amount < Stripe::StripeObject
-          class Monetary < Stripe::StripeObject
-            # 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
-            # A positive integer representing the amount.
-            sig { returns(Integer) }
-            attr_reader :value
-          end
-          # The monetary amount.
-          sig { returns(T.nilable(Monetary)) }
-          attr_reader :monetary
-          # The type of this amount. We currently only support `monetary` billing credits.
-          sig { returns(String) }
-          attr_reader :type
-        end
-        class CreditsApplicationInvoiceVoided < Stripe::StripeObject
-          # The invoice to which the reinstated billing credits were originally applied.
-          sig { returns(T.any(String, Stripe::Invoice)) }
-          attr_reader :invoice
-          # The invoice line item to which the reinstated billing credits were originally applied.
-          sig { returns(String) }
-          attr_reader :invoice_line_item
-        end
-        # Attribute for field amount
-        sig { returns(Amount) }
-        attr_reader :amount
-        # Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`.
-        sig { returns(T.nilable(CreditsApplicationInvoiceVoided)) }
-        attr_reader :credits_application_invoice_voided
-        # The type of credit transaction.
-        sig { returns(String) }
-        attr_reader :type
-      end
-      class Debit < Stripe::StripeObject
-        class Amount < Stripe::StripeObject
-          class Monetary < Stripe::StripeObject
-            # 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
-            # A positive integer representing the amount.
-            sig { returns(Integer) }
-            attr_reader :value
-          end
-          # The monetary amount.
-          sig { returns(T.nilable(Monetary)) }
-          attr_reader :monetary
-          # The type of this amount. We currently only support `monetary` billing credits.
-          sig { returns(String) }
-          attr_reader :type
-        end
-        class CreditsApplied < Stripe::StripeObject
-          # The invoice to which the billing credits were applied.
-          sig { returns(T.any(String, Stripe::Invoice)) }
-          attr_reader :invoice
-          # The invoice line item to which the billing credits were applied.
-          sig { returns(String) }
-          attr_reader :invoice_line_item
-        end
-        # Attribute for field amount
-        sig { returns(Amount) }
-        attr_reader :amount
-        # Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
-        sig { returns(T.nilable(CreditsApplied)) }
-        attr_reader :credits_applied
-        # The type of debit transaction.
-        sig { returns(String) }
-        attr_reader :type
-      end
-      # Time at which the object was created. Measured in seconds since the Unix epoch.
-      sig { returns(Integer) }
-      attr_reader :created
-      # Credit details for this credit balance transaction. Only present if type is `credit`.
-      sig { returns(T.nilable(Credit)) }
-      attr_reader :credit
-      # The credit grant associated with this credit balance transaction.
-      sig { returns(T.any(String, Stripe::Billing::CreditGrant)) }
-      attr_reader :credit_grant
-      # Debit details for this credit balance transaction. Only present if type is `debit`.
-      sig { returns(T.nilable(Debit)) }
-      attr_reader :debit
-      # The effective time of this credit balance transaction.
-      sig { returns(Integer) }
-      attr_reader :effective_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
-      # String representing the object's type. Objects of the same type share the same value.
-      sig { returns(String) }
-      attr_reader :object
-      # ID of the test clock this credit balance transaction belongs to.
-      sig { returns(T.nilable(T.any(String, Stripe::TestHelpers::TestClock))) }
-      attr_reader :test_clock
-      # The type of credit balance transaction (credit or debit).
-      sig { returns(T.nilable(String)) }
-      attr_reader :type
-      class ListParams < Stripe::RequestParams
-        # The credit grant for which to fetch credit balance transactions.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :credit_grant
-        # The customer for which to fetch credit balance transactions.
-        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(credit_grant: T.nilable(String), 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(
-          credit_grant: nil,
-          customer: nil,
-          ending_before: nil,
-          expand: nil,
-          limit: nil,
-          starting_after: nil
-        ); end
-      end
-      # Retrieve a list of credit balance transactions.
-      sig {
-        params(params: T.any(::Stripe::Billing::CreditBalanceTransaction::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
-       }
-      def self.list(params = {}, opts = {}); end
-    end
-  end
-end