metronome-sdk 0.3.0 → 2.0.0

data/rbi/metronome_sdk/resources/v1/usage.rbi

@@ -4,8 +4,39 @@ module MetronomeSDK
   module Resources
     class V1
       class Usage
-        # Fetch aggregated usage data for multiple customers and billable-metrics, broken
-        # into intervals of the specified length.
+        # Retrieve aggregated usage data across multiple customers and billable metrics in
+        # a single query. This batch endpoint enables you to fetch usage patterns at
+        # scale, broken down by time windows, making it ideal for building analytics
+        # dashboards, generating reports, and monitoring platform-wide usage trends.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Generate platform-wide usage reports for internal teams
+        # - Monitor aggregate usage trends across your entire customer base
+        # - Create comparative usage analyses between customers or time periods
+        # - Support capacity planning with historical usage patterns
+        #
+        # ### Key response fields:
+        #
+        # An array of `UsageBatchAggregate` objects containing:
+        #
+        # - `customer_id`: The customer this usage belongs to
+        # - `billable_metric_id` and `billable_metric_name`: What was measured
+        # - `start_timestamp` and `end_timestamp`: Time window for this data point
+        # - `value`: Aggregated usage amount for the period
+        # - `groups` (optional): Usage broken down by group keys with values
+        # - `next_page`: Pagination cursor for large result sets
+        #
+        # ### Usage guidelines:
+        #
+        # - Time windows: Set `window_size` to `hour`, `day`, or `none` (entire period)
+        # - Required parameters: Must specify `starting_on`, `ending_before`, and
+        #   `window_size`
+        # - Filtering options:
+        #   - `customer_ids`: Limit to specific customers (omit for all customers)
+        #   - `billable_metrics`: Limit to specific metrics (omit for all metrics)
+        # - Pagination: Use `next_page` cursor to retrieve large datasets
+        # - Null values: Group values may be null when no usage matches that group
         sig do
           params(
             ending_before: Time,
@@ -19,7 +50,11 @@ module MetronomeSDK
               ],
             customer_ids: T::Array[String],
             request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(MetronomeSDK::Models::V1::UsageListResponse)
+          ).returns(
+            MetronomeSDK::Internal::CursorPageWithoutLimit[
+              MetronomeSDK::Models::V1::UsageListResponse
+            ]
+          )
         end
         def list(
           # Body param:
@@ -43,11 +78,92 @@ module MetronomeSDK
         )
         end
 
-        # Send usage events to Metronome. The body of this request is expected to be a
-        # JSON array of between 1 and 100 usage events. Compressed request bodies are
-        # supported with a `Content-Encoding: gzip` header. See
-        # [Getting usage into Metronome](https://docs.metronome.com/connect-metronome/) to
+        # The ingest endpoint is the primary method for sending usage events to Metronome,
+        # serving as the foundation for all billing calculations in your usage-based
+        # pricing model. This high-throughput endpoint is designed for real-time streaming
+        # ingestion, supports backdating 34 days, and is built to handle mission-critical
+        # usage data with enterprise-grade reliability. Metronome supports 100,000 events
+        # per second without requiring pre-aggregation or rollups and can scale up from
+        # there. See the [Send usage events](/guides/events/send-usage-events) guide to
         # learn more about usage events.
