release: 0.9.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.8.0"
+  ".": "0.9.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 114
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-6d2a5b5d2cfb485e1a548aa15e1e36844e1f14f42553033822e1c570c8aa0825.yml
-openapi_spec_hash: 0266a5aaced5e768bcf6a70924d69799
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-faced218bf2dee89c8449bdb209e7090452d26c0646f0b998f84fe5bd3c4b7cb.yml
+openapi_spec_hash: b3a957e9c012fad5093545f65614ea42
 config_hash: e63f2d098e5d12f63ae4cd8270aa5c3c

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 0.9.0 (2025-05-30)
+
+Full Changelog: [v0.8.0...v0.9.0](https://github.com/orbcorp/orb-ruby/compare/v0.8.0...v0.9.0)
+
+### Features
+
+* **api:** api update ([4c07dd1](https://github.com/orbcorp/orb-ruby/commit/4c07dd113926af678db91561fc501d17fa4da86e))
+
+
+### Chores
+
+* **internal:** version bump ([c9592f1](https://github.com/orbcorp/orb-ruby/commit/c9592f19f8f618117d4a5503a507d06b8abf7ac2))
+
 ## 0.8.0 (2025-05-29)
 
 Full Changelog: [v0.7.0...v0.8.0](https://github.com/orbcorp/orb-ruby/compare/v0.7.0...v0.8.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    orb-billing (0.7.0)
+    orb-billing (0.8.0)
       connection_pool
 
 GEM

README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "orb-billing", "~> 0.8.0"
+gem "orb-billing", "~> 0.9.0"
 ```
 
 <!-- x-release-please-end -->

lib/orb/models/customers/credits/top_up_create_by_external_id_params.rb

@@ -112,8 +112,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -131,7 +133,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/customers/credits/top_up_create_by_external_id_response.rb

@@ -104,8 +104,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -123,7 +125,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/customers/credits/top_up_create_params.rb

@@ -108,8 +108,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -127,7 +129,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/customers/credits/top_up_create_response.rb

@@ -102,8 +102,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -121,7 +123,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb

@@ -104,8 +104,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -123,7 +125,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/customers/credits/top_up_list_response.rb

@@ -102,8 +102,10 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             optional :memo, String, nil?: true
 
             # @!attribute require_successful_payment
-            #   If true, new credit blocks created by this top-up will require that the
-            #   corresponding invoice is paid before they can be drawn down from.
+            #   When true, credit blocks created by this top-up will require that the
+            #   corresponding invoice is paid before they are drawn down from. If any topup
+            #   block is pending payment, further automatic top-ups will be paused until the
+            #   invoice is paid or voided.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
@@ -121,7 +123,7 @@ class InvoiceSettings < Orb::Internal::Type::BaseModel
             #
             #   @param memo [String, nil] An optional memo to display on the invoice.
             #
-            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   @param require_successful_payment [Boolean] When true, credit blocks created by this top-up will require that the correspond
           end
 
           # The unit of expires_after.

lib/orb/models/event_ingest_params.rb

@@ -56,8 +56,8 @@ class Event < Orb::Internal::Type::BaseModel
         #   A dictionary of custom properties. Values in this dictionary must be numeric,
         #   boolean, or strings. Nested dictionaries are disallowed.
         #
-        #   @return [Object]
-        required :properties, Orb::Internal::Type::Unknown
+        #   @return [Hash{Symbol=>Object}]
+        required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
 
         # @!attribute timestamp
         #   An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -88,7 +88,7 @@ class Event < Orb::Internal::Type::BaseModel
         #
         #   @param idempotency_key [String] A unique value, generated by the client, that is used to de-duplicate events. Ex
         #
-        #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+        #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
         #
         #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
         #

lib/orb/models/event_search_response.rb

@@ -50,8 +50,8 @@ class Data < Orb::Internal::Type::BaseModel
         #   A dictionary of custom properties. Values in this dictionary must be numeric,
         #   boolean, or strings. Nested dictionaries are disallowed.
         #
-        #   @return [Object]
-        required :properties, Orb::Internal::Type::Unknown
+        #   @return [Hash{Symbol=>Object}]
+        required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
 
         # @!attribute timestamp
         #   An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -79,7 +79,7 @@ class Data < Orb::Internal::Type::BaseModel
         #
         #   @param external_customer_id [String, nil] An alias for the Orb customer, whose mapping is specified when creating the cust
         #
-        #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+        #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
         #
         #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
       end

lib/orb/models/event_update_params.rb

@@ -17,8 +17,8 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel
       #   A dictionary of custom properties. Values in this dictionary must be numeric,
       #   boolean, or strings. Nested dictionaries are disallowed.
       #
-      #   @return [Object]
-      required :properties, Orb::Internal::Type::Unknown
+      #   @return [Hash{Symbol=>Object}]
+      required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
 
       # @!attribute timestamp
       #   An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -47,7 +47,7 @@ class EventUpdateParams < Orb::Internal::Type::BaseModel
       #
       #   @param event_name [String] A name to meaningfully identify the action or event type.
       #
-      #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+      #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
       #
       #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
       #

lib/orb/models/price_evaluate_multiple_params.rb

@@ -74,8 +74,8 @@ class Event < Orb::Internal::Type::BaseModel
         #   A dictionary of custom properties. Values in this dictionary must be numeric,
         #   boolean, or strings. Nested dictionaries are disallowed.
         #
-        #   @return [Object]
-        required :properties, Orb::Internal::Type::Unknown
+        #   @return [Hash{Symbol=>Object}]
+        required :properties, Orb::Internal::Type::HashOf[Orb::Internal::Type::Unknown]
 
         # @!attribute timestamp
         #   An ISO 8601 format date with no timezone offset (i.e. UTC). This should
@@ -104,7 +104,7 @@ class Event < Orb::Internal::Type::BaseModel
         #
         #   @param event_name [String] A name to meaningfully identify the action or event type.
         #
-        #   @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+        #   @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
         #
         #   @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
         #

lib/orb/resources/events.rb

@@ -64,7 +64,7 @@ class Events
       #
       # @param event_name [String] A name to meaningfully identify the action or event type.
       #
-      # @param properties [Object] A dictionary of custom properties. Values in this dictionary must be numeric, bo
+      # @param properties [Hash{Symbol=>Object}] A dictionary of custom properties. Values in this dictionary must be numeric, bo
       #
       # @param timestamp [Time] An ISO 8601 format date with no timezone offset (i.e. UTC). This should represen
       #

lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "0.8.0"
+  VERSION = "0.9.0"
 end

rbi/orb/models/customers/credits/top_up_create_by_external_id_params.rbi

@@ -158,8 +158,10 @@ module Orb
             sig { returns(T.nilable(String)) }
             attr_accessor :memo
 
-            # If true, new credit blocks created by this top-up will require that the
-            # corresponding invoice is paid before they can be drawn down from.
+            # When true, credit blocks created by this top-up will require that the
+            # corresponding invoice is paid before they are drawn down from. If any topup
+            # block is pending payment, further automatic top-ups will be paused until the
+            # invoice is paid or voided.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :require_successful_payment
 
@@ -185,8 +187,10 @@ module Orb
               net_terms:,
               # An optional memo to display on the invoice.
               memo: nil,
-              # If true, new credit blocks created by this top-up will require that the
-              # corresponding invoice is paid before they can be drawn down from.
+              # When true, credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they are drawn down from. If any topup
+              # block is pending payment, further automatic top-ups will be paused until the
+              # invoice is paid or voided.
               require_successful_payment: nil
             )
             end

rbi/orb/models/customers/credits/top_up_create_by_external_id_response.rbi

@@ -148,8 +148,10 @@ module Orb
             sig { returns(T.nilable(String)) }
             attr_accessor :memo
 
-            # If true, new credit blocks created by this top-up will require that the
-            # corresponding invoice is paid before they can be drawn down from.
+            # When true, credit blocks created by this top-up will require that the
+            # corresponding invoice is paid before they are drawn down from. If any topup
+            # block is pending payment, further automatic top-ups will be paused until the
+            # invoice is paid or voided.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :require_successful_payment
 
@@ -175,8 +177,10 @@ module Orb
               net_terms:,
               # An optional memo to display on the invoice.
               memo: nil,
-              # If true, new credit blocks created by this top-up will require that the
-              # corresponding invoice is paid before they can be drawn down from.
+              # When true, credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they are drawn down from. If any topup
+              # block is pending payment, further automatic top-ups will be paused until the
+              # invoice is paid or voided.
               require_successful_payment: nil
             )
             end

rbi/orb/models/customers/credits/top_up_create_params.rbi

@@ -156,8 +156,10 @@ module Orb
             sig { returns(T.nilable(String)) }
             attr_accessor :memo
 
-            # If true, new credit blocks created by this top-up will require that the
-            # corresponding invoice is paid before they can be drawn down from.
+            # When true, credit blocks created by this top-up will require that the
+            # corresponding invoice is paid before they are drawn down from. If any topup
+            # block is pending payment, further automatic top-ups will be paused until the
+            # invoice is paid or voided.
             sig { returns(T.nilable(T::Boolean)) }
             attr_reader :require_successful_payment
 
@@ -183,8 +185,10 @@ module Orb
               net_terms:,
               # An optional memo to display on the invoice.
               memo: nil,
-              # If true, new credit blocks created by this top-up will require that the
-              # corresponding invoice is paid before they can be drawn down from.
+              # When true, credit blocks created by this top-up will require that the
+              # corresponding invoice is paid before they are drawn down from. If any topup
+              # block is pending payment, further automatic top-ups will be paused until the
+              # invoice is paid or voided.
               require_successful_payment: nil
             )
             end