stripe 15.4.0.pre.beta.1 → 15.4.0

data/rbi/stripe/resources/v2/event_destination.rbi

@@ -0,0 +1,91 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  module V2
+    # Set up an event destination to receive events from Stripe across multiple destination types, including [webhook endpoints](https://docs.stripe.com/webhooks) and [Amazon EventBridge](https://docs.stripe.com/event-destinations/eventbridge). Event destinations support receiving [thin events](https://docs.stripe.com/api/v2/events) and [snapshot events](https://docs.stripe.com/api/events).
+    class EventDestination < APIResource
+      class StatusDetails < Stripe::StripeObject
+        class Disabled < Stripe::StripeObject
+          # Reason event destination has been disabled.
+          sig { returns(String) }
+          attr_reader :reason
+        end
+        # Details about why the event destination has been disabled.
+        sig { returns(T.nilable(Disabled)) }
+        attr_reader :disabled
+      end
+      class AmazonEventbridge < Stripe::StripeObject
+        # The AWS account ID.
+        sig { returns(String) }
+        attr_reader :aws_account_id
+        # The ARN of the AWS event source.
+        sig { returns(String) }
+        attr_reader :aws_event_source_arn
+        # The state of the AWS event source.
+        sig { returns(String) }
+        attr_reader :aws_event_source_status
+      end
+      class WebhookEndpoint < Stripe::StripeObject
+        # The signing secret of the webhook endpoint, only includable on creation.
+        sig { returns(T.nilable(String)) }
+        attr_reader :signing_secret
+        # The URL of the webhook endpoint, includable.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+      end
+      # Time at which the object was created.
+      sig { returns(String) }
+      attr_reader :created
+      # An optional description of what the event destination is used for.
+      sig { returns(String) }
+      attr_reader :description
+      # The list of events to enable for this endpoint.
+      sig { returns(T::Array[String]) }
+      attr_reader :enabled_events
+      # Payload type of events being subscribed to.
+      sig { returns(String) }
+      attr_reader :event_payload
+      # Where events should be routed from.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :events_from
+      # Unique identifier for the object.
+      sig { returns(String) }
+      attr_reader :id
+      # Metadata.
+      sig { returns(T.nilable(T::Hash[String, String])) }
+      attr_reader :metadata
+      # Event destination name.
+      sig { returns(String) }
+      attr_reader :name
+      # String representing the object's type. Objects of the same type share the same value of the object field.
+      sig { returns(String) }
+      attr_reader :object
+      # If using the snapshot event payload, the API version events are rendered as.
+      sig { returns(T.nilable(String)) }
+      attr_reader :snapshot_api_version
+      # Status. It can be set to either enabled or disabled.
+      sig { returns(String) }
+      attr_reader :status
+      # Additional information about event destination status.
+      sig { returns(T.nilable(StatusDetails)) }
+      attr_reader :status_details
+      # Event destination type.
+      sig { returns(String) }
+      attr_reader :type
+      # Time at which the object was last updated.
+      sig { returns(String) }
+      attr_reader :updated
+      # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+      sig { returns(T::Boolean) }
+      attr_reader :livemode
+      # Amazon EventBridge configuration.
+      sig { returns(T.nilable(AmazonEventbridge)) }
+      attr_reader :amazon_eventbridge
+      # Webhook endpoint configuration.
+      sig { returns(T.nilable(WebhookEndpoint)) }
+      attr_reader :webhook_endpoint
+    end
+  end
+end

data/rbi/stripe/resources/webhook_endpoint.rbi

