stripe 13.3.0 → 13.4.0.pre.beta.2

data/lib/stripe/resources/bank_account.rb

@@ -19,6 +19,86 @@ module Stripe
       "bank_account"
     end
 
+    class FutureRequirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+    end
+
+    class Requirements < Stripe::StripeObject
+      class Error < Stripe::StripeObject
+        # The code for the type of error.
+        attr_reader :code
+        # An informative message that indicates the error type and provides additional details about the error.
+        attr_reader :reason
+        # The specific user onboarding requirement field (in the requirements hash) that needs to be resolved.
+        attr_reader :requirement
+      end
+      # Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.
+      attr_reader :currently_due
+      # Fields that are `currently_due` and need to be collected again because validation or verification failed.
+      attr_reader :errors
+      # Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account.
+      attr_reader :past_due
+      # Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending.
+      attr_reader :pending_verification
+    end
+    # The ID of the account that the bank account is associated with.
+    attr_reader :account
+    # The name of the person or business that owns the bank account.
+    attr_reader :account_holder_name
+    # The type of entity that holds the account. This can be either `individual` or `company`.
+    attr_reader :account_holder_type
+    # The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.
+    attr_reader :account_type
+    # A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.
+    attr_reader :available_payout_methods
+    # Name of the bank associated with the routing number (e.g., `WELLS FARGO`).
+    attr_reader :bank_name
+    # Two-letter ISO code representing the country the bank account is located in.
+    attr_reader :country
+    # Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.
+    attr_reader :currency
+    # The ID of the customer that the bank account is associated with.
+    attr_reader :customer
+    # Whether this bank account is the default external account for its currency.
+    attr_reader :default_for_currency
+    # Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.
+    attr_reader :fingerprint
+    # Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.
+    attr_reader :future_requirements
+    # Unique identifier for the object.
+    attr_reader :id
+    # The last four digits of the bank account number.
+    attr_reader :last4
+    # 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.
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    attr_reader :object
+    # Information about the requirements for the bank account, including what information needs to be collected.
+    attr_reader :requirements
+    # The routing transit number for the bank account.
+    attr_reader :routing_number
+    # For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.
+    #
+    # For external accounts, possible values are `new`, `errored` and `verification_failed`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.
+    attr_reader :status
+    # Always true for a deleted object
+    attr_reader :deleted
+
     def verify(params = {}, opts = {})
       request_stripe_object(
         method: :post,
@@ -38,10 +118,12 @@ module Stripe
     end
 
     def resource_url
-      if respond_to?(:customer)
+      if !customer.nil?
         "#{Customer.resource_url}/#{CGI.escape(customer)}/sources/#{CGI.escape(id)}"
-      elsif respond_to?(:account)
+      elsif !account.nil?
         "#{Account.resource_url}/#{CGI.escape(account)}/external_accounts/#{CGI.escape(id)}"
+      else
+        raise InvalidRequestError, "Could not determine which URL to request: [account, customer] fields are all null"
       end
     end
 

data/lib/stripe/resources/billing/alert.rb

@@ -13,6 +13,150 @@ module Stripe
         "billing.alert"
       end
 
+      class UsageThreshold < Stripe::StripeObject
+        class Filter < Stripe::StripeObject
+          # Limit the scope of the alert to this customer ID
+          attr_reader :customer
+          # Attribute for field type
+          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.
+        attr_reader :filters
+        # The value at which this alert will trigger.
+        attr_reader :gte
+        # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
+        attr_reader :meter
+        # Defines how the alert will behave.
+        attr_reader :recurrence
+      end
+
+      class ListParams < Stripe::RequestParams
+        # Filter results to only include this type of alert.
+        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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        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.
+        attr_accessor :limit
+        # Filter results to only include alerts with the given meter.
+        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.
+        attr_accessor :starting_after
+
+        def initialize(
+          alert_type: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          meter: nil,
+          starting_after: nil
+        )
+          @alert_type = alert_type
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @meter = meter
+          @starting_after = starting_after
+        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.
+            attr_accessor :customer
+            # What type of filter is being applied to this usage alert.
+            attr_accessor :type
+
+            def initialize(customer: nil, type: nil)
+              @customer = customer
+              @type = type
+            end
+          end
+          # The filters allows limiting the scope of this usage alert. You can only specify up to one filter at this time.
+          attr_accessor :filters
+          # Defines at which value the alert will fire.
+          attr_accessor :gte
+          # The [Billing Meter](/api/billing/meter) ID whose usage is monitored.
+          attr_accessor :meter
+          # Whether the alert should only fire only once, or once per billing cycle.
+          attr_accessor :recurrence
+
+          def initialize(filters: nil, gte: nil, meter: nil, recurrence: nil)
+            @filters = filters
+            @gte = gte
+            @meter = meter
+            @recurrence = recurrence
+          end
+        end
+        # The type of alert to create.
+        attr_accessor :alert_type
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The title of the alert.
+        attr_accessor :title
+        # The configuration of the usage threshold.
+        attr_accessor :usage_threshold
+
+        def initialize(alert_type: nil, expand: nil, title: nil, usage_threshold: nil)
+          @alert_type = alert_type
+          @expand = expand
+          @title = title
+          @usage_threshold = usage_threshold
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ActivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class ArchiveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+
+      class DeactivateParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # Defines the type of the alert.
+      attr_reader :alert_type
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # Status of the alert. This can be active, inactive or archived.
+      attr_reader :status
+      # Title of the alert.
+      attr_reader :title
+      # Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
+      attr_reader :usage_threshold
+
       # Reactivates this alert, allowing it to trigger again.
       def activate(params = {}, opts = {})
         request_stripe_object(

data/lib/stripe/resources/billing/alert_triggered.rb

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Billing
+    class AlertTriggered < APIResource
+      OBJECT_NAME = "billing.alert_triggered"
+      def self.object_name
+        "billing.alert_triggered"
+      end
+
+      # 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.
+      attr_reader :alert
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # ID of customer for which the alert triggered
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # The value triggering the alert
+      attr_reader :value
+    end
+  end
+end

data/lib/stripe/resources/billing/credit_balance_summary.rb

@@ -9,6 +9,83 @@ module Stripe
       def self.object_name
         "billing.credit_balance_summary"
       end
+
+      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).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          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).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+        end
+        # Attribute for field available_balance
+        attr_reader :available_balance
+        # Attribute for field ledger_balance
+        attr_reader :ledger_balance
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        class Filter < Stripe::RequestParams
+          class ApplicabilityScope < Stripe::RequestParams
+            # The price type that credit grants can apply to. We currently only support the `metered` price type.
+            attr_accessor :price_type
+
+            def initialize(price_type: nil)
+              @price_type = price_type
+            end
+          end
+          # The billing credit applicability scope for which to fetch credit balance summary.
+          attr_accessor :applicability_scope
+          # The credit grant for which to fetch credit balance summary.
+          attr_accessor :credit_grant
+          # Specify the type of this filter.
+          attr_accessor :type
+
+          def initialize(applicability_scope: nil, credit_grant: nil, type: nil)
+            @applicability_scope = applicability_scope
+            @credit_grant = credit_grant
+            @type = type
+          end
+        end
+        # The customer for which to fetch credit balance summary.
+        attr_accessor :customer
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # The filter criteria for the credit balance summary.
+        attr_accessor :filter
+
+        def initialize(customer: nil, expand: nil, filter: nil)
+          @customer = customer
+          @expand = expand
+          @filter = filter
+        end
+      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.
+      attr_reader :balances
+      # The customer the balance is for.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
     end
   end
 end