+        #
+        # ### Use this endpoint to:
+        #
+        # Create a customer usage pipeline into Metronome that drives billable metrics,
+        # credit drawdown, and invoicing. Track customer behavior, resource consumption,
+        # and feature usage
+        #
+        # ### What happens when you send events:
+        #
+        # - Events are validated and processed in real-time
+        # - Events are matched to customers using customer IDs or customer ingest aliases
+        # - Events are matched to billable metrics and are immediately available for usage
+        #   and spend calculations
+        #
+        # ### Usage guidelines:
+        #
+        # - Historical events can be backdated up to 34 days and will immediately impact
+        #   live customer spend
+        # - Duplicate events are automatically detected and ignored (34-day deduplication
+        #   window)
+        #
+        # #### Event structure:
+        #
+        # Usage events are simple JSON objects designed for flexibility and ease of
+        # integration:
+        #
+        # ```json
+        # {
+        #   "transaction_id": "2021-01-01T00:00:00Z_cluster42",
+        #   "customer_id": "team@example.com",
+        #   "event_type": "api_request",
+        #   "timestamp": "2021-01-01T00:00:00Z",
+        #   "properties": {
+        #     "endpoint": "/v1/users",
+        #     "method": "POST",
+        #     "response_time_ms": 45,
+        #     "region": "us-west-2"
+        #   }
+        # }
+        # ```
+        #
+        # Learn more about
+        # [usage event structure definitions](/guides/events/design-usage-events).
+        #
+        # #### Transaction ID
+        #
+        # The transaction_id serves as your idempotency key, ensuring events are processed
+        # exactly once. Metronome maintains a 34-day deduplication window - significantly
+        # longer than typical 12-hour windows - enabling robust backfill scenarios without
+        # duplicate billing.
+        #
+        # - Best Practices:
+        #   - Use UUIDs for one-time events: uuid4()
+        #   - For heartbeat events, use deterministic IDs
+        #   - Include enough context to avoid collisions across different event sources
+        #
+        # #### Customer ID
+        #
+        # Identifies which customer should be billed for this usage. Supports two
+        # identification methods:
+        #
+        # - Metronome Customer ID: The UUID returned when creating a customer
+        # - Ingest Alias: Your system's identifier (email, account number, etc.)
+        #
+        # Ingest aliases enable seamless integration without requiring ID mapping, and
+        # customers can have multiple aliases for flexibility.
+        #
+        # #### Event Type:
+        #
+        # Categorizes the event type for billable metric matching. Choose descriptive
+        # names that aligns with the product surface area.
+        #
+        # #### Properties:
+        #
+        # Flexible metadata also used to match billable metrics or to be used to serve as
+        # group keys to create multiple pricing dimensions or breakdown costs by novel
+        # properties for end customers or internal finance teams measuring underlying
+        # COGs.
         sig do
           params(
             usage: T::Array[MetronomeSDK::V1::UsageIngestParams::Usage::OrHash],
@@ -57,8 +173,40 @@ module MetronomeSDK
         def ingest(usage: nil, request_options: {})
         end
 
-        # Fetch aggregated usage data for the specified customer, billable-metric, and
-        # optional group, broken into intervals of the specified length.
+        # Retrieve granular usage data for a specific customer and billable metric, with
+        # the ability to break down usage by custom grouping dimensions. This endpoint
+        # enables deep usage analytics by segmenting data across attributes like region,
+        # user, model type, or any custom dimension defined in your billable metrics.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Analyze usage patterns broken down by specific attributes (region, user,
+        #   department, etc.)
+        # - Build detailed usage dashboards with dimensional filtering
+        # - Identify high-usage segments for optimization opportunities
+        #
+        # ### Key response fields:
+        #
+        # An array of `PagedUsageAggregate` objects containing:
+        #
+        # - `starting_on` and `ending_before`: Time window boundaries
+        # - `group_key`: The dimension being grouped by (e.g., "region")
+        # - `group_value`: The specific value for this group (e.g., "US-East")
+        # - `value`: Aggregated usage for this group and time window
+        # - `next_page`: Pagination cursor for large datasets
+        #
+        # ### Usage guidelines:
+        #
+        # - Required parameters: Must specify `customer_id`, `billable_metric_id`, and
+        #   `window_size`
+        # - Time windows: Set `window_size` to hour, day, or none for different
+        #   granularities
+        # - Group filtering: Use `group_by` to specify:
+        #   - key: The dimension to group by (must be set on the billable metric as a
+        #     group key)
+        #   - values: Optional array to filter to specific values only
+        # - Pagination: Use limit and `next_page` for large result sets
+        # - Null handling: `group_value` may be null for unmatched data
         sig do
           params(
             billable_metric_id: String,
@@ -107,10 +255,40 @@ module MetronomeSDK
         )
         end
 
-        # For a set of events, look up matched billable metrics and customers by
-        # transaction id. This endpoint looks at transactions that occurred in the last 34
-        # days, and is intended for sampling-based testing workflows. It is heavily rate
-        # limited.
+        # This endpoint retrieves events by transaction ID for events that occurred within
+        # the last 34 days. It is specifically designed for sampling-based testing
+        # workflows to detect revenue leakage. The Event Search API provides a critical
+        # observability tool that validates the integrity of your usage pipeline by
+        # allowing you to sample raw events and verify their matching against active
+        # billable metrics.
+        #
+        # Why event observability matters for revenue leakage: Silent revenue loss occurs
+        # when events are dropped, delayed, or fail to match billable metrics due to:
+        #
+        # - Upstream system failures
+        # - Event format changes
+        # - Misconfigured billable metrics
+        #
+        # ### Use this endpoint to:
+        #
+        # - Sample raw events and validate they match the expected billable metrics
+        # - Build custom leakage detection alerts to prevent silent revenue loss
+        # - Verify event processing accuracy during system changes or metric updates
+        # - Debug event matching issues in real-time
+        #
+        # ### Key response fields:
+        #
+        # - Complete event details including transaction ID, customer ID, and properties
+        # - Matched Metronome customer (if any)
+        # - Matched billable metric information (if any)
+        # - Processing status and duplicate detection flags
+        #
+        # ### Usage guidelines:
+        #
+        # ⚠️ Important: This endpoint is heavily rate limited and designed for sampling
+        # workflows only. Do not use this endpoint to check every event in your system.
+        # Instead, implement a sampling strategy to randomly validate a subset of events
+        # for observability purposes.
         sig do
           params(
             transaction_ids: T::Array[String],

data/rbi/metronome_sdk/resources/v1.rbi

@@ -42,6 +42,9 @@ module MetronomeSDK
       sig { returns(MetronomeSDK::Resources::V1::Contracts) }
       attr_reader :contracts
 
+      sig { returns(MetronomeSDK::Resources::V1::Payments) }
+      attr_reader :payments
+
       # @api private
       sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
       def self.new(client:)

data/rbi/metronome_sdk/resources/v2/contracts.rbi

@@ -4,8 +4,23 @@ module MetronomeSDK
   module Resources
     class V2
       class Contracts
-        # Get a specific contract. New clients should use this endpoint rather than the v1
-        # endpoint.
+        # Gets the details for a specific contract, including contract term, rate card
+        # information, credits and commits, and more.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Check the duration of a customer's current contract
+        # - Get details on contract terms, including access schedule amounts for
+        #   commitments and credits
+        # - Understand the state of a contract at a past time. As you can evolve the terms
+        #   of a contract over time through editing, use the `as_of_date` parameter to
+        #   view the full contract configuration as of that point in time.
+        #
+        # ### Usage guidelines:
+        #
+        # - Optionally, use the `include_balance` and `include_ledger` fields to include
+        #   balances and ledgers in the credit and commit responses. Using these fields
+        #   will cause the query to be slower.
         sig do
           params(
             contract_id: String,
@@ -32,8 +47,21 @@ module MetronomeSDK
         )
         end
 
-        # List all contracts for a customer in chronological order. New clients should use
-        # this endpoint rather than the v1 endpoint.
+        # For a given customer, lists all of their contracts in chronological order.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Check if a customer is provisioned with any contract, and at which tier
+        # - Check the duration and terms of a customer's current contract
+        # - Power a page in your end customer experience that shows the customer's history
+        #   of tiers (e.g. this customer started out on the Pro Plan, then downgraded to
+        #   the Starter plan).
+        #
+        # ### Usage guidelines:
+        #
+        # Use the `starting_at`, `covering_date`, and `include_archived` parameters to
+        # filter the list of returned contracts. For example, to list only currently
+        # active contracts, pass `covering_date` equal to the current time.
         sig do
           params(
             customer_id: String,
@@ -65,11 +93,34 @@ module MetronomeSDK
         )
         end
 
-        # Edit a contract. Contract editing must be enabled to use this endpoint.
+        # The ability to edit a contract helps you react quickly to the needs of your
+        # customers and your business.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Encode mid-term commitment and discount changes
+        # - Fix configuration mistakes and easily roll back packaging changes
+        #
+        # ### Key response fields:
+        #
+        # - The `id` of the edit
+        # - Complete edit details. For example, if you edited the contract to add new
+        #   overrides and credits, you will receive the IDs of those overrides and credits
+        #   in the response.
+        #
+        # ### Usage guidelines:
+        #
+        # - When you edit a contract, any draft invoices update immediately to reflect
+        #   that edit. Finalized invoices remain unchanged - you must void and regenerate
+        #   them in the UI or API to reflect the edit.
+        # - Contract editing must be enabled to use this endpoint. Reach out to your
+        #   Metronome representative to learn more.
         sig do
           params(
             contract_id: String,
             customer_id: String,
+            add_billing_provider_configuration_update:
+              MetronomeSDK::V2::ContractEditParams::AddBillingProviderConfigurationUpdate::OrHash,
             add_commits:
               T::Array[MetronomeSDK::V2::ContractEditParams::AddCommit::OrHash],
             add_credits:
@@ -83,7 +134,7 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditParams::AddOverride::OrHash
               ],
             add_prepaid_balance_threshold_configuration:
-              MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration::OrHash,
+              MetronomeSDK::PrepaidBalanceThresholdConfigurationV2::OrHash,
             add_professional_services:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::AddProfessionalService::OrHash
@@ -105,7 +156,7 @@ module MetronomeSDK
                 MetronomeSDK::V2::ContractEditParams::AddScheduledCharge::OrHash
               ],
             add_spend_threshold_configuration:
-              MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration::OrHash,
+              MetronomeSDK::SpendThresholdConfigurationV2::OrHash,
             add_subscriptions:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::AddSubscription::OrHash
@@ -127,6 +178,7 @@ module MetronomeSDK
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::RemoveOverride::OrHash
               ],
