feat: link response models to their methods in yard doc (#198)

stainless-app[bot] · stainless-app[bot] · commit 6f6cc2972dd0 · 2025-04-01T17:54:57.000Z
diff --git a/lib/orb/models/alert.rb b/lib/orb/models/alert.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Alerts#retrieve
     class Alert < Orb::BaseModel
       # @!attribute id
       #   Also referred to as alert_id in this documentation.
diff --git a/lib/orb/models/billable_metric.rb b/lib/orb/models/billable_metric.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Metrics#create
     class BillableMetric < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/coupon.rb b/lib/orb/models/coupon.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Coupons#create
     class Coupon < Orb::BaseModel
       # @!attribute id
       #   Also referred to as coupon_id in this documentation.
diff --git a/lib/orb/models/credit_note.rb b/lib/orb/models/credit_note.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::CreditNotes#create
     class CreditNote < Orb::BaseModel
       # @!attribute id
       #   The Orb id of this credit note.
diff --git a/lib/orb/models/customer.rb b/lib/orb/models/customer.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Customers#create
     class Customer < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/customers/balance_transaction_create_response.rb b/lib/orb/models/customers/balance_transaction_create_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#create
       class BalanceTransactionCreateResponse < Orb::BaseModel
         # @!attribute id
         #   A unique id for this transaction.
diff --git a/lib/orb/models/customers/balance_transaction_list_response.rb b/lib/orb/models/customers/balance_transaction_list_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::BalanceTransactions#list
       class BalanceTransactionListResponse < Orb::BaseModel
         # @!attribute id
         #   A unique id for this transaction.
diff --git a/lib/orb/models/customers/cost_list_by_external_id_response.rb b/lib/orb/models/customers/cost_list_by_external_id_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::Costs#list_by_external_id
       class CostListByExternalIDResponse < Orb::BaseModel
         # @!attribute data
         #
diff --git a/lib/orb/models/customers/cost_list_response.rb b/lib/orb/models/customers/cost_list_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::Costs#list
       class CostListResponse < Orb::BaseModel
         # @!attribute data
         #
diff --git a/lib/orb/models/customers/credit_list_by_external_id_response.rb b/lib/orb/models/customers/credit_list_by_external_id_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::Credits#list_by_external_id
       class CreditListByExternalIDResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/customers/credit_list_response.rb b/lib/orb/models/customers/credit_list_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Customers
+      # @see Orb::Resources::Customers::Credits#list
       class CreditListResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb b/lib/orb/models/customers/credits/ledger_create_entry_by_external_id_response.rb
@@ -6,6 +6,8 @@ module Customers
       module Credits
         # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
         #   credits within Orb.
+        #
+        # @see Orb::Resources::Customers::Credits::Ledger#create_entry_by_external_id
         module LedgerCreateEntryByExternalIDResponse
           extend Orb::Union
 
diff --git a/lib/orb/models/customers/credits/ledger_create_entry_response.rb b/lib/orb/models/customers/credits/ledger_create_entry_response.rb
@@ -6,6 +6,8 @@ module Customers
       module Credits
         # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
         #   credits within Orb.
+        #
+        # @see Orb::Resources::Customers::Credits::Ledger#create_entry
         module LedgerCreateEntryResponse
           extend Orb::Union
 
diff --git a/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb b/lib/orb/models/customers/credits/ledger_list_by_external_id_response.rb
@@ -6,6 +6,8 @@ module Customers
       module Credits
         # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
         #   credits within Orb.
+        #
+        # @see Orb::Resources::Customers::Credits::Ledger#list_by_external_id
         module LedgerListByExternalIDResponse
           extend Orb::Union
 
diff --git a/lib/orb/models/customers/credits/ledger_list_response.rb b/lib/orb/models/customers/credits/ledger_list_response.rb
@@ -6,6 +6,8 @@ module Customers
       module Credits
         # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
         #   credits within Orb.
+        #
+        # @see Orb::Resources::Customers::Credits::Ledger#list
         module LedgerListResponse
           extend Orb::Union
 
diff --git a/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb
@@ -4,6 +4,7 @@ module Orb
   module Models
     module Customers
       module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#create_by_external_id
         class TopUpCreateByExternalIDResponse < Orb::BaseModel
           # @!attribute id
           #
diff --git a/lib/orb/models/customers/credits/top_up_create_response.rb b/lib/orb/models/customers/credits/top_up_create_response.rb
@@ -4,6 +4,7 @@ module Orb
   module Models
     module Customers
       module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#create
         class TopUpCreateResponse < Orb::BaseModel
           # @!attribute id
           #
diff --git a/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb b/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb
@@ -4,6 +4,7 @@ module Orb
   module Models
     module Customers
       module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list_by_external_id
         class TopUpListByExternalIDResponse < Orb::BaseModel
           # @!attribute id
           #
diff --git a/lib/orb/models/customers/credits/top_up_list_response.rb b/lib/orb/models/customers/credits/top_up_list_response.rb
@@ -4,6 +4,7 @@ module Orb
   module Models
     module Customers
       module Credits
+        # @see Orb::Resources::Customers::Credits::TopUps#list
         class TopUpListResponse < Orb::BaseModel
           # @!attribute id
           #
diff --git a/lib/orb/models/dimensional_price_group.rb b/lib/orb/models/dimensional_price_group.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::DimensionalPriceGroups#create
     class DimensionalPriceGroup < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/event_deprecate_response.rb b/lib/orb/models/event_deprecate_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Events#deprecate
     class EventDeprecateResponse < Orb::BaseModel
       # @!attribute deprecated
       #   event_id of the deprecated event, if successfully updated
diff --git a/lib/orb/models/event_ingest_response.rb b/lib/orb/models/event_ingest_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Events#ingest
     class EventIngestResponse < Orb::BaseModel
       # @!attribute validation_failed
       #   Contains all failing validation events. In the case of a 200, this array will
diff --git a/lib/orb/models/event_search_response.rb b/lib/orb/models/event_search_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Events#search
     class EventSearchResponse < Orb::BaseModel
       # @!attribute data
       #
diff --git a/lib/orb/models/event_update_response.rb b/lib/orb/models/event_update_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Events#update
     class EventUpdateResponse < Orb::BaseModel
       # @!attribute amended
       #   event_id of the amended event, if successfully ingested
diff --git a/lib/orb/models/events/backfill_close_response.rb b/lib/orb/models/events/backfill_close_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Backfills#close
       class BackfillCloseResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/events/backfill_create_response.rb b/lib/orb/models/events/backfill_create_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Backfills#create
       class BackfillCreateResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/events/backfill_fetch_response.rb b/lib/orb/models/events/backfill_fetch_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Backfills#fetch
       class BackfillFetchResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/events/backfill_list_response.rb b/lib/orb/models/events/backfill_list_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Backfills#list
       class BackfillListResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/events/backfill_revert_response.rb b/lib/orb/models/events/backfill_revert_response.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Backfills#revert
       class BackfillRevertResponse < Orb::BaseModel
         # @!attribute id
         #
diff --git a/lib/orb/models/events/event_volumes.rb b/lib/orb/models/events/event_volumes.rb
@@ -3,6 +3,7 @@
 module Orb
   module Models
     module Events
+      # @see Orb::Resources::Events::Volume#list
       class EventVolumes < Orb::BaseModel
         # @!attribute data
         #
diff --git a/lib/orb/models/invoice.rb b/lib/orb/models/invoice.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Invoices#create
     class Invoice < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/invoice_fetch_upcoming_response.rb b/lib/orb/models/invoice_fetch_upcoming_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Invoices#fetch_upcoming
     class InvoiceFetchUpcomingResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/invoice_line_item_create_response.rb b/lib/orb/models/invoice_line_item_create_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::InvoiceLineItems#create
     class InvoiceLineItemCreateResponse < Orb::BaseModel
       # @!attribute id
       #   A unique ID for this line item.
diff --git a/lib/orb/models/item.rb b/lib/orb/models/item.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Items#create
     class Item < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/plan.rb b/lib/orb/models/plan.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Plans#create
     class Plan < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/price.rb b/lib/orb/models/price.rb
@@ -12,6 +12,8 @@ module Models
     #
     #   For more on the types of prices, see
     #   [the core concepts documentation](/core-concepts#plan-and-price)
+    #
+    # @see Orb::Resources::Prices#create
     module Price
       extend Orb::Union
 
diff --git a/lib/orb/models/price_evaluate_response.rb b/lib/orb/models/price_evaluate_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Prices#evaluate
     class PriceEvaluateResponse < Orb::BaseModel
       # @!attribute data
       #
diff --git a/lib/orb/models/subscription.rb b/lib/orb/models/subscription.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#update
     class Subscription < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_cancel_response.rb b/lib/orb/models/subscription_cancel_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#cancel
     class SubscriptionCancelResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_create_response.rb b/lib/orb/models/subscription_create_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#create
     class SubscriptionCreateResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_fetch_costs_response.rb b/lib/orb/models/subscription_fetch_costs_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#fetch_costs
     class SubscriptionFetchCostsResponse < Orb::BaseModel
       # @!attribute data
       #
diff --git a/lib/orb/models/subscription_fetch_schedule_response.rb b/lib/orb/models/subscription_fetch_schedule_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#fetch_schedule
     class SubscriptionFetchScheduleResponse < Orb::BaseModel
       # @!attribute created_at
       #
diff --git a/lib/orb/models/subscription_price_intervals_response.rb b/lib/orb/models/subscription_price_intervals_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#price_intervals
     class SubscriptionPriceIntervalsResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_schedule_plan_change_response.rb b/lib/orb/models/subscription_schedule_plan_change_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#schedule_plan_change
     class SubscriptionSchedulePlanChangeResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_trigger_phase_response.rb b/lib/orb/models/subscription_trigger_phase_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#trigger_phase
     class SubscriptionTriggerPhaseResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_unschedule_cancellation_response.rb b/lib/orb/models/subscription_unschedule_cancellation_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#unschedule_cancellation
     class SubscriptionUnscheduleCancellationResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb b/lib/orb/models/subscription_unschedule_fixed_fee_quantity_updates_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#unschedule_fixed_fee_quantity_updates
     class SubscriptionUnscheduleFixedFeeQuantityUpdatesResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb b/lib/orb/models/subscription_unschedule_pending_plan_changes_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#unschedule_pending_plan_changes
     class SubscriptionUnschedulePendingPlanChangesResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb b/lib/orb/models/subscription_update_fixed_fee_quantity_response.rb
@@ -2,6 +2,7 @@
 
 module Orb
   module Models
+    # @see Orb::Resources::Subscriptions#update_fixed_fee_quantity
     class SubscriptionUpdateFixedFeeQuantityResponse < Orb::BaseModel
       # @!attribute id
       #
diff --git a/lib/orb/models/subscription_update_trial_response.rb b/lib/orb/models/subscription_update_trial_response.rb
diff --git a/lib/orb/models/subscription_usage.rb b/lib/orb/models/subscription_usage.rb
diff --git a/lib/orb/models/top_level_ping_response.rb b/lib/orb/models/top_level_ping_response.rb

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`module Orb`
`4`	`4`	`module Models`
	`5`	`+ # @see Orb::Resources::Metrics#create`
`5`	`6`	`class BillableMetric < Orb::BaseModel`
`6`	`7`	`# @!attribute id`
`7`	`8`	`#`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`module Orb`
`4`	`4`	`module Models`
`5`	`5`	`module Customers`
	`6`	`+ # @see Orb::Resources::Customers::Costs#list_by_external_id`
`6`	`7`	`class CostListByExternalIDResponse < Orb::BaseModel`
`7`	`8`	`# @!attribute data`
`8`	`9`	`#`