stripe 13.4.1 → 17.0.1

data/lib/stripe/params/treasury/transaction_entry_list_params.rb

@@ -0,0 +1,84 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionEntryListParams < 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
+  end
+end

data/lib/stripe/params/treasury/transaction_entry_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionEntryRetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/treasury/transaction_list_params.rb

@@ -0,0 +1,92 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionListParams < 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
+  end
+end

data/lib/stripe/params/treasury/transaction_retrieve_params.rb

@@ -0,0 +1,15 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module Treasury
+    class TransactionRetrieveParams < Stripe::RequestParams
+      # Specifies which fields in the response should be expanded.
+      attr_accessor :expand
+
+      def initialize(expand: nil)
+        @expand = expand
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/meter_event_adjustment_create_params.rb

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventAdjustmentCreateParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/billing/meter_event_create_params.rb

@@ -0,0 +1,33 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventCreateParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/billing/meter_event_session_create_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventSessionCreateParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/billing/meter_event_stream_create_params.rb

@@ -0,0 +1,41 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Billing
+      class MeterEventStreamCreateParams < 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. Supports up to 100 events per request.
+        attr_accessor :events
+
+        def initialize(events: nil)
+          @events = events
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_create_params.rb

@@ -0,0 +1,79 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationCreateParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_delete_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationDeleteParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_disable_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationDisableParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_enable_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationEnableParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_list_params.rb

@@ -0,0 +1,20 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationListParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_ping_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationPingParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_retrieve_params.rb

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationRetrieveParams < Stripe::RequestParams
+        # Additional fields to include in the response.
+        attr_accessor :include
+
+        def initialize(include: nil)
+          @include = include
+        end
+      end
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_destination_update_params.rb

@@ -0,0 +1,47 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventDestinationUpdateParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventListParams < 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
+    end
+  end
+end

data/lib/stripe/params/v2/core/event_retrieve_params.rb

@@ -0,0 +1,10 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  module V2
+    module Core
+      class EventRetrieveParams < Stripe::RequestParams; end
+    end
+  end
+end

data/lib/stripe/params/webhook_endpoint_create_params.rb

@@ -0,0 +1,39 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class WebhookEndpointCreateParams < 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
+end

data/lib/stripe/params/webhook_endpoint_delete_params.rb

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class WebhookEndpointDeleteParams < Stripe::RequestParams; end
+end

data/lib/stripe/params/webhook_endpoint_list_params.rb

@@ -0,0 +1,22 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class WebhookEndpointListParams < 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
+end

data/lib/stripe/params/webhook_endpoint_retrieve_params.rb

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+module Stripe
+  class WebhookEndpointRetrieveParams < Stripe::RequestParams
+    # Specifies which fields in the response should be expanded.
+    attr_accessor :expand
+
+    def initialize(expand: nil)
+      @expand = expand
+    end
+  end
+end