stripe 13.2.0 → 13.3.0.pre.beta.2

data/lib/stripe/resources/usage_record.rb

@@ -13,5 +13,18 @@ module Stripe
     def self.object_name
       "usage_record"
     end
+
+    # 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
+    # The usage quantity for the specified date.
+    attr_reader :quantity
+    # The ID of the subscription item this usage record contains data for.
+    attr_reader :subscription_item
+    # The timestamp when this usage occurred.
+    attr_reader :timestamp
   end
 end

data/lib/stripe/resources/usage_record_summary.rb

@@ -8,5 +8,23 @@ module Stripe
     def self.object_name
       "usage_record_summary"
     end
+
+    class Period < Stripe::StripeObject
+      attr_reader :end, :start
+    end
+    # Unique identifier for the object.
+    attr_reader :id
+    # The invoice in which this usage period has been billed for.
+    attr_reader :invoice
+    # 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
+    # Attribute for field period
+    attr_reader :period
+    # The ID of the subscription item this summary is describing.
+    attr_reader :subscription_item
+    # The total usage within this usage period.
+    attr_reader :total_usage
   end
 end

data/lib/stripe/resources/v2/amount.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class Amount
+      attr_reader :value, :currency
+    end
+  end
+end

data/lib/stripe/resources/v2/billing/meter_event.rb

@@ -10,6 +10,24 @@ module Stripe
         def self.object_name
           "v2.billing.meter_event"
         end
+
+        # The creation time of this meter event.
+        attr_reader :created
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        attr_reader :event_name
+        # A unique identifier for the event. If not provided, one will be generated. We recommend using a globally unique identifier for this. We’ll enforce uniqueness within a rolling 24 hour period.
+        attr_reader :identifier
+        # 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 of the object field.
+        attr_reader :object
+        # The payload of the event. This must contain the fields corresponding to a meter’s
+        # `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and
+        # `value_settings.event_payload_key` (default is `value`). Read more about the payload.
+        attr_reader :payload
+        # The time of the event. Must be within the past 35 calendar days or up to
+        # 5 minutes in the future. Defaults to current timestamp if not specified.
+        attr_reader :timestamp
       end
     end
   end

data/lib/stripe/resources/v2/billing/meter_event_adjustment.rb

@@ -9,6 +9,26 @@ module Stripe
         def self.object_name
           "v2.billing.meter_event_adjustment"
         end
+
+        class Cancel < Stripe::StripeObject
+          attr_reader :identifier
+        end
+        # Specifies which event to cancel.
+        attr_reader :cancel
+        # The time the adjustment was created.
+        attr_reader :created
+        # The name of the meter event. Corresponds with the `event_name` field on a meter.
+        attr_reader :event_name
+        # The unique id of this meter event adjustment.
+        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 of the object field.
+        attr_reader :object
+        # Open Enum. The meter event adjustment’s status.
+        attr_reader :status
+        # Open Enum. Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+        attr_reader :type
       end
     end
   end

data/lib/stripe/resources/v2/billing/meter_event_session.rb

@@ -9,6 +9,20 @@ module Stripe
         def self.object_name
           "v2.billing.meter_event_session"
         end
+
+        # The authentication token for this session.  Use this token when calling the
+        # high-throughput meter event API.
+        attr_reader :authentication_token
+        # The creation time of this session.
+        attr_reader :created
+        # The time at which this session will expire.
+        attr_reader :expires_at
+        # The unique id of this auth session.
+        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 of the object field.
+        attr_reader :object
       end
     end
   end

data/lib/stripe/resources/v2/event.rb

@@ -8,6 +8,27 @@ module Stripe
       def self.object_name
         "v2.core.event"
       end
+
+      class Reason < Stripe::StripeObject
+        class Request < Stripe::StripeObject
+          attr_reader :id, :idempotency_key
+        end
+        attr_reader :type, :request
+      end
+      # Authentication context needed to fetch the event or related object.
+      attr_reader :context
+      # Time at which the object was created.
+      attr_reader :created
+      # Unique identifier for the event.
+      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 of the object field.
+      attr_reader :object
+      # Reason for the event.
+      attr_reader :reason
+      # The type of the event.
+      attr_reader :type
     end
   end
 end

data/lib/stripe/resources/v2/event_destination.rb

@@ -8,6 +8,55 @@ module Stripe
       def self.object_name
         "v2.core.event_destination"
       end
