feat(api): api update

Author: stainless-app[bot]

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 116
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-612316c13276a207f56e2e2c7bbc68f4bb73de85e3661595a23f23d9ccc80276.yml
-openapi_spec_hash: 6e125f05e40521ec485edf6e15beec2e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-e79a36262fa3c577305a43717398fb70482bb2dca47cdb3e201cbb2a590c359c.yml
+openapi_spec_hash: 1e04880dccbcc082ba451083e421a471
 config_hash: 3c3524be9607afb24d2139ce26ce5389

lib/orb/models/credit_note_create_params.rb

@@ -19,10 +19,10 @@ class CreditNoteCreateParams < Orb::Internal::Type::BaseModel
       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 @@ class CreditNoteCreateParams < Orb::Internal::Type::BaseModel
       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 @@ class CreditNoteCreateParams < Orb::Internal::Type::BaseModel
       #
       #   @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 @@ class LineItem < Orb::Internal::Type::BaseModel
         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 @@ class LineItem < Orb::Internal::Type::BaseModel
         #
         #   @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.

lib/orb/resources/credit_notes.rb

@@ -40,11 +40,11 @@ class CreditNotes
       #
       # @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]
       #

rbi/orb/models/credit_note_create_params.rbi

@@ -18,21 +18,21 @@ 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
 
       # An optional memo to attach to the credit note.
       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

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: {}
       )