orb-billing 1.6.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3f5680937e041cc9ffbb5053850aa48cbbaa99f9bd8ae054bbe18d547c9404c
-  data.tar.gz: 1cca78b8b0c0767a23a4a7e9d01a715e00ef5d7644348896a07b7b497a835ae9
+  metadata.gz: 73eacd2178ce9b71a5008a0c26c266fcf6579d79722d724c57f57b77c8a38bad
+  data.tar.gz: a18fc7d75c927d7d2d2e76e44434343e3104806c34330c1f3fdfd53da3816ce9
 SHA512:
-  metadata.gz: 4f3d60e893a9dc4ce1c150585169a1e281ab6f88f92517b2e4fd0f1ae07d25d3cc83aa19128bbbaec7f509ecdecea336bba5c1d314f7bcb3bb970d31c008bdbf
-  data.tar.gz: 592341b112aeba6378a1b8ebc52436b4b663410b67d6561cd8071f3bf04a3790f452c825599a40679fdd77b7e81f375896922964683114476fe7a917461ac0c2
+  metadata.gz: 9afea5e8284f240ee0fe7a3d911c4ae7d253f5fa8b320dd616524f68cdca6a256eae576471ca59472299e0894e51e618e3cc792818ce7a931d53ac88473ade73
+  data.tar.gz: cdb483431879ee339cf54f769f174cf8b2a08b240d64ed079c631640385c020c26a8f994083b4bdc3f6102d1ecdf26cd40aedf137aeea7f90b3c4f9a783712b6

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 1.8.0 (2025-07-17)
+
+Full Changelog: [v1.7.0...v1.8.0](https://github.com/orbcorp/orb-ruby/compare/v1.7.0...v1.8.0)
+
+### Features
+
+* **api:** api update ([bb9bd7c](https://github.com/orbcorp/orb-ruby/commit/bb9bd7c820a76f1f502400f8ba9fed9518cc0010))
+
+
+### Chores
+
+* **internal:** version bump ([a255b91](https://github.com/orbcorp/orb-ruby/commit/a255b917bb484b1756398dd60d129db7d4012327))
+
+## 1.7.0 (2025-07-16)
+
+Full Changelog: [v1.6.0...v1.7.0](https://github.com/orbcorp/orb-ruby/compare/v1.6.0...v1.7.0)
+
+### Features
+
+* **api:** api update ([78865a0](https://github.com/orbcorp/orb-ruby/commit/78865a03cdc7ca40dacad41ef18546f8bbee1593))
+
+
+### Chores
+
+* **internal:** version bump ([811d9b6](https://github.com/orbcorp/orb-ruby/commit/811d9b63cef236992ab6cef658877c4cec96f61a))
+
 ## 1.6.0 (2025-07-16)
 
 Full Changelog: [v1.5.1...v1.6.0](https://github.com/orbcorp/orb-ruby/compare/v1.5.1...v1.6.0)

data/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", "~> 1.6.0"
+gem "orb-billing", "~> 1.8.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/orb/models/credit_note_create_params.rb

@@ -19,10 +19,10 @@ module Orb
       required :reason, enum: -> { Orb::CreditNoteCreateParams::Reason }
 
       # @!attribute end_date
-      #   An optional date string to specify the global credit note service period end
-      #   date in the customer's timezone. This will be applied to all line items. If not
-      #   provided, line items will use their original invoice line item service periods.
-      #   This date is inclusive.
+      #   A date string to specify the global credit note service period end date in the
+      #   customer's timezone. This will be applied to all line items that don't have
+      #   their own individual service periods specified. If not provided, line items will
+      #   use their original invoice line item service periods. This date is inclusive.
       #
       #   @return [Date, nil]
       optional :end_date, Date, nil?: true
@@ -34,10 +34,10 @@ module Orb
       optional :memo, String, nil?: true
 
       # @!attribute start_date
-      #   An optional date string to specify the global credit note service period end
-      #   date in the customer's timezone. This will be applied to all line items. If not
-      #   provided, line items will use their original invoice line item service periods.
-      #   This date is inclusive.
+      #   A date string to specify the global credit note service period start date in the
+      #   customer's timezone. This will be applied to all line items that don't have
+      #   their own individual service periods specified. If not provided, line items will
+      #   use their original invoice line item service periods. This date is inclusive.
       #
       #   @return [Date, nil]
       optional :start_date, Date, nil?: true
@@ -50,11 +50,11 @@ module Orb
       #
       #   @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
-      #   @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
+      #   @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
       #
       #   @param memo [String, nil] An optional memo to attach to the credit note.
       #
-      #   @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
+      #   @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
@@ -72,21 +72,20 @@ module Orb
         required :invoice_line_item_id, String
 
         # @!attribute end_date
-        #   An optional date string to specify this line item's credit note service period
-        #   end date in the customer's timezone. If provided, this will be used for this
-        #   specific line item. If not provided, will use the global end_date if available,
-        #   otherwise defaults to the original invoice line item's end date. This date is
-        #   inclusive.
+        #   A date string to specify this line item's credit note service period end date in
+        #   the customer's timezone. If provided, this will be used for this specific line
+        #   item. If not provided, will use the global end_date if available, otherwise
+        #   defaults to the original invoice line item's end date. This date is inclusive.
         #
         #   @return [Date, nil]
         optional :end_date, Date, nil?: true
 
         # @!attribute start_date
-        #   An optional date string to specify this line item's credit note service period
-        #   start date in the customer's timezone. If provided, this will be used for this
-        #   specific line item. If not provided, will use the global start_date if
-        #   available, otherwise defaults to the original invoice line item's start date.
-        #   This date is inclusive.
+        #   A date string to specify this line item's credit note service period start date
+        #   in the customer's timezone. If provided, this will be used for this specific
+        #   line item. If not provided, will use the global start_date if available,
+        #   otherwise defaults to the original invoice line item's start date. This date is
+        #   inclusive.
         #
         #   @return [Date, nil]
         optional :start_date, Date, nil?: true
@@ -99,9 +98,9 @@ module Orb
         #
         #   @param invoice_line_item_id [String] The ID of the line item to credit.
         #
-        #   @param end_date [Date, nil] An optional date string to specify this line item's credit note service period e
+        #   @param end_date [Date, nil] A date string to specify this line item's credit note service period end date in
         #
-        #   @param start_date [Date, nil] An optional date string to specify this line item's credit note service period s
+        #   @param start_date [Date, nil] A date string to specify this line item's credit note service period start date
       end
 
       # An optional reason for the credit note.

data/lib/orb/models/customers/cost_list_by_external_id_params.rb

@@ -9,7 +9,7 @@ module Orb
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
-        #   The currency or custom pricing unit to use.
+        #   The currency to use.
         #
         #   @return [String, nil]
         optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ module Orb
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CostListByExternalIDParams} for more details.
         #
-        #   @param currency [String, nil] The currency or custom pricing unit to use.
+        #   @param currency [String, nil] The currency to use.
         #
         #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
         #

data/lib/orb/models/customers/cost_list_params.rb

@@ -9,7 +9,7 @@ module Orb
         include Orb::Internal::Type::RequestParameters
 
         # @!attribute currency
-        #   The currency or custom pricing unit to use.
+        #   The currency to use.
         #
         #   @return [String, nil]
         optional :currency, String, nil?: true
@@ -39,7 +39,7 @@ module Orb
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Customers::CostListParams} for more details.
         #
-        #   @param currency [String, nil] The currency or custom pricing unit to use.
+        #   @param currency [String, nil] The currency to use.
         #
         #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
         #

data/lib/orb/models/subscription_fetch_costs_params.rb

@@ -8,7 +8,7 @@ module Orb
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute currency
-      #   The currency or custom pricing unit to use.
+      #   The currency to use.
       #
       #   @return [String, nil]
       optional :currency, String, nil?: true
@@ -38,7 +38,7 @@ module Orb
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::SubscriptionFetchCostsParams} for more details.
       #
-      #   @param currency [String, nil] The currency or custom pricing unit to use.
+      #   @param currency [String, nil] The currency to use.
       #
       #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
       #

data/lib/orb/resources/credit_notes.rb

@@ -40,11 +40,11 @@ module Orb
       #
       # @param reason [Symbol, Orb::Models::CreditNoteCreateParams::Reason] An optional reason for the credit note.
       #
-      # @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
+      # @param end_date [Date, nil] A date string to specify the global credit note service period end date in the c
       #
       # @param memo [String, nil] An optional memo to attach to the credit note.
       #
-      # @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
+      # @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/orb/resources/customers/costs.rb

@@ -129,7 +129,7 @@ module Orb
         #
         # @param customer_id [String]
         #
-        # @param currency [String, nil] The currency or custom pricing unit to use.
+        # @param currency [String, nil] The currency to use.
         #
         # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
         #
@@ -278,7 +278,7 @@ module Orb
         #
         # @param external_customer_id [String]
         #
-        # @param currency [String, nil] The currency or custom pricing unit to use.
+        # @param currency [String, nil] The currency to use.
         #
         # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
         #

data/lib/orb/resources/subscriptions.rb

@@ -568,7 +568,7 @@ module Orb
       #
       # @param subscription_id [String]
       #
-      # @param currency [String, nil] The currency or custom pricing unit to use.
+      # @param currency [String, nil] The currency to use.
       #
       # @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
       #

data/lib/orb/version.rb

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

data/rbi/orb/models/credit_note_create_params.rbi

@@ -18,10 +18,10 @@ module Orb
       sig { returns(Orb::CreditNoteCreateParams::Reason::OrSymbol) }
       attr_accessor :reason
 
-      # An optional date string to specify the global credit note service period end
-      # date in the customer's timezone. This will be applied to all line items. If not
-      # provided, line items will use their original invoice line item service periods.
-      # This date is inclusive.
+      # A date string to specify the global credit note service period end date in the
+      # customer's timezone. This will be applied to all line items that don't have
+      # their own individual service periods specified. If not provided, line items will
+      # use their original invoice line item service periods. This date is inclusive.
       sig { returns(T.nilable(Date)) }
       attr_accessor :end_date
 
@@ -29,10 +29,10 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :memo
 
-      # An optional date string to specify the global credit note service period end
-      # date in the customer's timezone. This will be applied to all line items. If not
-      # provided, line items will use their original invoice line item service periods.
-      # This date is inclusive.
+      # A date string to specify the global credit note service period start date in the
+      # customer's timezone. This will be applied to all line items that don't have
+      # their own individual service periods specified. If not provided, line items will
+      # use their original invoice line item service periods. This date is inclusive.
       sig { returns(T.nilable(Date)) }
       attr_accessor :start_date
 
@@ -50,17 +50,17 @@ module Orb
         line_items:,
         # An optional reason for the credit note.
         reason:,
-        # An optional date string to specify the global credit note service period end
-        # date in the customer's timezone. This will be applied to all line items. If not
-        # provided, line items will use their original invoice line item service periods.
-        # This date is inclusive.
+        # A date string to specify the global credit note service period end date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
         end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
-        # An optional date string to specify the global credit note service period end
-        # date in the customer's timezone. This will be applied to all line items. If not
-        # provided, line items will use their original invoice line item service periods.
-        # This date is inclusive.
+        # A date string to specify the global credit note service period start date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
         start_date: nil,
         request_options: {}
       )
@@ -95,19 +95,18 @@ module Orb
         sig { returns(String) }
         attr_accessor :invoice_line_item_id
 
-        # An optional date string to specify this line item's credit note service period
-        # end date in the customer's timezone. If provided, this will be used for this
-        # specific line item. If not provided, will use the global end_date if available,
-        # otherwise defaults to the original invoice line item's end date. This date is
-        # inclusive.
+        # A date string to specify this line item's credit note service period end date in
+        # the customer's timezone. If provided, this will be used for this specific line
+        # item. If not provided, will use the global end_date if available, otherwise
+        # defaults to the original invoice line item's end date. This date is inclusive.
         sig { returns(T.nilable(Date)) }
         attr_accessor :end_date
 
-        # An optional date string to specify this line item's credit note service period
-        # start date in the customer's timezone. If provided, this will be used for this
-        # specific line item. If not provided, will use the global start_date if
-        # available, otherwise defaults to the original invoice line item's start date.
-        # This date is inclusive.
+        # A date string to specify this line item's credit note service period start date
+        # in the customer's timezone. If provided, this will be used for this specific
+        # line item. If not provided, will use the global start_date if available,
+        # otherwise defaults to the original invoice line item's start date. This date is
+        # inclusive.
         sig { returns(T.nilable(Date)) }
         attr_accessor :start_date
 
@@ -124,17 +123,16 @@ module Orb
           amount:,
           # The ID of the line item to credit.
           invoice_line_item_id:,
-          # An optional date string to specify this line item's credit note service period
-          # end date in the customer's timezone. If provided, this will be used for this
-          # specific line item. If not provided, will use the global end_date if available,
-          # otherwise defaults to the original invoice line item's end date. This date is
-          # inclusive.
+          # A date string to specify this line item's credit note service period end date in
+          # the customer's timezone. If provided, this will be used for this specific line
+          # item. If not provided, will use the global end_date if available, otherwise
+          # defaults to the original invoice line item's end date. This date is inclusive.
           end_date: nil,
-          # An optional date string to specify this line item's credit note service period
-          # start date in the customer's timezone. If provided, this will be used for this
-          # specific line item. If not provided, will use the global start_date if
-          # available, otherwise defaults to the original invoice line item's start date.
-          # This date is inclusive.
+          # A date string to specify this line item's credit note service period start date
+          # in the customer's timezone. If provided, this will be used for this specific
+          # line item. If not provided, will use the global start_date if available,
+          # otherwise defaults to the original invoice line item's start date. This date is
+          # inclusive.
           start_date: nil
         )
         end

data/rbi/orb/models/customers/cost_list_by_external_id_params.rbi

@@ -15,7 +15,7 @@ module Orb
             )
           end
 
-        # The currency or custom pricing unit to use.
+        # The currency to use.
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
 
@@ -53,7 +53,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
-          # The currency or custom pricing unit to use.
+          # The currency to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,

data/rbi/orb/models/customers/cost_list_params.rbi

@@ -12,7 +12,7 @@ module Orb
             T.any(Orb::Customers::CostListParams, Orb::Internal::AnyHash)
           end
 
-        # The currency or custom pricing unit to use.
+        # The currency to use.
         sig { returns(T.nilable(String)) }
         attr_accessor :currency
 
@@ -44,7 +44,7 @@ module Orb
           ).returns(T.attached_class)
         end
         def self.new(
-          # The currency or custom pricing unit to use.
+          # The currency to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,

data/rbi/orb/models/subscription_fetch_costs_params.rbi

@@ -11,7 +11,7 @@ module Orb
           T.any(Orb::SubscriptionFetchCostsParams, Orb::Internal::AnyHash)
         end
 
-      # The currency or custom pricing unit to use.
+      # The currency to use.
       sig { returns(T.nilable(String)) }
       attr_accessor :currency
 
@@ -45,7 +45,7 @@ module Orb
         ).returns(T.attached_class)
       end
       def self.new(
-        # The currency or custom pricing unit to use.
+        # The currency to use.
         currency: nil,
         # Costs returned are exclusive of `timeframe_end`.
         timeframe_end: nil,

data/rbi/orb/resources/credit_notes.rbi

@@ -44,17 +44,17 @@ module Orb
         line_items:,
         # An optional reason for the credit note.
         reason:,
-        # An optional date string to specify the global credit note service period end
-        # date in the customer's timezone. This will be applied to all line items. If not
-        # provided, line items will use their original invoice line item service periods.
-        # This date is inclusive.
+        # A date string to specify the global credit note service period end date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
         end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
-        # An optional date string to specify the global credit note service period end
-        # date in the customer's timezone. This will be applied to all line items. If not
-        # provided, line items will use their original invoice line item service periods.
-        # This date is inclusive.
+        # A date string to specify the global credit note service period start date in the
+        # customer's timezone. This will be applied to all line items that don't have
+        # their own individual service periods specified. If not provided, line items will
+        # use their original invoice line item service periods. This date is inclusive.
         start_date: nil,
         request_options: {}
       )

data/rbi/orb/resources/customers/costs.rbi

@@ -134,7 +134,7 @@ module Orb
         end
         def list(
           customer_id,
-          # The currency or custom pricing unit to use.
+          # The currency to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,
@@ -281,7 +281,7 @@ module Orb
         end
         def list_by_external_id(
           external_customer_id,
-          # The currency or custom pricing unit to use.
+          # The currency to use.
           currency: nil,
           # Costs returned are exclusive of `timeframe_end`.
           timeframe_end: nil,

data/rbi/orb/resources/subscriptions.rbi

@@ -611,7 +611,7 @@ module Orb
       end
       def fetch_costs(
         subscription_id,
-        # The currency or custom pricing unit to use.
+        # The currency to use.
         currency: nil,
         # Costs returned are exclusive of `timeframe_end`.
         timeframe_end: nil,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Orb
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-16 00:00:00.000000000 Z
+date: 2025-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool