chore(docs): add missing descriptions

Author: stainless-app[bot]

lib/orb/client.rb

@@ -21,42 +21,109 @@ class Client < Orb::Internal::Transport::BaseClient
     # @return [Orb::Resources::TopLevel]
     attr_reader :top_level
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Beta]
     attr_reader :beta
 
+    # A coupon represents a reusable discount configuration that can be applied either
+    # as a fixed or percentage amount to an invoice or subscription. Coupons are
+    # activated using a redemption code, which applies the discount to a subscription
+    # or invoice. The duration of a coupon determines how long it remains available
+    # for use by end users.
     # @return [Orb::Resources::Coupons]
     attr_reader :coupons
 
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     # @return [Orb::Resources::CreditNotes]
     attr_reader :credit_notes
 
+    # A customer is a buyer of your products, and the other party to the billing
+    # relationship.
+    #
+    # In Orb, customers are assigned system generated identifiers automatically, but
+    # it's often desirable to have these match existing identifiers in your system. To
+    # avoid having to denormalize Orb ID information, you can pass in an
+    # `external_customer_id` with your own identifier. See
+    # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+    # information about how these aliases work in Orb.
+    #
+    # In addition to having an identifier in your system, a customer may exist in a
+    # payment provider solution like Stripe. Use the `payment_provider_id` and the
+    # `payment_provider` enum field to express this mapping.
+    #
+    # A customer also has a timezone (from the standard
+    # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+    # your account's timezone. See [Timezone localization](/essentials/timezones) for
+    # information on what this timezone parameter influences within Orb.
     # @return [Orb::Resources::Customers]
     attr_reader :customers
 
+    # The [Event](/core-concepts#event) resource represents a usage event that has
+    # been created for a customer. Events are the core of Orb's usage-based billing
+    # model, and are used to calculate the usage charges for a given billing period.
     # @return [Orb::Resources::Events]
     attr_reader :events
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::InvoiceLineItems]
     attr_reader :invoice_line_items
 
+    # An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity,
+    # representing the request for payment for a single subscription. This includes a
+    # set of line items, which correspond to prices in the subscription's plan and can
+    # represent fixed recurring fees or usage-based fees. They are generated at the
+    # end of a billing period, or as the result of an action, such as a cancellation.
     # @return [Orb::Resources::Invoices]
     attr_reader :invoices
 
+    # The Item resource represents a sellable product or good. Items are associated
+    # with all line items, billable metrics, and prices and are used for defining
+    # external sync behavior for invoices and tax calculation purposes.
     # @return [Orb::Resources::Items]
     attr_reader :items
 
+    # The Metric resource represents a calculation of a quantity based on events.
+    # Metrics are defined by the query that transforms raw usage events into
+    # meaningful values for your customers.
     # @return [Orb::Resources::Metrics]
     attr_reader :metrics
 
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     # @return [Orb::Resources::Plans]
     attr_reader :plans
 
+    # The Price resource represents a price that can be billed on a subscription,
+    # resulting in a charge on an invoice in the form of an invoice line item. Prices
+    # take a quantity and determine an amount to bill.
+    #
+    # Orb supports a few different pricing models out of the box. Each of these models
+    # is serialized differently in a given Price object. The model_type field
+    # determines the key for the configuration object that is present.
+    #
+    # For more on the types of prices, see
+    # [the core concepts documentation](/core-concepts#plan-and-price)
     # @return [Orb::Resources::Prices]
     attr_reader :prices
 
     # @return [Orb::Resources::Subscriptions]
     attr_reader :subscriptions
 
+    # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+    # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+    #
+    # Alerts created through the API can be scoped to either customers or
+    # subscriptions.
     # @return [Orb::Resources::Alerts]
     attr_reader :alerts
 
@@ -66,9 +133,14 @@ class Client < Orb::Internal::Transport::BaseClient
     # @return [Orb::Resources::SubscriptionChanges]
     attr_reader :subscription_changes
 
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     # @return [Orb::Resources::CreditBlocks]
     attr_reader :credit_blocks
 
+    # The LicenseType resource represents a type of license that can be assigned to
+    # users. License types are used during billing by grouping metrics on the
+    # configured grouping key.
     # @return [Orb::Resources::LicenseTypes]
     attr_reader :license_types
 

lib/orb/resources/alerts.rb

@@ -2,6 +2,11 @@
 
 module Orb
   module Resources
+    # [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,
+    # usage, or credit balance and trigger webhooks when a threshold is exceeded.
+    #
+    # Alerts created through the API can be scoped to either customers or
+    # subscriptions.
     class Alerts
       # This endpoint retrieves an alert by its ID.
       #

lib/orb/resources/beta.rb

@@ -2,7 +2,15 @@
 
 module Orb
   module Resources