+            uniqueness_key: String,
             update_commits:
               T::Array[
                 MetronomeSDK::V2::ContractEditParams::UpdateCommit::OrHash
@@ -165,6 +217,10 @@ module MetronomeSDK
           contract_id:,
           # ID of the customer whose contract is being edited
           customer_id:,
+          # Update the billing provider configuration on the contract. Currently only
+          # supports adding a billing provider configuration to a contract that does not
+          # already have one.
+          add_billing_provider_configuration_update: nil,
           add_commits: nil,
           add_credits: nil,
           add_discounts: nil,
@@ -194,6 +250,8 @@ module MetronomeSDK
           archive_scheduled_charges: nil,
           # IDs of overrides to remove
           remove_overrides: nil,
+          # Optional uniqueness key to prevent duplicate contract edits.
+          uniqueness_key: nil,
           update_commits: nil,
           # RFC 3339 timestamp indicating when the contract will end (exclusive).
           update_contract_end_date: nil,
@@ -218,8 +276,22 @@ module MetronomeSDK
         )
         end
 
-        # Edit a customer or contract commit. Contract commits can only be edited using
-        # this endpoint if contract editing is enabled.
+        # Edit specific details for a contract-level or customer-level commit. Use this
+        # endpoint to modify individual commit access schedules, invoice schedules,
+        # applicable products, invoicing contracts, or other fields.
+        #
+        # ### Usage guidelines:
+        #
+        # - As with all edits in Metronome, draft invoices will reflect the edit
+        #   immediately, while finalized invoices are untouched unless voided and
+        #   regenerated.
+        # - If a commit's invoice schedule item is associated with a finalized invoice,
+        #   you cannot remove or update the invoice schedule item.
+        # - If a commit's invoice schedule item is associated with a voided invoice, you
+        #   cannot remove the invoice schedule item.
+        # - You cannot remove an commit access schedule segment that was applied to a
+        #   finalized invoice. You can void the invoice beforehand and then remove the
+        #   access schedule segment.
         sig do
           params(
             commit_id: String,
@@ -228,17 +300,17 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             invoice_contract_id: String,
             invoice_schedule:
               MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule::OrHash,
             priority: T.nilable(Float),
             product_id: String,
+            rate_type:
+              MetronomeSDK::V2::ContractEditCommitParams::RateType::OrSymbol,
             specifiers:
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V2::ContractEditCommitParams::Specifier::OrHash
-                ]
-              ),
+              T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V2::ContractEditCommitResponse)
         end
