stripe 12.5.0 → 15.0.0

data/lib/stripe/services/treasury/transaction_entry_service.rb

@@ -0,0 +1,117 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionEntryService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+
+        class EffectiveAt < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+        # Only return TransactionEntries that were created during the given date interval.
+        attr_accessor :created
+        # Attribute for param field effective_at
+        attr_accessor :effective_at
+        # 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
+        # Returns objects associated with this FinancialAccount.
+        attr_accessor :financial_account
+        # 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
+        # The results are in reverse chronological order by `created` or `effective_at`. The default is `created`.
+        attr_accessor :order_by
+        # 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
+        # Only return TransactionEntries associated with this Transaction.
+        attr_accessor :transaction
+
+        def initialize(
+          created: nil,
+          effective_at: nil,
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          order_by: nil,
+          starting_after: nil,
+          transaction: nil
+        )
+          @created = created
+          @effective_at = effective_at
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @order_by = order_by
+          @starting_after = starting_after
+          @transaction = transaction
+        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
+
+      # Retrieves a list of TransactionEntry objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/transaction_entries",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves a TransactionEntry object.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/transaction_entries/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury/transaction_service.rb

@@ -0,0 +1,125 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionService < StripeService
+      class ListParams < Stripe::RequestParams
+        class Created < Stripe::RequestParams
+          # Minimum value to filter by (exclusive)
+          attr_accessor :gt
+          # Minimum value to filter by (inclusive)
+          attr_accessor :gte
+          # Maximum value to filter by (exclusive)
+          attr_accessor :lt
+          # Maximum value to filter by (inclusive)
+          attr_accessor :lte
+
+          def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+            @gt = gt
+            @gte = gte
+            @lt = lt
+            @lte = lte
+          end
+        end
+
+        class StatusTransitions < Stripe::RequestParams
+          class PostedAt < Stripe::RequestParams
+            # Minimum value to filter by (exclusive)
+            attr_accessor :gt
+            # Minimum value to filter by (inclusive)
+            attr_accessor :gte
+            # Maximum value to filter by (exclusive)
+            attr_accessor :lt
+            # Maximum value to filter by (inclusive)
+            attr_accessor :lte
+
+            def initialize(gt: nil, gte: nil, lt: nil, lte: nil)
+              @gt = gt
+              @gte = gte
+              @lt = lt
+              @lte = lte
+            end
+          end
+          # Returns Transactions with `posted_at` within the specified range.
+          attr_accessor :posted_at
+
+          def initialize(posted_at: nil)
+            @posted_at = posted_at
+          end
+        end
+        # Only return Transactions that were created during the given date interval.
+        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.
+        attr_accessor :ending_before
+        # Specifies which fields in the response should be expanded.
+        attr_accessor :expand
+        # Returns objects associated with this FinancialAccount.
+        attr_accessor :financial_account
+        # 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
+        # The results are in reverse chronological order by `created` or `posted_at`. The default is `created`.
+        attr_accessor :order_by
+        # 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
+        # Only return Transactions that have the given status: `open`, `posted`, or `void`.
+        attr_accessor :status
+        # A filter for the `status_transitions.posted_at` timestamp. When using this filter, `status=posted` and `order_by=posted_at` must also be specified.
+        attr_accessor :status_transitions
+
+        def initialize(
+          created: nil,
+          ending_before: nil,
+          expand: nil,
+          financial_account: nil,
+          limit: nil,
+          order_by: nil,
+          starting_after: nil,
+          status: nil,
+          status_transitions: nil
+        )
+          @created = created
+          @ending_before = ending_before
+          @expand = expand
+          @financial_account = financial_account
+          @limit = limit
+          @order_by = order_by
+          @starting_after = starting_after
+          @status = status
+          @status_transitions = status_transitions
+        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
+
+      # Retrieves a list of Transaction objects.
+      def list(params = {}, opts = {})
+        request(
+          method: :get,
+          path: "/v1/treasury/transactions",
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+
+      # Retrieves the details of an existing Transaction.
+      def retrieve(id, params = {}, opts = {})
+        request(
+          method: :get,
+          path: format("/v1/treasury/transactions/%<id>s", { id: CGI.escape(id) }),
+          params: params,
+          opts: opts,
+          base_address: :api
+        )
+      end
+    end
+  end
+end

data/lib/stripe/services/treasury_service.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class TreasuryService < StripeService
+    attr_reader :credit_reversals, :debit_reversals, :financial_accounts, :inbound_transfers, :outbound_payments, :outbound_transfers, :received_credits, :received_debits, :transactions, :transaction_entries
+
+    def initialize(requestor)
+      super(requestor)
+      @credit_reversals = Stripe::Treasury::CreditReversalService.new(@requestor)
+      @debit_reversals = Stripe::Treasury::DebitReversalService.new(@requestor)
+      @financial_accounts = Stripe::Treasury::FinancialAccountService.new(@requestor)
+      @inbound_transfers = Stripe::Treasury::InboundTransferService.new(@requestor)
+      @outbound_payments = Stripe::Treasury::OutboundPaymentService.new(@requestor)
+      @outbound_transfers = Stripe::Treasury::OutboundTransferService.new(@requestor)
+      @received_credits = Stripe::Treasury::ReceivedCreditService.new(@requestor)
+      @received_debits = Stripe::Treasury::ReceivedDebitService.new(@requestor)
+      @transactions = Stripe::Treasury::TransactionService.new(@requestor)
+      @transaction_entries = Stripe::Treasury::TransactionEntryService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/v1_services.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Stripe
+  class V1Services < StripeService
+    # v1 accessors: The beginning of the section generated from our OpenAPI spec
+    attr_reader :accounts
+    attr_reader :account_links, :account_sessions, :apple_pay_domains, :application_fees, :apps, :balance, :balance_transactions, :billing, :billing_portal, :charges, :checkout, :climate, :confirmation_tokens, :test_helpers, :country_specs, :coupons, :credit_notes, :customers, :customer_sessions, :disputes, :entitlements, :ephemeral_keys, :events, :exchange_rates, :files, :file_links, :financial_connections, :forwarding, :identity, :invoices, :invoice_payments, :invoice_rendering_templates, :invoice_items, :issuing, :mandates, :payment_intents, :payment_links, :payment_methods, :payment_method_configurations, :payment_method_domains, :payouts, :plans, :prices, :products, :promotion_codes, :quotes, :radar, :refunds, :reporting, :reviews, :sigma, :setup_attempts, :setup_intents, :shipping_rates, :sources, :subscriptions, :subscription_items, :subscription_schedules, :tax, :tax_codes, :tax_ids, :tax_rates, :terminal, :tokens, :topups, :transfers, :treasury, :webhook_endpoints
+    # v1 accessors: The end of the section generated from our OpenAPI spec
+
+    # OAuthService is manually maintained, as it has special behaviors
+    attr_reader :oauth
+
+    def initialize(requestor)
+      super(requestor)
+      # v1 services: The beginning of the section generated from our OpenAPI spec
+      @accounts = Stripe::AccountService.new(@requestor)
+      @account_links = Stripe::AccountLinkService.new(@requestor)
+      @account_sessions = Stripe::AccountSessionService.new(@requestor)
+      @apple_pay_domains = Stripe::ApplePayDomainService.new(@requestor)
+      @application_fees = Stripe::ApplicationFeeService.new(@requestor)
+      @apps = Stripe::AppsService.new(@requestor)
+      @balance = Stripe::BalanceService.new(@requestor)
+      @balance_transactions = Stripe::BalanceTransactionService.new(@requestor)
+      @billing = Stripe::BillingService.new(@requestor)
+      @billing_portal = Stripe::BillingPortalService.new(@requestor)
+      @charges = Stripe::ChargeService.new(@requestor)
+      @checkout = Stripe::CheckoutService.new(@requestor)
+      @climate = Stripe::ClimateService.new(@requestor)
+      @confirmation_tokens = Stripe::ConfirmationTokenService.new(@requestor)
+      @test_helpers = Stripe::TestHelpersService.new(@requestor)
+      @country_specs = Stripe::CountrySpecService.new(@requestor)
+      @coupons = Stripe::CouponService.new(@requestor)
+      @credit_notes = Stripe::CreditNoteService.new(@requestor)
+      @customers = Stripe::CustomerService.new(@requestor)
+      @customer_sessions = Stripe::CustomerSessionService.new(@requestor)
+      @disputes = Stripe::DisputeService.new(@requestor)
+      @entitlements = Stripe::EntitlementsService.new(@requestor)
+      @ephemeral_keys = Stripe::EphemeralKeyService.new(@requestor)
+      @events = Stripe::EventService.new(@requestor)
+      @exchange_rates = Stripe::ExchangeRateService.new(@requestor)
+      @files = Stripe::FileService.new(@requestor)
+      @file_links = Stripe::FileLinkService.new(@requestor)
+      @financial_connections = Stripe::FinancialConnectionsService.new(@requestor)
+      @forwarding = Stripe::ForwardingService.new(@requestor)
+      @identity = Stripe::IdentityService.new(@requestor)
+      @invoices = Stripe::InvoiceService.new(@requestor)
+      @invoice_payments = Stripe::InvoicePaymentService.new(@requestor)
+      @invoice_rendering_templates = Stripe::InvoiceRenderingTemplateService.new(@requestor)
+      @invoice_items = Stripe::InvoiceItemService.new(@requestor)
+      @issuing = Stripe::IssuingService.new(@requestor)
+      @mandates = Stripe::MandateService.new(@requestor)
+      @payment_intents = Stripe::PaymentIntentService.new(@requestor)
+      @payment_links = Stripe::PaymentLinkService.new(@requestor)
+      @payment_methods = Stripe::PaymentMethodService.new(@requestor)
+      @payment_method_configurations = Stripe::PaymentMethodConfigurationService.new(@requestor)
+      @payment_method_domains = Stripe::PaymentMethodDomainService.new(@requestor)
+      @payouts = Stripe::PayoutService.new(@requestor)
+      @plans = Stripe::PlanService.new(@requestor)
+      @prices = Stripe::PriceService.new(@requestor)
+      @products = Stripe::ProductService.new(@requestor)
+      @promotion_codes = Stripe::PromotionCodeService.new(@requestor)
+      @quotes = Stripe::QuoteService.new(@requestor)
+      @radar = Stripe::RadarService.new(@requestor)
+      @refunds = Stripe::RefundService.new(@requestor)
+      @reporting = Stripe::ReportingService.new(@requestor)
+      @reviews = Stripe::ReviewService.new(@requestor)
+      @sigma = Stripe::SigmaService.new(@requestor)
+      @setup_attempts = Stripe::SetupAttemptService.new(@requestor)
+      @setup_intents = Stripe::SetupIntentService.new(@requestor)
+      @shipping_rates = Stripe::ShippingRateService.new(@requestor)
+      @sources = Stripe::SourceService.new(@requestor)
+      @subscriptions = Stripe::SubscriptionService.new(@requestor)
+      @subscription_items = Stripe::SubscriptionItemService.new(@requestor)
+      @subscription_schedules = Stripe::SubscriptionScheduleService.new(@requestor)
+      @tax = Stripe::TaxService.new(@requestor)
+      @tax_codes = Stripe::TaxCodeService.new(@requestor)
+      @tax_ids = Stripe::TaxIdService.new(@requestor)
+      @tax_rates = Stripe::TaxRateService.new(@requestor)
+      @terminal = Stripe::TerminalService.new(@requestor)
+      @tokens = Stripe::TokenService.new(@requestor)
+      @topups = Stripe::TopupService.new(@requestor)
+      @transfers = Stripe::TransferService.new(@requestor)
+      @treasury = Stripe::TreasuryService.new(@requestor)
+      @webhook_endpoints = Stripe::WebhookEndpointService.new(@requestor)
+      # v1 services: The end of the section generated from our OpenAPI spec
+
+      @oauth = OAuthService.new(@requestor)
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventAdjustmentService < StripeService
+        class CreateParams < Stripe::RequestParams
+          class Cancel < Stripe::RequestParams
+            # Unique identifier for the event. You can only cancel events within 24 hours of Stripe receiving them.
+            attr_accessor :identifier
+
+            def initialize(identifier: nil)
+              @identifier = identifier
+            end
+          end
+          # Specifies which event to cancel.
+          attr_accessor :cancel
+          # The name of the meter event. Corresponds with the `event_name` field on a meter.
+          attr_accessor :event_name
+          # Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet.
+          attr_accessor :type
+
+          def initialize(cancel: nil, event_name: nil, type: nil)
+            @cancel = cancel
+            @event_name = event_name
+            @type = type
+          end
+        end
+
+        # Creates a meter event adjustment to cancel a previously sent meter event.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/meter_event_adjustments",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventService < StripeService
+        class CreateParams < Stripe::RequestParams
+          # The name of the meter event. Corresponds with the `event_name` field on a meter.
+          attr_accessor :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_accessor :identifier
+          # 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](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+          attr_accessor :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_accessor :timestamp
+
+          def initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil)
+            @event_name = event_name
+            @identifier = identifier
+            @payload = payload
+            @timestamp = timestamp
+          end
+        end
+
+        # Creates a meter event. Events are validated synchronously, but are processed asynchronously. Supports up to 1,000 events per second in livemode. For higher rate-limits, please use meter event streams instead.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/meter_events",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/meter_event_session_service.rb

