stripe 5.38.0 → 15.2.1

data/lib/stripe/services/v2/core/event_destination_service.rb

@@ -0,0 +1,235 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationService < StripeService
+        class CreateParams < Stripe::RequestParams
+          class AmazonEventbridge < Stripe::RequestParams
+            # The AWS account ID.
+            attr_accessor :aws_account_id
+            # The region of the AWS event source.
+            attr_accessor :aws_region
+
+            def initialize(aws_account_id: nil, aws_region: nil)
+              @aws_account_id = aws_account_id
+              @aws_region = aws_region
+            end
+          end
+
+          class WebhookEndpoint < Stripe::RequestParams
+            # The URL of the webhook endpoint.
+            attr_accessor :url
+
+            def initialize(url: nil)
+              @url = url
+            end
+          end
+          # An optional description of what the event destination is used for.
+          attr_accessor :description
+          # The list of events to enable for this endpoint.
+          attr_accessor :enabled_events
+          # Payload type of events being subscribed to.
+          attr_accessor :event_payload
+          # Where events should be routed from.
+          attr_accessor :events_from
+          # Additional fields to include in the response.
+          attr_accessor :include
+          # Metadata.
+          attr_accessor :metadata
+          # Event destination name.
+          attr_accessor :name
+          # If using the snapshot event payload, the API version events are rendered as.
+          attr_accessor :snapshot_api_version
+          # Event destination type.
+          attr_accessor :type
+          # Amazon EventBridge configuration.
+          attr_accessor :amazon_eventbridge
+          # Webhook endpoint configuration.
+          attr_accessor :webhook_endpoint
+
+          def initialize(
+            description: nil,
+            enabled_events: nil,
+            event_payload: nil,
+            events_from: nil,
+            include: nil,
+            metadata: nil,
+            name: nil,
+            snapshot_api_version: nil,
+            type: nil,
+            amazon_eventbridge: nil,
+            webhook_endpoint: nil
+          )
+            @description = description
+            @enabled_events = enabled_events
+            @event_payload = event_payload
+            @events_from = events_from
+            @include = include
+            @metadata = metadata
+            @name = name
+            @snapshot_api_version = snapshot_api_version
+            @type = type
+            @amazon_eventbridge = amazon_eventbridge
+            @webhook_endpoint = webhook_endpoint
+          end
+        end
+
+        class DeleteParams < Stripe::RequestParams; end
+        class DisableParams < Stripe::RequestParams; end
+        class EnableParams < Stripe::RequestParams; end
+
+        class ListParams < Stripe::RequestParams
+          # Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
+          attr_accessor :include
+          # The page size.
+          attr_accessor :limit
+
+          def initialize(include: nil, limit: nil)
+            @include = include
+            @limit = limit
+          end
+        end
+
+        class PingParams < Stripe::RequestParams; end
+
+        class RetrieveParams < Stripe::RequestParams
+          # Additional fields to include in the response.
+          attr_accessor :include
+
+          def initialize(include: nil)
+            @include = include
+          end
+        end
+
+        class UpdateParams < Stripe::RequestParams
+          class WebhookEndpoint < Stripe::RequestParams
+            # The URL of the webhook endpoint.
+            attr_accessor :url
+
+            def initialize(url: nil)
+              @url = url
+            end
+          end
+          # An optional description of what the event destination is used for.
+          attr_accessor :description
+          # The list of events to enable for this endpoint.
+          attr_accessor :enabled_events
+          # Additional fields to include in the response. Currently supports `webhook_endpoint.url`.
+          attr_accessor :include
+          # Metadata.
+          attr_accessor :metadata
+          # Event destination name.
+          attr_accessor :name
+          # Webhook endpoint configuration.
+          attr_accessor :webhook_endpoint
+
+          def initialize(
+            description: nil,
+            enabled_events: nil,
+            include: nil,
+            metadata: nil,
+            name: nil,
+            webhook_endpoint: nil
+          )
+            @description = description
+            @enabled_events = enabled_events
+            @include = include
+            @metadata = metadata
+            @name = name
+            @webhook_endpoint = webhook_endpoint
+          end
+        end
+
+        # Create a new event destination.
+        def create(params = {}, opts = {})
+          request(
+            method: :post,
+            path: "/v2/core/event_destinations",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Delete an event destination.
+        def delete(id, params = {}, opts = {})
+          request(
+            method: :delete,
+            path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Disable an event destination.
+        def disable(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/core/event_destinations/%<id>s/disable", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Enable an event destination.
+        def enable(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/core/event_destinations/%<id>s/enable", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Lists all event destinations.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/core/event_destinations",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Send a `ping` event to an event destination.
+        def ping(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/core/event_destinations/%<id>s/ping", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of an event destination.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Update the details of an event destination.
+        def update(id, params = {}, opts = {})
+          request(
+            method: :post,
+            path: format("/v2/core/event_destinations/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

data/lib/stripe/services/v2/core/event_service.rb

@@ -0,0 +1,48 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventService < StripeService
+        class ListParams < Stripe::RequestParams
+          # The page size.
+          attr_accessor :limit
+          # Primary object ID used to retrieve related events.
+          #
+          # To avoid conflict with Ruby's ':object_id', this attribute has been renamed. If using a hash parameter map instead, please use the original name ':object_id' with NO trailing underscore as the provided param key.
+          attr_accessor :object_id_
+
+          def initialize(limit: nil, object_id_: nil)
+            @limit = limit
+            @object_id_ = object_id_
+          end
+        end
+
+        class RetrieveParams < Stripe::RequestParams; end
+
+        # List events, going back up to 30 days.
+        def list(params = {}, opts = {})
+          request(
+            method: :get,
+            path: "/v2/core/events",
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+
+        # Retrieves the details of an event.
+        def retrieve(id, params = {}, opts = {})
+          request(
+            method: :get,
+            path: format("/v2/core/events/%<id>s", { id: CGI.escape(id) }),
+            params: params,
+            opts: opts,
+            base_address: :api
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    class CoreService < StripeService
+      attr_reader :event_destinations, :events
+
+      def initialize(requestor)
+        super
+        @event_destinations = Stripe::V2::Core::EventDestinationService.new(@requestor)
+        @events = Stripe::V2::Core::EventService.new(@requestor)
+      end
+    end
+  end
+end

data/lib/stripe/services/v2_services.rb

@@ -0,0 +1,14 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class V2Services < StripeService
+    attr_reader :billing, :core
+
+    def initialize(requestor)
+      super
+      @billing = Stripe::V2::BillingService.new(@requestor)
+      @core = Stripe::V2::CoreService.new(@requestor)
+    end
+  end
+end

data/lib/stripe/services/webhook_endpoint_service.rb

@@ -0,0 +1,156 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class WebhookEndpointService < StripeService
+    class DeleteParams < Stripe::RequestParams; 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 UpdateParams < Stripe::RequestParams
+      # An optional description of what the webhook is used for.
+      attr_accessor :description
+      # Disable the webhook endpoint if set to true.
+      attr_accessor :disabled
+      # The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
+      attr_accessor :enabled_events
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # The URL of the webhook endpoint.
+      attr_accessor :url
+
+      def initialize(
+        description: nil,
+        disabled: nil,
+        enabled_events: nil,
+        expand: nil,
+        metadata: nil,
+        url: nil
+      )
+        @description = description
+        @disabled = disabled
+        @enabled_events = enabled_events
+        @expand = expand
+        @metadata = metadata
+        @url = url
+      end
+    end
+
+    class ListParams < Stripe::RequestParams
+      # 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(ending_before: nil, expand: nil, limit: nil, starting_after: nil)
+        @ending_before = ending_before
+        @expand = expand
+        @limit = limit
+        @starting_after = starting_after
+      end
+    end
+
+    class CreateParams < Stripe::RequestParams
+      # Events sent to this endpoint will be generated with this Stripe Version instead of your account's default Stripe Version.
+      attr_accessor :api_version
+      # Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
+      attr_accessor :connect
+      # An optional description of what the webhook is used for.
+      attr_accessor :description
+      # The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.
+      attr_accessor :enabled_events
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+      # 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
+      attr_accessor :metadata
+      # The URL of the webhook endpoint.
+      attr_accessor :url
+
+      def initialize(
+        api_version: nil,
+        connect: nil,
+        description: nil,
+        enabled_events: nil,
+        expand: nil,
+        metadata: nil,
+        url: nil
+      )
+        @api_version = api_version
+        @connect = connect
+        @description = description
+        @enabled_events = enabled_events
+        @expand = expand
+        @metadata = metadata
+        @url = url
+      end
+    end
+
+    # 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 create(params = {}, opts = {})
+      request(
+        method: :post,
+        path: "/v1/webhook_endpoints",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
+    def delete(webhook_endpoint, params = {}, opts = {})
+      request(
+        method: :delete,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Returns a list of your webhook endpoints.
+    def list(params = {}, opts = {})
+      request(
+        method: :get,
+        path: "/v1/webhook_endpoints",
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves the webhook endpoint with the given ID.
+    def retrieve(webhook_endpoint, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
+    def update(webhook_endpoint, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end

data/lib/stripe/services.rb

@@ -0,0 +1,180 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+require "stripe/services/account_capability_service"
+require "stripe/services/account_external_account_service"
+require "stripe/services/account_link_service"
+require "stripe/services/account_login_link_service"
+require "stripe/services/account_person_service"
+require "stripe/services/account_service"
+require "stripe/services/account_session_service"
+require "stripe/services/apple_pay_domain_service"
+require "stripe/services/application_fee_refund_service"
+require "stripe/services/application_fee_service"
+require "stripe/services/apps/secret_service"
+require "stripe/services/apps_service"
+require "stripe/services/balance_service"
+require "stripe/services/balance_transaction_service"
+require "stripe/services/billing/alert_service"
+require "stripe/services/billing/credit_balance_summary_service"
+require "stripe/services/billing/credit_balance_transaction_service"
+require "stripe/services/billing/credit_grant_service"
+require "stripe/services/billing/meter_event_adjustment_service"
+require "stripe/services/billing/meter_event_service"
+require "stripe/services/billing/meter_event_summary_service"
+require "stripe/services/billing/meter_service"
+require "stripe/services/billing_portal/configuration_service"
+require "stripe/services/billing_portal/session_service"
+require "stripe/services/billing_portal_service"
+require "stripe/services/billing_service"
+require "stripe/services/charge_service"
+require "stripe/services/checkout/session_line_item_service"
+require "stripe/services/checkout/session_service"
+require "stripe/services/checkout_service"
+require "stripe/services/climate/order_service"
+require "stripe/services/climate/product_service"
+require "stripe/services/climate/supplier_service"
+require "stripe/services/climate_service"
+require "stripe/services/confirmation_token_service"
+require "stripe/services/country_spec_service"
+require "stripe/services/coupon_service"
+require "stripe/services/credit_note_line_item_service"
+require "stripe/services/credit_note_preview_lines_service"
+require "stripe/services/credit_note_service"
+require "stripe/services/customer_balance_transaction_service"
+require "stripe/services/customer_cash_balance_service"
+require "stripe/services/customer_cash_balance_transaction_service"
+require "stripe/services/customer_funding_instructions_service"
+require "stripe/services/customer_payment_method_service"
+require "stripe/services/customer_payment_source_service"
+require "stripe/services/customer_service"
+require "stripe/services/customer_session_service"
+require "stripe/services/customer_tax_id_service"
+require "stripe/services/dispute_service"
+require "stripe/services/entitlements/active_entitlement_service"
+require "stripe/services/entitlements/feature_service"
+require "stripe/services/entitlements_service"
+require "stripe/services/ephemeral_key_service"
+require "stripe/services/event_service"
+require "stripe/services/exchange_rate_service"
+require "stripe/services/file_link_service"
+require "stripe/services/file_service"
+require "stripe/services/financial_connections/account_owner_service"
+require "stripe/services/financial_connections/account_service"
+require "stripe/services/financial_connections/session_service"
+require "stripe/services/financial_connections/transaction_service"
+require "stripe/services/financial_connections_service"
+require "stripe/services/forwarding/request_service"
+require "stripe/services/forwarding_service"
+require "stripe/services/identity/verification_report_service"
+require "stripe/services/identity/verification_session_service"
+require "stripe/services/identity_service"
+require "stripe/services/invoice_item_service"
+require "stripe/services/invoice_line_item_service"
+require "stripe/services/invoice_payment_service"
+require "stripe/services/invoice_rendering_template_service"
+require "stripe/services/invoice_service"
+require "stripe/services/issuing/authorization_service"
+require "stripe/services/issuing/card_service"
+require "stripe/services/issuing/cardholder_service"
+require "stripe/services/issuing/dispute_service"
+require "stripe/services/issuing/personalization_design_service"
+require "stripe/services/issuing/physical_bundle_service"
+require "stripe/services/issuing/token_service"
+require "stripe/services/issuing/transaction_service"
+require "stripe/services/issuing_service"
+require "stripe/services/mandate_service"
+require "stripe/services/payment_intent_service"
+require "stripe/services/payment_link_line_item_service"
+require "stripe/services/payment_link_service"
+require "stripe/services/payment_method_configuration_service"
+require "stripe/services/payment_method_domain_service"
+require "stripe/services/payment_method_service"
+require "stripe/services/payout_service"
+require "stripe/services/plan_service"
+require "stripe/services/price_service"
+require "stripe/services/product_feature_service"
+require "stripe/services/product_service"
+require "stripe/services/promotion_code_service"
+require "stripe/services/quote_computed_upfront_line_items_service"
+require "stripe/services/quote_line_item_service"
+require "stripe/services/quote_service"
+require "stripe/services/radar/early_fraud_warning_service"
+require "stripe/services/radar/value_list_item_service"
+require "stripe/services/radar/value_list_service"
+require "stripe/services/radar_service"
+require "stripe/services/refund_service"
+require "stripe/services/reporting/report_run_service"
+require "stripe/services/reporting/report_type_service"
+require "stripe/services/reporting_service"
+require "stripe/services/review_service"
+require "stripe/services/setup_attempt_service"
+require "stripe/services/setup_intent_service"
+require "stripe/services/shipping_rate_service"
+require "stripe/services/sigma/scheduled_query_run_service"
+require "stripe/services/sigma_service"
+require "stripe/services/source_service"
+require "stripe/services/source_transaction_service"
+require "stripe/services/subscription_item_service"
+require "stripe/services/subscription_schedule_service"
+require "stripe/services/subscription_service"
+require "stripe/services/tax/calculation_line_item_service"
+require "stripe/services/tax/calculation_service"
+require "stripe/services/tax/registration_service"
+require "stripe/services/tax/settings_service"
+require "stripe/services/tax/transaction_line_item_service"
+require "stripe/services/tax/transaction_service"
+require "stripe/services/tax_code_service"
+require "stripe/services/tax_id_service"
+require "stripe/services/tax_rate_service"
+require "stripe/services/tax_service"
+require "stripe/services/terminal/configuration_service"
+require "stripe/services/terminal/connection_token_service"
+require "stripe/services/terminal/location_service"
+require "stripe/services/terminal/reader_service"
+require "stripe/services/terminal_service"
+require "stripe/services/test_helpers/confirmation_token_service"
+require "stripe/services/test_helpers/customer_service"
+require "stripe/services/test_helpers/issuing/authorization_service"
+require "stripe/services/test_helpers/issuing/card_service"
+require "stripe/services/test_helpers/issuing/personalization_design_service"
+require "stripe/services/test_helpers/issuing/transaction_service"
+require "stripe/services/test_helpers/issuing_service"
+require "stripe/services/test_helpers/refund_service"
+require "stripe/services/test_helpers/terminal/reader_service"
+require "stripe/services/test_helpers/terminal_service"
+require "stripe/services/test_helpers/test_clock_service"
+require "stripe/services/test_helpers/treasury/inbound_transfer_service"
+require "stripe/services/test_helpers/treasury/outbound_payment_service"
+require "stripe/services/test_helpers/treasury/outbound_transfer_service"
+require "stripe/services/test_helpers/treasury/received_credit_service"
+require "stripe/services/test_helpers/treasury/received_debit_service"
+require "stripe/services/test_helpers/treasury_service"
+require "stripe/services/test_helpers_service"
+require "stripe/services/token_service"
+require "stripe/services/topup_service"
+require "stripe/services/transfer_reversal_service"
+require "stripe/services/transfer_service"
+require "stripe/services/treasury/credit_reversal_service"
+require "stripe/services/treasury/debit_reversal_service"
+require "stripe/services/treasury/financial_account_features_service"
+require "stripe/services/treasury/financial_account_service"
+require "stripe/services/treasury/inbound_transfer_service"
+require "stripe/services/treasury/outbound_payment_service"
+require "stripe/services/treasury/outbound_transfer_service"
+require "stripe/services/treasury/received_credit_service"
+require "stripe/services/treasury/received_debit_service"
+require "stripe/services/treasury/transaction_entry_service"
+require "stripe/services/treasury/transaction_service"
+require "stripe/services/treasury_service"
+require "stripe/services/v1_services"
+require "stripe/services/v2/billing/meter_event_adjustment_service"
+require "stripe/services/v2/billing/meter_event_service"
+require "stripe/services/v2/billing/meter_event_session_service"
+require "stripe/services/v2/billing/meter_event_stream_service"
+require "stripe/services/v2/billing_service"
+require "stripe/services/v2/core/event_destination_service"
+require "stripe/services/v2/core/event_service"
+require "stripe/services/v2/core_service"
+require "stripe/services/v2_services"
+require "stripe/services/webhook_endpoint_service"

data/lib/stripe/singleton_api_resource.rb

@@ -10,15 +10,15 @@ module Stripe
       end
       # Namespaces are separated in object names with periods (.) and in URLs
       # with forward slashes (/), so replace the former with the latter.
-      "/v1/#{self::OBJECT_NAME.downcase.tr('.', '/')}"
+      "/v1/#{object_name.downcase.tr('.', '/')}"
     end
 
     def resource_url
       self.class.resource_url
     end
 
-    def self.retrieve(opts = {})
-      instance = new(nil, Util.normalize_opts(opts))
+    def self.retrieve(params = {}, opts = {})
+      instance = new(params, Util.normalize_opts(opts))
       instance.refresh
       instance
     end