@@ -0,0 +1,168 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  # You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be
+  # notified about events that happen in your Stripe account or connected
+  # accounts.
+  #
+  # Most users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.
+  #
+  # Related guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)
+  class WebhookEndpoint < APIResource
+    # The API version events are rendered as for this webhook endpoint.
+    sig { returns(T.nilable(String)) }
+    attr_reader :api_version
+    # The ID of the associated Connect application.
+    sig { returns(T.nilable(String)) }
+    attr_reader :application
+    # Time at which the object was created. Measured in seconds since the Unix epoch.
+    sig { returns(Integer) }
+    attr_reader :created
+    # An optional description of what the webhook is used for.
+    sig { returns(T.nilable(String)) }
+    attr_reader :description
+    # The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection.
+    sig { returns(T::Array[String]) }
+    attr_reader :enabled_events
+    # Unique identifier for the object.
+    sig { returns(String) }
+    attr_reader :id
+    # Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
+    sig { returns(T::Boolean) }
+    attr_reader :livemode
+    # 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.
+    sig { returns(T::Hash[String, String]) }
+    attr_reader :metadata
+    # String representing the object's type. Objects of the same type share the same value.
+    sig { returns(String) }
+    attr_reader :object
+    # The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation.
+    sig { returns(String) }
+    attr_reader :secret
+    # The status of the webhook. It can be `enabled` or `disabled`.
+    sig { returns(String) }
+    attr_reader :status
+    # The URL of the webhook endpoint.
+    sig { returns(String) }
+    attr_reader :url
+    # Always true for a deleted object
+    sig { returns(T::Boolean) }
+    attr_reader :deleted
+    class DeleteParams < Stripe::RequestParams; end
+    class UpdateParams < Stripe::RequestParams
+      # An optional description of what the webhook is used for.
+      sig { returns(T.nilable(T.nilable(String))) }
+      attr_accessor :description
+      # Disable the webhook endpoint if set to true.
+      sig { returns(T.nilable(T::Boolean)) }
+      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.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :enabled_events
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      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`.
+      sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
+      attr_accessor :metadata
+      # The URL of the webhook endpoint.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+      sig {
+        params(description: T.nilable(T.nilable(String)), disabled: T.nilable(T::Boolean), enabled_events: T.nilable(T::Array[String]), expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), url: T.nilable(String)).void
+       }
+      def initialize(
+        description: nil,
+        disabled: nil,
+        enabled_events: nil,
+        expand: nil,
+        metadata: nil,
+        url: nil
+      ); 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ending_before
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :limit
+      # A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :starting_after
+      sig {
+        params(ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), starting_after: T.nilable(String)).void
+       }
+      def initialize(ending_before: nil, expand: nil, limit: nil, starting_after: nil); 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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :api_version
+      # Whether this endpoint should receive events from connected accounts (`true`), or from your account (`false`). Defaults to `false`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :connect
+      # An optional description of what the webhook is used for.
+      sig { returns(T.nilable(T.nilable(String))) }
+      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.
+      sig { returns(T::Array[String]) }
+      attr_accessor :enabled_events
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      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`.
+      sig { returns(T.nilable(T.nilable(T.any(String, T::Hash[String, String])))) }
+      attr_accessor :metadata
+      # The URL of the webhook endpoint.
+      sig { returns(String) }
+      attr_accessor :url
+      sig {
+        params(api_version: T.nilable(String), connect: T.nilable(T::Boolean), description: T.nilable(T.nilable(String)), enabled_events: T::Array[String], expand: T.nilable(T::Array[String]), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), url: String).void
+       }
+      def initialize(
+        api_version: nil,
+        connect: nil,
+        description: nil,
+        enabled_events: nil,
+        expand: nil,
+        metadata: nil,
+        url: nil
+      ); 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.
+    sig {
+      params(params: T.any(::Stripe::WebhookEndpoint::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
+     }
+    def self.create(params = {}, opts = {}); end
+
+    # You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
+    sig {
+      params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpoint::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
+     }
+    def self.delete(webhook_endpoint, params = {}, opts = {}); end
+
+    # You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
+    sig {
+      params(params: T.any(::Stripe::WebhookEndpoint::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
+     }
+    def delete(params = {}, opts = {}); end
+
+    # Returns a list of your webhook endpoints.
+    sig {
+      params(params: T.any(::Stripe::WebhookEndpoint::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def self.list(params = {}, opts = {}); end
+
+    # Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
+    sig {
+      params(webhook_endpoint: String, params: T.any(::Stripe::WebhookEndpoint::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::WebhookEndpoint)
+     }
+    def self.update(webhook_endpoint, params = {}, opts = {}); end
+  end
+end

data/rbi/stripe/services/account_capability_service.rbi

@@ -0,0 +1,51 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class AccountCapabilityService < StripeService
+    class ListParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      sig { params(expand: T.nilable(T::Array[String])).void }
+      def initialize(expand: nil); end
+    end
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      sig { params(expand: T.nilable(T::Array[String])).void }
+      def initialize(expand: nil); end
+    end
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.
+      #
+      # If a capability isn't permanent, you can remove it from the account by passing false. Some capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :requested
+      sig { params(expand: T.nilable(T::Array[String]), requested: T.nilable(T::Boolean)).void }
+      def initialize(expand: nil, requested: nil); end
+    end
+    # Returns a list of capabilities associated with the account. The capabilities are returned sorted by creation date, with the most recent capability appearing first.
+    sig {
+      params(account: String, params: T.any(::Stripe::AccountCapabilityService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def list(account, params = {}, opts = {}); end
+
+    # Retrieves information about the specified Account Capability.
+    sig {
+      params(account: String, capability: String, params: T.any(::Stripe::AccountCapabilityService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capability)
+     }
+    def retrieve(account, capability, params = {}, opts = {}); end
+
+    # Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
+    sig {
+      params(account: String, capability: String, params: T.any(::Stripe::AccountCapabilityService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Capability)
+     }
+    def update(account, capability, params = {}, opts = {}); end
+  end
+end