stripe 5.38.0 → 15.2.1

data/lib/stripe/resources/webhook_endpoint.rb

@@ -2,6 +2,13 @@
 # frozen_string_literal: 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
     extend Stripe::APIOperations::Create
     include Stripe::APIOperations::Delete
@@ -9,5 +16,165 @@ module Stripe
     include Stripe::APIOperations::Save
 
     OBJECT_NAME = "webhook_endpoint"
+    def self.object_name
+      "webhook_endpoint"
+    end
+
+    class DeleteParams < Stripe::RequestParams; 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
+    # 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(
+        method: :post,
+        path: "/v1/webhook_endpoints",
+        params: params,
+        opts: opts
+      )
+    end
+
+    # You can also delete webhook endpoints via the [webhook endpoint management](https://dashboard.stripe.com/account/webhooks) page of the Stripe dashboard.
+    def self.delete(webhook_endpoint, params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
+        params: params,
+        opts: opts
+      )
+    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(params = {}, opts = {})
+      request_stripe_object(
+        method: :delete,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(self["id"]) }),
+        params: params,
+        opts: opts
+      )
+    end
+
+    # Returns a list of your webhook endpoints.
+    def self.list(params = {}, opts = {})
+      request_stripe_object(method: :get, path: "/v1/webhook_endpoints", params: params, opts: opts)
+    end
+
+    # Updates the webhook endpoint. You may edit the url, the list of enabled_events, and the status of your endpoint.
+    def self.update(webhook_endpoint, params = {}, opts = {})
+      request_stripe_object(
+        method: :post,
+        path: format("/v1/webhook_endpoints/%<webhook_endpoint>s", { webhook_endpoint: CGI.escape(webhook_endpoint) }),
+        params: params,
+        opts: opts
+      )
+    end
   end
 end

data/lib/stripe/resources.rb

@@ -3,88 +3,146 @@
 
 require "stripe/resources/account"
 require "stripe/resources/account_link"
-require "stripe/resources/alipay_account"
+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"
 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_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/bitcoin_receiver"
-require "stripe/resources/bitcoin_transaction"
 require "stripe/resources/capability"
 require "stripe/resources/card"
+require "stripe/resources/cash_balance"
 require "stripe/resources/charge"
 require "stripe/resources/checkout/session"
+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"
 require "stripe/resources/credit_note_line_item"
 require "stripe/resources/customer"
 require "stripe/resources/customer_balance_transaction"
+require "stripe/resources/customer_cash_balance_transaction"
+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"
 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_owner"
+require "stripe/resources/financial_connections/account_ownership"
+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/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/card_details"
 require "stripe/resources/issuing/cardholder"
 require "stripe/resources/issuing/dispute"
+require "stripe/resources/issuing/personalization_design"
+require "stripe/resources/issuing/physical_bundle"
+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/order"
-require "stripe/resources/order_return"
 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/payout"
 require "stripe/resources/person"
 require "stripe/resources/plan"
 require "stripe/resources/price"
 require "stripe/resources/product"
+require "stripe/resources/product_feature"
 require "stripe/resources/promotion_code"
 require "stripe/resources/quote"
 require "stripe/resources/radar/early_fraud_warning"
 require "stripe/resources/radar/value_list"
 require "stripe/resources/radar/value_list_item"
-require "stripe/resources/recipient"
-require "stripe/resources/recipient_transfer"
 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"
 require "stripe/resources/setup_intent"
+require "stripe/resources/shipping_rate"
 require "stripe/resources/sigma/scheduled_query_run"
-require "stripe/resources/sku"
 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/calculation"
+require "stripe/resources/tax/calculation_line_item"
+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/three_d_secure"
+require "stripe/resources/test_helpers/test_clock"
 require "stripe/resources/token"
 require "stripe/resources/topup"
 require "stripe/resources/transfer"
-require "stripe/resources/usage_record"
-require "stripe/resources/usage_record_summary"
+require "stripe/resources/treasury/credit_reversal"
+require "stripe/resources/treasury/debit_reversal"
+require "stripe/resources/treasury/financial_account"
+require "stripe/resources/treasury/financial_account_features"
+require "stripe/resources/treasury/inbound_transfer"
+require "stripe/resources/treasury/outbound_payment"
+require "stripe/resources/treasury/outbound_transfer"
+require "stripe/resources/treasury/received_credit"
+require "stripe/resources/treasury/received_debit"
+require "stripe/resources/treasury/transaction"
+require "stripe/resources/treasury/transaction_entry"
+require "stripe/resources/v2/billing/meter_event"
+require "stripe/resources/v2/billing/meter_event_adjustment"
+require "stripe/resources/v2/billing/meter_event_session"
+require "stripe/resources/v2/event"
+require "stripe/resources/v2/event_destination"
 require "stripe/resources/webhook_endpoint"