@@ -256,6 +328,8 @@ module MetronomeSDK
           # applicable_product_tags or specifiers are not provided, the commit applies to
           # all products.
           applicable_product_tags: nil,
+          # Optional configuration for commit hierarchy access control
+          hierarchy_configuration: nil,
           # ID of contract to use for invoicing
           invoice_contract_id: nil,
           invoice_schedule: nil,
@@ -263,6 +337,10 @@ module MetronomeSDK
           # first.
           priority: nil,
           product_id: nil,
+          # If provided, updates the commit to use the specified rate type for current and
+          # future invoices. Previously finalized invoices will need to be voided and
+          # regenerated to reflect the rate type change.
+          rate_type: nil,
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown. This field cannot
@@ -274,8 +352,22 @@ module MetronomeSDK
         )
         end
 
-        # Edit a customer or contract credit. Contract credits can only be edited using
-        # this endpoint if contract editing is enabled.
+        # Edit details for a contract-level or customer-level credit.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Extend the duration or the amount of an existing free credit like a trial
+        # - Modify individual credit access schedules, applicable products, priority, or
+        #   other fields.
+        #
+        # ### Usage guidelines:
+        #
+        # - As with all edits in Metronome, draft invoices will reflect the edit
+        #   immediately, while finalized invoices are untouched unless voided and
+        #   regenerated.
+        # - You cannot remove an access schedule segment that was applied to a finalized
+        #   invoice. You can void the invoice beforehand and then remove the access
+        #   schedule segment.
         sig do
           params(
             credit_id: String,
@@ -284,14 +376,14 @@ module MetronomeSDK
               MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule::OrHash,
             applicable_product_ids: T.nilable(T::Array[String]),
             applicable_product_tags: T.nilable(T::Array[String]),
+            hierarchy_configuration:
+              MetronomeSDK::CommitHierarchyConfiguration::OrHash,
             priority: T.nilable(Float),
             product_id: String,
+            rate_type:
+              MetronomeSDK::V2::ContractEditCreditParams::RateType::OrSymbol,
             specifiers:
-              T.nilable(
-                T::Array[
-                  MetronomeSDK::V2::ContractEditCreditParams::Specifier::OrHash
-                ]
-              ),
+              T.nilable(T::Array[MetronomeSDK::CommitSpecifierInput::OrHash]),
             request_options: MetronomeSDK::RequestOptions::OrHash
           ).returns(MetronomeSDK::Models::V2::ContractEditCreditResponse)
         end