data/lib/stripe/resources/billing/credit_balance_transaction.rb

@@ -12,6 +12,122 @@ module Stripe
         "billing.credit_balance_transaction"
       end
 
+      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).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+        end
+
+        class CreditsApplicationInvoiceVoided < Stripe::StripeObject
+          # The invoice to which the reinstated billing credits were originally applied.
+          attr_reader :invoice
+          # The invoice line item to which the reinstated billing credits were originally applied.
+          attr_reader :invoice_line_item
+        end
+        # Attribute for field 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`.
+        attr_reader :credits_application_invoice_voided
+        # The type of credit transaction.
+        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).
+            attr_reader :currency
+            # A positive integer representing the amount.
+            attr_reader :value
+          end
+          # The monetary amount.
+          attr_reader :monetary
+          # The type of this amount. We currently only support `monetary` billing credits.
+          attr_reader :type
+        end
+
+        class CreditsApplied < Stripe::StripeObject
+          # The invoice to which the billing credits were applied.
+          attr_reader :invoice
+          # The invoice line item to which the billing credits were applied.
+          attr_reader :invoice_line_item
+        end
+        # Attribute for field amount
+        attr_reader :amount
+        # Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`.
+        attr_reader :credits_applied
+        # The type of debit transaction.
+        attr_reader :type
+      end
+
+      class ListParams < Stripe::RequestParams
+        # The credit grant for which to fetch credit balance transactions.
+        attr_accessor :credit_grant
+        # The customer for which to fetch credit balance transactions.
+        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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        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.
+        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.
+        attr_accessor :starting_after
+
+        def initialize(
+          credit_grant: nil,
+          customer: nil,
+          ending_before: nil,
+          expand: nil,
+          limit: nil,
+          starting_after: nil
+        )
+          @credit_grant = credit_grant
+          @customer = customer
+          @ending_before = ending_before
+          @expand = expand
+          @limit = limit
+          @starting_after = starting_after
+        end
+      end
+
+      class RetrieveParams < Stripe::RequestParams
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+
+        def initialize(expand: nil)
+          @expand = expand
+        end
+      end
+      # Time at which the object was created. Measured in seconds since the Unix epoch.
+      attr_reader :created
+      # Credit details for this credit balance transaction. Only present if type is `credit`.
+      attr_reader :credit
+      # The credit grant associated with this credit balance transaction.
+      attr_reader :credit_grant
+      # Debit details for this credit balance transaction. Only present if type is `debit`.
+      attr_reader :debit
+      # The effective time of this credit balance transaction.
+      attr_reader :effective_at
+      # Unique identifier for the object.
+      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.
+      attr_reader :livemode
+      # String representing the object's type. Objects of the same type share the same value.
+      attr_reader :object
+      # ID of the test clock this credit balance transaction belongs to.
+      attr_reader :test_clock
+      # The type of credit balance transaction (credit or debit).
+      attr_reader :type
+
       # Retrieve a list of credit balance transactions.
       def self.list(params = {}, opts = {})
         request_stripe_object(