@@ -0,0 +1,24 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventSessionService < StripeService
+        class CreateParams < Stripe::RequestParams
+        end
+
+        # Creates a meter event session to send usage on the high-throughput meter event stream. Authentication tokens are only valid for 15 minutes, so you will need to create a new meter event session when your token expires.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/meter_event_session",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing/meter_event_stream_service.rb

@@ -0,0 +1,56 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventStreamService < StripeService
+        class CreateParams < Stripe::RequestParams
+          class Event < Stripe::RequestParams
+            # The name of the meter event. Corresponds with the `event_name` field on a meter.
+            attr_accessor :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_accessor :identifier
+            # 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](https://docs.stripe.com/billing/subscriptions/usage-based/recording-usage#payload-key-overrides).
+            attr_accessor :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_accessor :timestamp
+
+            def initialize(event_name: nil, identifier: nil, payload: nil, timestamp: nil)
+              @event_name = event_name
+              @identifier = identifier
+              @payload = payload
+              @timestamp = timestamp
+            end
+          end
+          # List of meter events to include in the request.
+          attr_accessor :events
+
+          def initialize(events: nil)
+            @events = events
+          end
+        end
+
+        # Creates meter events. Events are processed asynchronously, including validation. Requires a meter event session for authentication. Supports up to 10,000 requests per second in livemode. For even higher rate-limits, contact sales.
+        #
+        # ** raises TemporarySessionExpiredError
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/billing/meter_event_stream",
+            params: params,
+            opts: opts,
+            base_address: :meter_events
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/billing_service.rb

@@ -0,0 +1,18 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class BillingService < StripeService
+      attr_reader :meter_event_session, :meter_event_adjustments, :meter_event_stream, :meter_events
+
+      def initialize(requestor)
+        super(requestor)
+        @meter_event_session = Stripe::V2::Billing::MeterEventSessionService.new(@requestor)
+        @meter_event_adjustments = Stripe::V2::Billing::MeterEventAdjustmentService.new(@requestor)
+        @meter_event_stream = Stripe::V2::Billing::MeterEventStreamService.new(@requestor)
+        @meter_events = Stripe::V2::Billing::MeterEventService.new(@requestor)
+      end
+    end
+  end
+end