+
+      class StatusDetails < Stripe::StripeObject
+        class Disabled < Stripe::StripeObject
+          attr_reader :reason
+        end
+        attr_reader :disabled
+      end
+
+      class AmazonEventbridge < Stripe::StripeObject
+        attr_reader :aws_account_id, :aws_event_source_arn, :aws_event_source_status
+      end
+
+      class WebhookEndpoint < Stripe::StripeObject
+        attr_reader :signing_secret, :url
+      end
+      # Time at which the object was created.
+      attr_reader :created
+      # An optional description of what the event destination is used for.
+      attr_reader :description
+      # The list of events to enable for this endpoint.
+      attr_reader :enabled_events
+      # Payload type of events being subscribed to.
+      attr_reader :event_payload
+      # Where events should be routed from.
+      attr_reader :events_from
+      # 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
+      # Metadata.
+      attr_reader :metadata
+      # Event destination name.
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      attr_reader :object
+      # If using the snapshot event payload, the API version events are rendered as.
+      attr_reader :snapshot_api_version
+      # Status. It can be set to either enabled or disabled.
+      attr_reader :status
+      # Additional information about event destination status.
+      attr_reader :status_details
+      # Event destination type.
+      attr_reader :type
+      # Time at which the object was last updated.
+      attr_reader :updated
+      # Amazon EventBridge configuration.
+      attr_reader :amazon_eventbridge
+      # Webhook endpoint configuration.
+      attr_reader :webhook_endpoint
     end
   end
 end

data/lib/stripe/resources/webhook_endpoint.rb

@@ -20,6 +20,33 @@ module Stripe
       "webhook_endpoint"
     end
 