@@ -307,10 +399,16 @@ module MetronomeSDK
           # Which tags the credit applies to. If both applicable_product_ids and
           # applicable_product_tags are not provided, the credit applies to all products.
           applicable_product_tags: nil,
+          # Optional configuration for credit hierarchy access control
+          hierarchy_configuration: nil,
           # If multiple commits are applicable, the one with the lower priority will apply
           # first.
           priority: nil,
           product_id: nil,
+          # If provided, updates the credit to use the specified rate type for current and
+          # future invoices. Previously finalized invoices will need to be voided and
+          # regenerated to reflect the rate type change.
+          rate_type: nil,
           # List of filters that determine what kind of customer usage draws down a commit
           # or credit. A customer's usage needs to meet the condition of at least one of the
           # specifiers to contribute to a commit's or credit's drawdown. This field cannot
@@ -322,8 +420,21 @@ module MetronomeSDK
         )
         end
 
-        # Get the edit history of a specific contract. Contract editing must be enabled to
-        # use this endpoint.
+        # List all the edits made to a contract over time. In Metronome, you can edit a
+        # contract at any point after it's created to fix mistakes or reflect changes in
+        # terms. Metronome stores a full history of all edits that were ever made to a
+        # contract, whether through the UI, `editContract` endpoint, or other endpoints
+        # like `updateContractEndDate`.
+        #
+        # ### Use this endpoint to:
+        #
+        # - Understand what changes were made to a contract, when, and by who
+        #
+        # ### Key response fields:
+        #
+        # - An array of every edit ever made to the contract
+        # - Details on each individual edit - for example showing that in one edit, a user
+        #   added two discounts and incremented a subscription quantity.
         sig do
           params(
             contract_id: String,

data/sig/metronome_sdk/errors.rbs

@@ -21,11 +21,14 @@ module MetronomeSDK
 
       attr_accessor status: Integer?
 
+      attr_accessor headers: ::Hash[String, String]?
+
       attr_accessor body: top?
 
       def initialize: (
         url: URI::Generic,
         ?status: Integer?,
+        ?headers: ::Hash[String, String]?,
         ?body: Object?,
         ?request: nil,
         ?response: nil,
@@ -37,6 +40,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -48,6 +52,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         ?status: nil,
+        ?headers: ::Hash[String, String]?,
         ?body: nil,
         ?request: nil,
         ?response: nil,
@@ -59,6 +64,7 @@ module MetronomeSDK
       def self.for: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,
@@ -68,6 +74,7 @@ module MetronomeSDK
       def initialize: (
         url: URI::Generic,
         status: Integer,
+        headers: ::Hash[String, String]?,
         body: Object?,
         request: nil,
         response: nil,

data/sig/metronome_sdk/file_part.rbs

@@ -14,7 +14,7 @@ module MetronomeSDK
 
     def initialize: (
       Pathname | StringIO | IO | String content,
-      ?filename: String?,
+      ?filename: (Pathname | String)?,
       ?content_type: String?
     ) -> void
   end

data/sig/metronome_sdk/internal/body_cursor_page.rbs

@@ -0,0 +1,13 @@
+module MetronomeSDK
+  module Internal
+    class BodyCursorPage[Elem]
+      include MetronomeSDK::Internal::Type::BasePage[Elem]
+
+      attr_accessor next_page_: String
+
+      attr_accessor data: ::Array[Elem]?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/metronome_sdk/internal/cursor_page_without_limit.rbs

@@ -0,0 +1,13 @@
+module MetronomeSDK
+  module Internal
+    class CursorPageWithoutLimit[Elem]
+      include MetronomeSDK::Internal::Type::BasePage[Elem]
+
+      attr_accessor next_page_: String
+
+      attr_accessor data: ::Array[Elem]?
+
+      def inspect: -> String
+    end
+  end
+end

data/sig/metronome_sdk/models/base_threshold_commit.rbs

@@ -0,0 +1,26 @@
+module MetronomeSDK
+  module Models
+    type base_threshold_commit =
+      { product_id: String, description: String, name: String }
+
+    class BaseThresholdCommit < MetronomeSDK::Internal::Type::BaseModel
+      attr_accessor product_id: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        product_id: String,
+        ?description: String,
+        ?name: String
+      ) -> void
+
+      def to_hash: -> { product_id: String, description: String, name: String }
+    end
+  end
+end