+require "stripe/events/v1_billing_meter_error_report_triggered_event"
+require "stripe/events/v1_billing_meter_no_meter_found_event"
+require "stripe/events/v2_core_event_destination_ping_event"

data/lib/stripe/search_result_object.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module Stripe
+  class SearchResultObject < StripeObject
+    include Enumerable
+    include Stripe::APIOperations::Search
+    include Stripe::APIOperations::Request
+
+    OBJECT_NAME = "search_result"
+    def self.object_name
+      "search_result"
+    end
+
+    # This accessor allows a `SearchResultObject` to inherit various filters
+    # that were given to a predecessor. This allows for things like consistent
+    # limits, expansions, and predicates as a user pages through resources.
+    attr_accessor :filters
+
+    # An empty search result object. This is returned from +next+ when we know
+    # that there isn't a next page in order to replicate the behavior of the API
+    # when it attempts to return a page beyond the last.
+    def self.empty_search_result(opts = {})
+      SearchResultObject.construct_from({ data: [] }, opts, :v1)
+    end
+
+    def initialize(*args)
+      super
+      self.filters = {}
+    end
+
+    def [](key)
+      case key
+      when String, Symbol
+        super
+      else
+        raise ArgumentError,
+              "You tried to access the #{key.inspect} index, but " \
+              "SearchResultObject types only support String keys. " \
+              "(HINT: Search calls return an object with a 'data' (which is " \
+              "the data array). You likely want to call #data[#{key.inspect}])"
+      end
+    end
+
+    # Iterates through each resource in the page represented by the current
+    # `SearchListObject`.
+    #
+    # Note that this method makes no effort to fetch a new page when it gets to
+    # the end of the current page's resources. See also +auto_paging_each+.
+    def each(&blk)
+      data.each(&blk)
+    end
+
+    # Returns true if the page object contains no elements.
+    def empty?
+      data.empty?
+    end
+
+    # Iterates through each resource in all pages, making additional fetches to
+    # the API as necessary.
+    #
+    # Note that this method will make as many API calls as necessary to fetch
+    # all resources. For more granular control, please see +each+ and
+    # +next_search_result_page+.
+    def auto_paging_each(&blk)
+      return enum_for(:auto_paging_each) unless block_given?
+
+      page = self
+
+      loop do
+        page.each(&blk)
+        page = page.next_search_result_page
+
+        break if page.empty?
+      end
+    end
+
+    # Fetches the next page in the resource list (if there is one).
+    #
+    # This method will try to respect the limit of the current page. If none
+    # was given, the default limit will be fetched again.
+    def next_search_result_page(params = {}, opts = {})
+      return self.class.empty_search_result(opts) unless has_more
+
+      params = filters.merge(page: next_page).merge(params)
+
+      request_stripe_object(method: :get, path: url, params: params, opts: opts)
+    end
+  end
+end

data/lib/stripe/services/account_capability_service.rb

@@ -0,0 +1,71 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class AccountCapabilityService < StripeService
+    class ListParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class RetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+
+    class UpdateParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      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.
+      attr_accessor :requested
+
+      def initialize(expand: nil, requested: nil)
+        @expand = expand
+        @requested = requested
+      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.
+    def list(account, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/capabilities", { account: CGI.escape(account) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Retrieves information about the specified Account Capability.
+    def retrieve(account, capability, params = {}, opts = {})
+      request(
+        method: :get,
+        path: format("/v1/accounts/%<account>s/capabilities/%<capability>s", { account: CGI.escape(account), capability: CGI.escape(capability) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+
+    # Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
+    def update(account, capability, params = {}, opts = {})
+      request(
+        method: :post,
+        path: format("/v1/accounts/%<account>s/capabilities/%<capability>s", { account: CGI.escape(account), capability: CGI.escape(capability) }),
+        params: params,
+        opts: opts,
+        base_address: :api
+      )
+    end
+  end
+end