+    # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+    # subscribed to by a customer. Plans define the billing behavior of the
+    # subscription. You can see more about how to configure prices in the
+    # [Price resource](/reference/price).
     class Beta
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       # @return [Orb::Resources::Beta::ExternalPlanID]
       attr_reader :external_plan_id
 

lib/orb/resources/beta/external_plan_id.rb

@@ -3,6 +3,10 @@
 module Orb
   module Resources
     class Beta
+      # The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
+      # subscribed to by a customer. Plans define the billing behavior of the
+      # subscription. You can see more about how to configure prices in the
+      # [Price resource](/reference/price).
       class ExternalPlanID
         # This endpoint allows the creation of a new plan version for an existing plan.
         #

lib/orb/resources/coupons.rb

@@ -2,7 +2,17 @@
 
 module Orb
   module Resources
+    # A coupon represents a reusable discount configuration that can be applied either
+    # as a fixed or percentage amount to an invoice or subscription. Coupons are
+    # activated using a redemption code, which applies the discount to a subscription
+    # or invoice. The duration of a coupon determines how long it remains available
+    # for use by end users.
     class Coupons
+      # A coupon represents a reusable discount configuration that can be applied either
+      # as a fixed or percentage amount to an invoice or subscription. Coupons are
+      # activated using a redemption code, which applies the discount to a subscription
+      # or invoice. The duration of a coupon determines how long it remains available
+      # for use by end users.
       # @return [Orb::Resources::Coupons::Subscriptions]
       attr_reader :subscriptions
 

lib/orb/resources/coupons/subscriptions.rb

@@ -3,6 +3,11 @@
 module Orb
   module Resources
     class Coupons
+      # A coupon represents a reusable discount configuration that can be applied either
+      # as a fixed or percentage amount to an invoice or subscription. Coupons are
+      # activated using a redemption code, which applies the discount to a subscription
+      # or invoice. The duration of a coupon determines how long it remains available
+      # for use by end users.
       class Subscriptions
         # Some parameter documentations has been truncated, see
         # {Orb::Models::Coupons::SubscriptionListParams} for more details.

lib/orb/resources/credit_blocks.rb

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+    # credits within Orb.
     class CreditBlocks
       # This endpoint returns a credit block identified by its block_id.
       #

lib/orb/resources/credit_notes.rb

@@ -2,6 +2,8 @@
 
 module Orb
   module Resources
+    # The [Credit Note](/invoicing/credit-notes) resource represents a credit that has
+    # been applied to a particular invoice.
     class CreditNotes
       # Some parameter documentations has been truncated, see
       # {Orb::Models::CreditNoteCreateParams} for more details.

lib/orb/resources/customers.rb

@@ -2,13 +2,69 @@
 
 module Orb
   module Resources
+    # A customer is a buyer of your products, and the other party to the billing
+    # relationship.
+    #
+    # In Orb, customers are assigned system generated identifiers automatically, but
+    # it's often desirable to have these match existing identifiers in your system. To
+    # avoid having to denormalize Orb ID information, you can pass in an
+    # `external_customer_id` with your own identifier. See
+    # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+    # information about how these aliases work in Orb.
+    #
+    # In addition to having an identifier in your system, a customer may exist in a
+    # payment provider solution like Stripe. Use the `payment_provider_id` and the
+    # `payment_provider` enum field to express this mapping.
+    #
+    # A customer also has a timezone (from the standard
+    # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+    # your account's timezone. See [Timezone localization](/essentials/timezones) for
+    # information on what this timezone parameter influences within Orb.
     class Customers
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       # @return [Orb::Resources::Customers::Costs]
       attr_reader :costs
 
+      # The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
+      # credits within Orb.
       # @return [Orb::Resources::Customers::Credits]
       attr_reader :credits
 
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       # @return [Orb::Resources::Customers::BalanceTransactions]
       attr_reader :balance_transactions
 

lib/orb/resources/customers/balance_transactions.rb

@@ -3,6 +3,24 @@
 module Orb
   module Resources
     class Customers
+      # A customer is a buyer of your products, and the other party to the billing
+      # relationship.
+      #
+      # In Orb, customers are assigned system generated identifiers automatically, but
+      # it's often desirable to have these match existing identifiers in your system. To
+      # avoid having to denormalize Orb ID information, you can pass in an
+      # `external_customer_id` with your own identifier. See
+      # [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
+      # information about how these aliases work in Orb.
+      #
+      # In addition to having an identifier in your system, a customer may exist in a
+      # payment provider solution like Stripe. Use the `payment_provider_id` and the
+      # `payment_provider` enum field to express this mapping.
+      #
+      # A customer also has a timezone (from the standard
+      # [IANA timezone database](https://www.iana.org/time-zones)), which defaults to
+      # your account's timezone. See [Timezone localization](/essentials/timezones) for
+      # information on what this timezone parameter influences within Orb.
       class BalanceTransactions
         # Creates an immutable balance transaction that updates the customer's balance and
         # returns back the newly created transaction.