orb-billing 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0c597ec876cf9e188fcefa7fb22ee0b81b29a76fc608aead48a6d627749f19
-  data.tar.gz: d1a77bcfc4ce8bd684a2ec47ea680ff29e0178e7f5db27819872f8c7d71eda32
+  metadata.gz: f3f5680937e041cc9ffbb5053850aa48cbbaa99f9bd8ae054bbe18d547c9404c
+  data.tar.gz: 1cca78b8b0c0767a23a4a7e9d01a715e00ef5d7644348896a07b7b497a835ae9
 SHA512:
-  metadata.gz: 93aa9044f594171c74118838ed32a129251ba40d728ff283cddcfae40adbf7afdafb9eb7025fa939fad681ed7c124c41876e2e5aa62f92dfc72209646b0c7be9
-  data.tar.gz: 33448d4588418afca532528e82b99c1f15849ad351ded6fa0038845b36e87e5b9a906c0a5a8fccc42a3ae193caff3026b26f3492e28a9762b80e4e148be4023d
+  metadata.gz: 4f3d60e893a9dc4ce1c150585169a1e281ab6f88f92517b2e4fd0f1ae07d25d3cc83aa19128bbbaec7f509ecdecea336bba5c1d314f7bcb3bb970d31c008bdbf
+  data.tar.gz: 592341b112aeba6378a1b8ebc52436b4b663410b67d6561cd8071f3bf04a3790f452c825599a40679fdd77b7e81f375896922964683114476fe7a917461ac0c2

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## 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)
+
+### Features
+
+* **api:** api update ([f48f7f7](https://github.com/orbcorp/orb-ruby/commit/f48f7f74612c909510f17c3aa881dfe624d019fe))
+
+
+### Chores
+
+* **internal:** version bump ([c9a74a0](https://github.com/orbcorp/orb-ruby/commit/c9a74a0a6affd0104ee2d4950f8c9910a23d25fe))
+
 ## 1.5.1 (2025-07-16)
 
 Full Changelog: [v1.5.0...v1.5.1](https://github.com/orbcorp/orb-ruby/compare/v1.5.0...v1.5.1)

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.5.1"
+gem "orb-billing", "~> 1.6.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
-      #   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.
+      #   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.
       #
       #   @return [Date, nil]
       optional :end_date, Date, nil?: true
@@ -34,10 +34,10 @@ module Orb
       optional :memo, String, nil?: true
 
       # @!attribute start_date
-      #   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.
+      #   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.
       #
       #   @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] A date string to specify the global credit note service period end date in the c
+      #   @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
       #
       #   @param memo [String, nil] An optional memo to attach to the credit note.
       #
-      #   @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
+      #   @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
@@ -72,20 +72,21 @@ module Orb
         required :invoice_line_item_id, String
 
         # @!attribute end_date
-        #   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.
+        #   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.
         #
         #   @return [Date, nil]
         optional :end_date, Date, nil?: true
 
         # @!attribute start_date
-        #   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.
+        #   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.
         #
         #   @return [Date, nil]
         optional :start_date, Date, nil?: true
@@ -98,9 +99,9 @@ module Orb
         #
         #   @param invoice_line_item_id [String] The ID of the line item to credit.
         #
-        #   @param end_date [Date, nil] A date string to specify this line item's credit note service period end date in
+        #   @param end_date [Date, nil] An optional date string to specify this line item's credit note service period e
         #
-        #   @param start_date [Date, nil] A date string to specify this line item's credit note service period start date
+        #   @param start_date [Date, nil] An optional date string to specify this line item's credit note service period s
       end
 
       # An optional reason for the credit note.

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] A date string to specify the global credit note service period end date in the c
+      # @param end_date [Date, nil] An optional date string to specify the global credit note service period end dat
       #
       # @param memo [String, nil] An optional memo to attach to the credit note.
       #
-      # @param start_date [Date, nil] A date string to specify the global credit note service period start date in the
+      # @param start_date [Date, nil] An optional date string to specify the global credit note service period end dat
       #
       # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/orb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Orb
-  VERSION = "1.5.1"
+  VERSION = "1.6.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
 
-      # 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.
+      # 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.
       sig { returns(T.nilable(Date)) }
       attr_accessor :end_date
 
@@ -29,10 +29,10 @@ module Orb
       sig { returns(T.nilable(String)) }
       attr_accessor :memo
 
-      # 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.
+      # 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.
       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:,
-        # 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.
+        # 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.
         end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
-        # 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.
+        # 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.
         start_date: nil,
         request_options: {}
       )
@@ -95,18 +95,19 @@ module Orb
         sig { returns(String) }
         attr_accessor :invoice_line_item_id
 
-        # 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.
+        # 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.
         sig { returns(T.nilable(Date)) }
         attr_accessor :end_date
 
-        # 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.
+        # 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.
         sig { returns(T.nilable(Date)) }
         attr_accessor :start_date
 
@@ -123,16 +124,17 @@ module Orb
           amount:,
           # The ID of the line item to credit.
           invoice_line_item_id:,
-          # 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,
-          # 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
+          # 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.
+          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.
           start_date: nil
         )
         end

data/rbi/orb/resources/credit_notes.rbi

@@ -44,17 +44,17 @@ module Orb
         line_items:,
         # An optional reason for the credit note.
         reason:,
-        # 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.
+        # 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.
         end_date: nil,
         # An optional memo to attach to the credit note.
         memo: nil,
-        # 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.
+        # 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.
         start_date: nil,
         request_options: {}
       )

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: orb-billing
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Orb