stripe 15.2.0.pre.beta.1 → 15.2.0

data/rbi/stripe/services/product_service.rbi

@@ -0,0 +1,477 @@
+# File generated from our OpenAPI spec
+# frozen_string_literal: true
+
+# typed: true
+module Stripe
+  class ProductService < StripeService
+    attr_reader :features
+    class DeleteParams < Stripe::RequestParams; 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
+      class MarketingFeature < Stripe::RequestParams
+        # The marketing feature name. Up to 80 characters long.
+        sig { returns(String) }
+        attr_accessor :name
+        sig { params(name: String).void }
+        def initialize(name: nil); end
+      end
+      class PackageDimensions < Stripe::RequestParams
+        # Height, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :height
+        # Length, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :length
+        # Weight, in ounces. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :weight
+        # Width, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :width
+        sig { params(height: Float, length: Float, weight: Float, width: Float).void }
+        def initialize(height: nil, length: nil, weight: nil, width: nil); end
+      end
+      # Whether the product is available for purchase.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :active
+      # The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :default_price
+      # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+      sig { returns(T.nilable(T.nilable(String))) }
+      attr_accessor :description
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
+      sig { returns(T.nilable(T.nilable(T.any(String, T::Array[String])))) }
+      attr_accessor :images
+      # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
+      sig {
+        returns(T.nilable(T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature]))))
+       }
+      attr_accessor :marketing_features
+      # 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 product's name, meant to be displayable to the customer.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+      # The dimensions of this product for shipping purposes.
+      sig {
+        returns(T.nilable(T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions))))
+       }
+      attr_accessor :package_dimensions
+      # Whether this product is shipped (i.e., physical goods).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :shippable
+      # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
+      #
+      # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
+      #  It must contain at least one letter. May only be set if `type=service`. Only used for subscription payments.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :statement_descriptor
+      # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+      sig { returns(T.nilable(T.nilable(String))) }
+      attr_accessor :tax_code
+      # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.
+      sig { returns(T.nilable(T.nilable(String))) }
+      attr_accessor :unit_label
+      # A URL of a publicly-accessible webpage for this product.
+      sig { returns(T.nilable(T.nilable(String))) }
+      attr_accessor :url
+      sig {
+        params(active: T.nilable(T::Boolean), default_price: T.nilable(String), description: T.nilable(T.nilable(String)), expand: T.nilable(T::Array[String]), images: T.nilable(T.nilable(T.any(String, T::Array[String]))), marketing_features: T.nilable(T.nilable(T.any(String, T::Array[::Stripe::ProductService::UpdateParams::MarketingFeature]))), metadata: T.nilable(T.nilable(T.any(String, T::Hash[String, String]))), name: T.nilable(String), package_dimensions: T.nilable(T.nilable(T.any(String, ::Stripe::ProductService::UpdateParams::PackageDimensions))), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(T.nilable(String)), unit_label: T.nilable(T.nilable(String)), url: T.nilable(T.nilable(String))).void
+       }
+      def initialize(
+        active: nil,
+        default_price: nil,
+        description: nil,
+        expand: nil,
+        images: nil,
+        marketing_features: nil,
+        metadata: nil,
+        name: nil,
+        package_dimensions: nil,
+        shippable: nil,
+        statement_descriptor: nil,
+        tax_code: nil,
+        unit_label: nil,
+        url: nil
+      ); end
+    end
+    class ListParams < Stripe::RequestParams
+      class Created < Stripe::RequestParams
+        # Minimum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gt
+        # Minimum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :gte
+        # Maximum value to filter by (exclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lt
+        # Maximum value to filter by (inclusive)
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :lte
+        sig {
+          params(gt: T.nilable(Integer), gte: T.nilable(Integer), lt: T.nilable(Integer), lte: T.nilable(Integer)).void
+         }
+        def initialize(gt: nil, gte: nil, lt: nil, lte: nil); end
+      end
+      # Only return products that are active or inactive (e.g., pass `false` to list all inactive products).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :active
+      # Only return products that were created during the given date interval.
+      sig { returns(T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer))) }
+      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.
+      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
+      # Only return products with the given IDs. Cannot be used with [starting_after](https://stripe.com/docs/api#list_products-starting_after) or [ending_before](https://stripe.com/docs/api#list_products-ending_before).
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :ids
+      # 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
+      # Only return products that can be shipped (i.e., physical, not digital products).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :shippable
+      # 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
+      # Only return products of this type.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+      # Only return products with the given url.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+      sig {
+        params(active: T.nilable(T::Boolean), created: T.nilable(T.any(::Stripe::ProductService::ListParams::Created, Integer)), ending_before: T.nilable(String), expand: T.nilable(T::Array[String]), ids: T.nilable(T::Array[String]), limit: T.nilable(Integer), shippable: T.nilable(T::Boolean), starting_after: T.nilable(String), type: T.nilable(String), url: T.nilable(String)).void
+       }
+      def initialize(
+        active: nil,
+        created: nil,
+        ending_before: nil,
+        expand: nil,
+        ids: nil,
+        limit: nil,
+        shippable: nil,
+        starting_after: nil,
+        type: nil,
+        url: nil
+      ); end
+    end
+    class CreateParams < Stripe::RequestParams
+      class DefaultPriceData < Stripe::RequestParams
+        class CurrencyOptions < Stripe::RequestParams
+          class CustomUnitAmount < Stripe::RequestParams
+            # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
+            sig { returns(T::Boolean) }
+            attr_accessor :enabled
+            # The maximum unit amount the customer can specify for this item.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :maximum
+            # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :minimum
+            # The starting unit amount which can be updated by the customer.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :preset
+            sig {
+              params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
+             }
+            def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
+          end
+          class Tier < Stripe::RequestParams
+            # The flat billing amount for an entire tier, regardless of the number of units in the tier.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :flat_amount
+            # Same as `flat_amount`, but accepts a decimal value representing an integer in the minor units of the currency. Only one of `flat_amount` and `flat_amount_decimal` can be set.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :flat_amount_decimal
+            # The per unit billing amount for each individual unit for which this tier applies.
+            sig { returns(T.nilable(Integer)) }
+            attr_accessor :unit_amount
+            # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :unit_amount_decimal
+            # Specifies the upper bound of this tier. The lower bound of a tier is the upper bound of the previous tier adding one. Use `inf` to define a fallback tier.
+            sig { returns(T.any(String, Integer)) }
+            attr_accessor :up_to
+            sig {
+              params(flat_amount: T.nilable(Integer), flat_amount_decimal: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String), up_to: T.any(String, Integer)).void
+             }
+            def initialize(
+              flat_amount: nil,
+              flat_amount_decimal: nil,
+              unit_amount: nil,
+              unit_amount_decimal: nil,
+              up_to: nil
+            ); end
+          end
+          # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+          sig {
+            returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount))
+           }
+          attr_accessor :custom_unit_amount
+          # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :tax_behavior
+          # Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`.
+          sig {
+            returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier]))
+           }
+          attr_accessor :tiers
+          # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :unit_amount
+          # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :unit_amount_decimal
+          sig {
+            params(custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::CustomUnitAmount), tax_behavior: T.nilable(String), tiers: T.nilable(T::Array[::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions::Tier]), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
+           }
+          def initialize(
+            custom_unit_amount: nil,
+            tax_behavior: nil,
+            tiers: nil,
+            unit_amount: nil,
+            unit_amount_decimal: nil
+          ); end
+        end
+        class CustomUnitAmount < Stripe::RequestParams
+          # Pass in `true` to enable `custom_unit_amount`, otherwise omit `custom_unit_amount`.
+          sig { returns(T::Boolean) }
+          attr_accessor :enabled
+          # The maximum unit amount the customer can specify for this item.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :maximum
+          # The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :minimum
+          # The starting unit amount which can be updated by the customer.
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :preset
+          sig {
+            params(enabled: T::Boolean, maximum: T.nilable(Integer), minimum: T.nilable(Integer), preset: T.nilable(Integer)).void
+           }
+          def initialize(enabled: nil, maximum: nil, minimum: nil, preset: nil); end
+        end
+        class Recurring < Stripe::RequestParams
+          # Specifies billing frequency. Either `day`, `week`, `month` or `year`.
+          sig { returns(String) }
+          attr_accessor :interval
+          # The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of three years interval allowed (3 years, 36 months, or 156 weeks).
+          sig { returns(T.nilable(Integer)) }
+          attr_accessor :interval_count
+          sig { params(interval: String, interval_count: T.nilable(Integer)).void }
+          def initialize(interval: nil, interval_count: nil); end
+        end
+        # Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
+        sig { returns(String) }
+        attr_accessor :currency
+        # Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies).
+        sig {
+          returns(T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions]))
+         }
+        attr_accessor :currency_options
+        # When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links.
+        sig {
+          returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount))
+         }
+        attr_accessor :custom_unit_amount
+        # 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::Hash[String, String])) }
+        attr_accessor :metadata
+        # The recurring components of a price such as `interval` and `interval_count`.
+        sig {
+          returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring))
+         }
+        attr_accessor :recurring
+        # Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :tax_behavior
+        # A positive integer in cents (or local equivalent) (or 0 for a free price) representing how much to charge. One of `unit_amount`, `unit_amount_decimal`, or `custom_unit_amount` is required.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :unit_amount
+        # Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :unit_amount_decimal
+        sig {
+          params(currency: String, currency_options: T.nilable(T::Hash[String, ::Stripe::ProductService::CreateParams::DefaultPriceData::CurrencyOptions]), custom_unit_amount: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::CustomUnitAmount), metadata: T.nilable(T::Hash[String, String]), recurring: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData::Recurring), tax_behavior: T.nilable(String), unit_amount: T.nilable(Integer), unit_amount_decimal: T.nilable(String)).void
+         }
+        def initialize(
+          currency: nil,
+          currency_options: nil,
+          custom_unit_amount: nil,
+          metadata: nil,
+          recurring: nil,
+          tax_behavior: nil,
+          unit_amount: nil,
+          unit_amount_decimal: nil
+        ); end
+      end
+      class MarketingFeature < Stripe::RequestParams
+        # The marketing feature name. Up to 80 characters long.
+        sig { returns(String) }
+        attr_accessor :name
+        sig { params(name: String).void }
+        def initialize(name: nil); end
+      end
+      class PackageDimensions < Stripe::RequestParams
+        # Height, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :height
+        # Length, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :length
+        # Weight, in ounces. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :weight
+        # Width, in inches. Maximum precision is 2 decimal places.
+        sig { returns(Float) }
+        attr_accessor :width
+        sig { params(height: Float, length: Float, weight: Float, width: Float).void }
+        def initialize(height: nil, length: nil, weight: nil, width: nil); end
+      end
+      # Whether the product is currently available for purchase. Defaults to `true`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :active
+      # Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.
+      sig { returns(T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData)) }
+      attr_accessor :default_price_data
+      # The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+      # Specifies which fields in the response should be expanded.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :expand
+      # An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :id
+      # A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :images
+      # A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).
+      sig { returns(T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature])) }
+      attr_accessor :marketing_features
+      # 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::Hash[String, String])) }
+      attr_accessor :metadata
+      # The product's name, meant to be displayable to the customer.
+      sig { returns(String) }
+      attr_accessor :name
+      # The dimensions of this product for shipping purposes.
+      sig { returns(T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions)) }
+      attr_accessor :package_dimensions
+      # Whether this product is shipped (i.e., physical goods).
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :shippable
+      # An arbitrary string to be displayed on your customer's credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all.
+      #
+      # This may be up to 22 characters. The statement description may not include `<`, `>`, `\`, `"`, `'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped.
+      #  It must contain at least one letter. Only used for subscription payments.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :statement_descriptor
+      # A [tax code](https://stripe.com/docs/tax/tax-categories) ID.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :tax_code
+      # The type of the product. Defaults to `service` if not explicitly specified, enabling use of this product with Subscriptions and Plans. Set this parameter to `good` to use this product with Orders and SKUs. On API versions before `2018-02-05`, this field defaults to `good` for compatibility reasons.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :type
+      # A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :unit_label
+      # A URL of a publicly-accessible webpage for this product.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+      sig {
+        params(active: T.nilable(T::Boolean), default_price_data: T.nilable(::Stripe::ProductService::CreateParams::DefaultPriceData), description: T.nilable(String), expand: T.nilable(T::Array[String]), id: T.nilable(String), images: T.nilable(T::Array[String]), marketing_features: T.nilable(T::Array[::Stripe::ProductService::CreateParams::MarketingFeature]), metadata: T.nilable(T::Hash[String, String]), name: String, package_dimensions: T.nilable(::Stripe::ProductService::CreateParams::PackageDimensions), shippable: T.nilable(T::Boolean), statement_descriptor: T.nilable(String), tax_code: T.nilable(String), type: T.nilable(String), unit_label: T.nilable(String), url: T.nilable(String)).void
+       }
+      def initialize(
+        active: nil,
+        default_price_data: nil,
+        description: nil,
+        expand: nil,
+        id: nil,
+        images: nil,
+        marketing_features: nil,
+        metadata: nil,
+        name: nil,
+        package_dimensions: nil,
+        shippable: nil,
+        statement_descriptor: nil,
+        tax_code: nil,
+        type: nil,
+        unit_label: nil,
+        url: nil
+      ); end
+    end
+    class SearchParams < Stripe::RequestParams
+      # 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 pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :page
+      # The search query string. See [search query language](https://stripe.com/docs/search#search-query-language) and the list of supported [query fields for products](https://stripe.com/docs/search#query-fields-for-products).
+      sig { returns(String) }
+      attr_accessor :query
+      sig {
+        params(expand: T.nilable(T::Array[String]), limit: T.nilable(Integer), page: T.nilable(String), query: String).void
+       }
+      def initialize(expand: nil, limit: nil, page: nil, query: nil); end
+    end
+    # Creates a new product object.
+    sig {
+      params(params: T.any(::Stripe::ProductService::CreateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
+     }
+    def create(params = {}, opts = {}); end
+
+    # Delete a product. Deleting a product is only possible if it has no prices associated with it. Additionally, deleting a product with type=good is only possible if it has no SKUs associated with it.
+    sig {
+      params(id: String, params: T.any(::Stripe::ProductService::DeleteParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
+     }
+    def delete(id, params = {}, opts = {}); end
+
+    # Returns a list of your products. The products are returned sorted by creation date, with the most recently created products appearing first.
+    sig {
+      params(params: T.any(::Stripe::ProductService::ListParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::ListObject)
+     }
+    def list(params = {}, opts = {}); end
+
+    # Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.
+    sig {
+      params(id: String, params: T.any(::Stripe::ProductService::RetrieveParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
+     }
+    def retrieve(id, params = {}, opts = {}); end
+
+    # Search for products you've previously created using Stripe's [Search Query Language](https://docs.stripe.com/docs/search#search-query-language).
+    # Don't use search in read-after-write flows where strict consistency is necessary. Under normal operating
+    # conditions, data is searchable in less than a minute. Occasionally, propagation of new or updated data can be up
+    # to an hour behind during outages. Search functionality is not available to merchants in India.
+    sig {
+      params(params: T.any(::Stripe::ProductService::SearchParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::SearchResultObject)
+     }
+    def search(params = {}, opts = {}); end
+
+    # Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
+    sig {
+      params(id: String, params: T.any(::Stripe::ProductService::UpdateParams, T::Hash[T.untyped, T.untyped]), opts: T.untyped).returns(Stripe::Product)
+     }
+    def update(id, params = {}, opts = {}); end
+  end
+end