+    # The API version events are rendered as for this webhook endpoint.
+    attr_reader :api_version
+    # The ID of the associated Connect application.
+    attr_reader :application
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    attr_reader :created
+    # An optional description of what the webhook is used for.
+    attr_reader :description
+    # The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.
+    attr_reader :enabled_events
+    # 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
+    # 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
+    # The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.
+    attr_reader :secret
+    # The status of the webhook. It can be `enabled` or `disabled`.
+    attr_reader :status
+    # The URL of the webhook endpoint.
+    attr_reader :url
+    # Always true for a deleted object
+    attr_reader :deleted
+
     # A webhook endpoint must have a url and a list of enabled_events. You may optionally specify the Boolean connect parameter. If set to true, then a Connect webhook endpoint that notifies the specified url about events from all connected accounts is created; otherwise an account webhook endpoint that notifies the specified url only about events from your account is created. You can also create webhook endpoints in the [webhooks settings](https://dashboard.stripe.com/account/webhooks) section of the Dashboard.
     def self.create(params = {}, opts = {})
       request_stripe_object(

data/lib/stripe/resources.rb

@@ -3,8 +3,10 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
+require "stripe/resources/account_notice"
 require "stripe/resources/account_session"
 require "stripe/resources/apple_pay_domain"
+require "stripe/resources/application"
 require "stripe/resources/application_fee"
 require "stripe/resources/application_fee_refund"
 require "stripe/resources/apps/secret"
@@ -12,16 +14,21 @@ require "stripe/resources/balance"
 require "stripe/resources/balance_transaction"
 require "stripe/resources/bank_account"
 require "stripe/resources/billing/alert"
+require "stripe/resources/billing/alert_triggered"
 require "stripe/resources/billing/credit_balance_summary"
 require "stripe/resources/billing/credit_balance_transaction"
 require "stripe/resources/billing/credit_grant"
 require "stripe/resources/billing/meter"
+require "stripe/resources/billing/meter_error_report"
 require "stripe/resources/billing/meter_event"
 require "stripe/resources/billing/meter_event_adjustment"
 require "stripe/resources/billing/meter_event_summary"
 require "stripe/resources/billing_portal/configuration"
 require "stripe/resources/billing_portal/session"
 require "stripe/resources/capability"
+require "stripe/resources/capital/financing_offer"
+require "stripe/resources/capital/financing_summary"
+require "stripe/resources/capital/financing_transaction"
 require "stripe/resources/card"
 require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
@@ -30,6 +37,7 @@ require "stripe/resources/climate/order"
 require "stripe/resources/climate/product"
 require "stripe/resources/climate/supplier"
 require "stripe/resources/confirmation_token"
+require "stripe/resources/connect_collection_transfer"
 require "stripe/resources/country_spec"
 require "stripe/resources/coupon"
 require "stripe/resources/credit_note"
@@ -41,6 +49,7 @@ require "stripe/resources/customer_session"
 require "stripe/resources/discount"
 require "stripe/resources/dispute"
 require "stripe/resources/entitlements/active_entitlement"
+require "stripe/resources/entitlements/active_entitlement_summary"
 require "stripe/resources/entitlements/feature"
 require "stripe/resources/ephemeral_key"
 require "stripe/resources/event"
@@ -48,34 +57,47 @@ require "stripe/resources/exchange_rate"
 require "stripe/resources/file"
 require "stripe/resources/file_link"
 require "stripe/resources/financial_connections/account"
+require "stripe/resources/financial_connections/account_inferred_balance"
 require "stripe/resources/financial_connections/account_owner"
 require "stripe/resources/financial_connections/account_ownership"
+require "stripe/resources/financial_connections/institution"
 require "stripe/resources/financial_connections/session"
 require "stripe/resources/financial_connections/transaction"
 require "stripe/resources/forwarding/request"
 require "stripe/resources/funding_instructions"
+require "stripe/resources/gift_cards/card"
+require "stripe/resources/gift_cards/transaction"
 require "stripe/resources/identity/verification_report"
 require "stripe/resources/identity/verification_session"
 require "stripe/resources/invoice"
 require "stripe/resources/invoice_item"
 require "stripe/resources/invoice_line_item"
+require "stripe/resources/invoice_payment"
 require "stripe/resources/invoice_rendering_template"
 require "stripe/resources/issuing/authorization"
 require "stripe/resources/issuing/card"
 require "stripe/resources/issuing/cardholder"
+require "stripe/resources/issuing/credit_underwriting_record"
 require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/dispute_settlement_detail"
+require "stripe/resources/issuing/fraud_liability_debit"
 require "stripe/resources/issuing/personalization_design"
 require "stripe/resources/issuing/physical_bundle"
+require "stripe/resources/issuing/settlement"
 require "stripe/resources/issuing/token"
 require "stripe/resources/issuing/transaction"
 require "stripe/resources/line_item"
 require "stripe/resources/login_link"
 require "stripe/resources/mandate"
+require "stripe/resources/margin"
+require "stripe/resources/order"
+require "stripe/resources/payment_attempt_record"
 require "stripe/resources/payment_intent"
 require "stripe/resources/payment_link"
 require "stripe/resources/payment_method"
 require "stripe/resources/payment_method_configuration"
 require "stripe/resources/payment_method_domain"
+require "stripe/resources/payment_record"
 require "stripe/resources/payout"
 require "stripe/resources/person"
 require "stripe/resources/plan"
@@ -84,12 +106,16 @@ require "stripe/resources/product"
 require "stripe/resources/product_feature"
 require "stripe/resources/promotion_code"
 require "stripe/resources/quote"
+require "stripe/resources/quote_line"
+require "stripe/resources/quote_preview_invoice"
+require "stripe/resources/quote_preview_subscription_schedule"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
 require "stripe/resources/refund"
 require "stripe/resources/reporting/report_run"
 require "stripe/resources/reporting/report_type"
+require "stripe/resources/reserve_transaction"
 require "stripe/resources/reversal"
 require "stripe/resources/review"
 require "stripe/resources/setup_attempt"
@@ -97,23 +123,28 @@ require "stripe/resources/setup_intent"
 require "stripe/resources/shipping_rate"
 require "stripe/resources/sigma/scheduled_query_run"
 require "stripe/resources/source"
+require "stripe/resources/source_mandate_notification"
 require "stripe/resources/source_transaction"
 require "stripe/resources/subscription"
 require "stripe/resources/subscription_item"
 require "stripe/resources/subscription_schedule"
+require "stripe/resources/tax/association"
 require "stripe/resources/tax/calculation"
 require "stripe/resources/tax/calculation_line_item"
+require "stripe/resources/tax/form"
 require "stripe/resources/tax/registration"
 require "stripe/resources/tax/settings"
 require "stripe/resources/tax/transaction"
 require "stripe/resources/tax/transaction_line_item"
 require "stripe/resources/tax_code"
+require "stripe/resources/tax_deducted_at_source"
 require "stripe/resources/tax_id"
 require "stripe/resources/tax_rate"
 require "stripe/resources/terminal/configuration"
 require "stripe/resources/terminal/connection_token"
 require "stripe/resources/terminal/location"
 require "stripe/resources/terminal/reader"
+require "stripe/resources/terminal/reader_collected_data"
 require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/token"
 require "stripe/resources/topup"

data/lib/stripe/services/account_notice_service.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountNoticeService < StripeService
+    # Retrieves a list of AccountNotice objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/account_notices",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves an AccountNotice object.
+    def retrieve(account_notice, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an AccountNotice object.
+    def update(account_notice, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/account_notices/%<account_notice>s", { account_notice: CGI.escape(account_notice) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services/billing/credit_balance_summary_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   module Billing
     class CreditBalanceSummaryService < StripeService
-      # Retrieves the credit balance summary for a customer
+      # Retrieves the credit balance summary for a customer.
       def retrieve(params = {}, opts = {})
         request(
           method: :get,

data/lib/stripe/services/billing/credit_balance_transaction_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   module Billing
     class CreditBalanceTransactionService < StripeService
-      # Retrieve a list of credit balance transactions
+      # Retrieve a list of credit balance transactions.
       def list(params = {}, opts = {})
         request(
           method: :get,
@@ -15,7 +15,7 @@ module Stripe
         )
       end
 
-      # Retrieves a credit balance transaction
+      # Retrieves a credit balance transaction.
       def retrieve(id, params = {}, opts = {})
         request(
           method: :get,

data/lib/stripe/services/billing/credit_grant_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   module Billing
     class CreditGrantService < StripeService
-      # Creates a credit grant
+      # Creates a credit grant.
       def create(params = {}, opts = {})
         request(
           method: :post,
@@ -37,7 +37,7 @@ module Stripe
         )
       end
 
-      # Retrieves a credit grant
+      # Retrieves a credit grant.
       def retrieve(id, params = {}, opts = {})
         request(
           method: :get,
@@ -48,7 +48,7 @@ module Stripe
         )
       end
 
-      # Updates a credit grant
+      # Updates a credit grant.
       def update(id, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/billing/meter_event_adjustment_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   module Billing
     class MeterEventAdjustmentService < StripeService
-      # Creates a billing meter event adjustment
+      # Creates a billing meter event adjustment.
       def create(params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/billing/meter_event_service.rb

@@ -4,7 +4,7 @@
 module Stripe
   module Billing
     class MeterEventService < StripeService
-      # Creates a billing meter event
+      # Creates a billing meter event.
       def create(params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/billing/meter_service.rb

@@ -11,7 +11,7 @@ module Stripe
         @event_summaries = Stripe::Billing::MeterEventSummaryService.new(@requestor)
       end
 
-      # Creates a billing meter
+      # Creates a billing meter.
       def create(params = {}, opts = {})
         request(
           method: :post,
@@ -22,7 +22,7 @@ module Stripe
         )
       end
 
-      # Deactivates a billing meter
+      # When a meter is deactivated, no more meter events will be accepted for this meter. You can't attach a deactivated meter to a price.
       def deactivate(id, params = {}, opts = {})
         request(
           method: :post,
@@ -44,7 +44,7 @@ module Stripe
         )
       end
 
-      # Reactivates a billing meter
+      # When a meter is reactivated, events for this meter can be accepted and you can attach the meter to a price.
       def reactivate(id, params = {}, opts = {})
         request(
           method: :post,
@@ -55,7 +55,7 @@ module Stripe
         )
       end
 
-      # Retrieves a billing meter given an ID
+      # Retrieves a billing meter given an ID.
       def retrieve(id, params = {}, opts = {})
         request(
           method: :get,
@@ -66,7 +66,7 @@ module Stripe
         )
       end
 
-      # Updates a billing meter
+      # Updates a billing meter.
       def update(id, params = {}, opts = {})
         request(
           method: :post,

data/lib/stripe/services/capital/financing_offer_service.rb

@@ -0,0 +1,42 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingOfferService < StripeService
+      # Retrieves the financing offers available for Connected accounts that belong to your platform.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_offers",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Acknowledges that platform has received and delivered the financing_offer to
+      # the intended merchant recipient.
+      def mark_delivered(financing_offer, params = {}, opts = {})
+        request(
+          method: :post,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s/mark_delivered", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Get the details of the financing offer
+      def retrieve(financing_offer, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_offers/%<financing_offer>s", { financing_offer: CGI.escape(financing_offer) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_summary_service.rb

@@ -0,0 +1,19 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingSummaryService < StripeService
+      # Retrieve the financing state for the account that was authenticated in the request.
+      def retrieve(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_summary",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital/financing_transaction_service.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Capital
+    class FinancingTransactionService < StripeService
+      # Returns a list of financing transactions. The transactions are returned in sorted order,
+      # with the most recent transactions appearing first.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/capital/financing_transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a financing transaction for a financing offer.
+      def retrieve(financing_transaction, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/capital/financing_transactions/%<financing_transaction>s", { financing_transaction: CGI.escape(financing_transaction) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/capital_service.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class CapitalService < StripeService
+    attr_reader :financing_offers, :financing_summary, :financing_transactions
+
+    def initialize(requestor)
+      super(requestor)
+      @financing_offers = Stripe::Capital::FinancingOfferService.new(@requestor)
+      @financing_summary = Stripe::Capital::FinancingSummaryService.new(@requestor)
+      @financing_transactions = Stripe::Capital::FinancingTransactionService.new(@requestor)
+    end
+  end
+end