orb-billing 1.13.0 → 1.15.0

data/lib/orb/models/invoice_line_item_create_response.rb

@@ -22,7 +22,7 @@ module Orb
       #   invoice calculations (ie. usage discounts -> amount discounts -> percentage
       #   discounts -> minimums -> maximums).
       #
-      #   @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
+      #   @return [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>]
       required :adjustments,
                -> { Orb::Internal::Type::ArrayOf[union: Orb::Models::InvoiceLineItemCreateResponse::Adjustment] }
 
@@ -83,7 +83,7 @@ module Orb
       #   For more on the types of prices, see
       #   [the core concepts documentation](/core-concepts#plan-and-price)
       #
-      #   @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
+      #   @return [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput]
       required :price, union: -> { Orb::Price }
 
       # @!attribute quantity
@@ -133,7 +133,7 @@ module Orb
       #
       #   @param adjusted_subtotal [String] The line amount after any adjustments and before overage conversion, credits and
       #
-      #   @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
+      #   @param adjustments [Array<Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment>] All adjustments applied to the line item in the order they were applied based on
       #
       #   @param amount [String] The final amount for a line item after all adjustments and pre paid credits have
       #
@@ -149,7 +149,7 @@ module Orb
       #
       #   @param partially_invoiced_amount [String] Any amount applied from a partial invoice
       #
-      #   @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
+      #   @param price [Orb::Models::Price::Unit, Orb::Models::Price::Tiered, Orb::Models::Price::Bulk, Orb::Models::Price::BulkWithFilters, Orb::Models::Price::Package, Orb::Models::Price::Matrix, Orb::Models::Price::ThresholdTotalAmount, Orb::Models::Price::TieredPackage, Orb::Models::Price::TieredWithMinimum, Orb::Models::Price::GroupedTiered, Orb::Models::Price::TieredPackageWithMinimum, Orb::Models::Price::PackageWithAllocation, Orb::Models::Price::UnitWithPercent, Orb::Models::Price::MatrixWithAllocation, Orb::Models::Price::MatrixWithThresholdDiscounts, Orb::Models::Price::TieredWithProration, Orb::Models::Price::UnitWithProration, Orb::Models::Price::GroupedAllocation, Orb::Models::Price::BulkWithProration, Orb::Models::Price::GroupedWithProratedMinimum, Orb::Models::Price::GroupedWithMeteredMinimum, Orb::Models::Price::GroupedWithMinMaxThresholds, Orb::Models::Price::MatrixWithDisplayName, Orb::Models::Price::GroupedTieredPackage, Orb::Models::Price::MaxGroupTieredPackage, Orb::Models::Price::ScalableMatrixWithUnitPricing, Orb::Models::Price::ScalableMatrixWithTieredPricing, Orb::Models::Price::CumulativeGroupedBulk, Orb::Models::Price::CumulativeGroupedAllocation, Orb::Models::Price::DailyCreditAllowance, Orb::Models::Price::MeteredAllowance, Orb::Models::Price::MinimumComposite, Orb::Models::Price::Percent, Orb::Models::Price::EventOutput] The Price resource represents a price that can be billed on a subscription, resu
       #
       #   @param quantity [Float] Either the fixed fee quantity or the usage during the service period.
       #
@@ -174,12 +174,196 @@ module Orb
 
         variant :percentage_discount, -> { Orb::MonetaryPercentageDiscountAdjustment }
 
+        variant :tiered_percentage_discount,
+                -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount }
+
         variant :minimum, -> { Orb::MonetaryMinimumAdjustment }
 
         variant :maximum, -> { Orb::MonetaryMaximumAdjustment }
 
+        class TieredPercentageDiscount < Orb::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute adjustment_type
+          #
+          #   @return [Symbol, :tiered_percentage_discount]
+          required :adjustment_type, const: :tiered_percentage_discount
+
+          # @!attribute amount
+          #   The value applied by an adjustment.
+          #
+          #   @return [String]
+          required :amount, String
+
+          # @!attribute applies_to_price_ids
+          #   @deprecated
+          #
+          #   The price IDs that this adjustment applies to.
+          #
+          #   @return [Array<String>]
+          required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
+
+          # @!attribute filters
+          #   The filters that determine which prices to apply this adjustment to.
+          #
+          #   @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter>]
+          required :filters,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter] }
+
+          # @!attribute is_invoice_level
+          #   True for adjustments that apply to an entire invoice, false for adjustments that
+          #   apply to only one price.
+          #
+          #   @return [Boolean]
+          required :is_invoice_level, Orb::Internal::Type::Boolean
+
+          # @!attribute reason
+          #   The reason for the adjustment.
+          #
+          #   @return [String, nil]
+          required :reason, String, nil?: true
+
+          # @!attribute replaces_adjustment_id
+          #   The adjustment id this adjustment replaces. This adjustment will take the place
+          #   of the replaced adjustment in plan version migrations.
+          #
+          #   @return [String, nil]
+          required :replaces_adjustment_id, String, nil?: true
+
+          # @!attribute tiers
+          #   The ordered, contiguous bands of cumulative eligible spend, each discounted at
+          #   its own percentage (progressive fill-a-tier), applied to the prices this
+          #   adjustment covers in a given billing period.
+          #
+          #   @return [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier>]
+          required :tiers,
+                   -> { Orb::Internal::Type::ArrayOf[Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier] }
+
+          # @!method initialize(id:, amount:, applies_to_price_ids:, filters:, is_invoice_level:, reason:, replaces_adjustment_id:, tiers:, adjustment_type: :tiered_percentage_discount)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount}
+          #   for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount [String] The value applied by an adjustment.
+          #
+          #   @param applies_to_price_ids [Array<String>] The price IDs that this adjustment applies to.
+          #
+          #   @param filters [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter>] The filters that determine which prices to apply this adjustment to.
+          #
+          #   @param is_invoice_level [Boolean] True for adjustments that apply to an entire invoice, false for adjustments that
+          #
+          #   @param reason [String, nil] The reason for the adjustment.
+          #
+          #   @param replaces_adjustment_id [String, nil] The adjustment id this adjustment replaces. This adjustment will take the place
+          #
+          #   @param tiers [Array<Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier>] The ordered, contiguous bands of cumulative eligible spend, each discounted at i
+          #
+          #   @param adjustment_type [Symbol, :tiered_percentage_discount]
+
+          class Filter < Orb::Internal::Type::BaseModel
+            # @!attribute field
+            #   The property of the price to filter on.
+            #
+            #   @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field]
+            required :field,
+                     enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field }
+
+            # @!attribute operator
+            #   Should prices that match the filter be included or excluded.
+            #
+            #   @return [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator]
+            required :operator,
+                     enum: -> { Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator }
+
+            # @!attribute values
+            #   The IDs or values that match this filter.
+            #
+            #   @return [Array<String>]
+            required :values, Orb::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(field:, operator:, values:)
+            #   @param field [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Field] The property of the price to filter on.
+            #
+            #   @param operator [Symbol, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter::Operator] Should prices that match the filter be included or excluded.
+            #
+            #   @param values [Array<String>] The IDs or values that match this filter.
+
+            # The property of the price to filter on.
+            #
+            # @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter#field
+            module Field
+              extend Orb::Internal::Type::Enum
+
+              PRICE_ID = :price_id
+              ITEM_ID = :item_id
+              PRICE_TYPE = :price_type
+              CURRENCY = :currency
+              PRICING_UNIT_ID = :pricing_unit_id
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # Should prices that match the filter be included or excluded.
+            #
+            # @see Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Filter#operator
+            module Operator
+              extend Orb::Internal::Type::Enum
+
+              INCLUDES = :includes
+              EXCLUDES = :excludes
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Tier < Orb::Internal::Type::BaseModel
+            # @!attribute lower_bound
+            #   Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @return [Float]
+            required :lower_bound, Float
+
+            # @!attribute percentage
+            #   The percentage (between 0 and 1) discounted from spend that falls within this
+            #   tier.
+            #
+            #   @return [Float]
+            required :percentage, Float
+
+            # @!attribute upper_bound
+            #   Inclusive upper bound of cumulative spend for this tier; null for the final
+            #   open-ended tier.
+            #
+            #   @return [Float, nil]
+            optional :upper_bound, Float, nil?: true
+
+            # @!method initialize(lower_bound:, percentage:, upper_bound: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount::Tier}
+            #   for more details.
+            #
+            #   One band of a tiered percentage discount. Bounds are denominated in the
+            #   discount's currency. `lower_bound` is the exclusive start of the band and
+            #   `upper_bound` is the inclusive end; `upper_bound` is null only for the
+            #   open-ended final tier.
+            #
+            #   @param lower_bound [Float] Exclusive lower bound of cumulative spend for this tier.
+            #
+            #   @param percentage [Float] The percentage (between 0 and 1) discounted from spend that falls within this ti
+            #
+            #   @param upper_bound [Float, nil] Inclusive upper bound of cumulative spend for this tier; null for the final open
+          end
+        end
+
         # @!method self.variants
-        #   @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
+        #   @return [Array(Orb::Models::MonetaryUsageDiscountAdjustment, Orb::Models::MonetaryAmountDiscountAdjustment, Orb::Models::MonetaryPercentageDiscountAdjustment, Orb::Models::InvoiceLineItemCreateResponse::Adjustment::TieredPercentageDiscount, Orb::Models::MonetaryMinimumAdjustment, Orb::Models::MonetaryMaximumAdjustment)]
       end
 
       module SubLineItem

data/lib/orb/models/invoice_list_summary_response.rb

@@ -114,11 +114,13 @@ module Orb
       #   | Estonia                | `eu_vat`     | European VAT Number                                                                                     |
       #   | Ethiopia               | `et_tin`     | Ethiopia Tax Identification Number                                                                      |
       #   | European Union         | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme                                                  |
+      #   | Faroe Islands          | `fo_vat`     | Faroe Islands VAT Number                                                                                |
       #   | Finland                | `eu_vat`     | European VAT Number                                                                                     |
       #   | France                 | `eu_vat`     | European VAT Number                                                                                     |
       #   | Georgia                | `ge_vat`     | Georgian VAT                                                                                            |
       #   | Germany                | `de_stn`     | German Tax Number (Steuernummer)                                                                        |
       #   | Germany                | `eu_vat`     | European VAT Number                                                                                     |
+      #   | Gibraltar              | `gi_tin`     | Gibraltar Tax Identification Number                                                                     |
       #   | Greece                 | `eu_vat`     | European VAT Number                                                                                     |
       #   | Guinea                 | `gn_nif`     | Guinea Tax Identification Number (Número de Identificação Fiscal)                                       |
       #   | Hong Kong              | `hk_br`      | Hong Kong BR Number                                                                                     |
@@ -130,6 +132,7 @@ module Orb
       #   | Ireland                | `eu_vat`     | European VAT Number                                                                                     |
       #   | Israel                 | `il_vat`     | Israel VAT                                                                                              |
       #   | Italy                  | `eu_vat`     | European VAT Number                                                                                     |
+      #   | Italy                  | `it_cf`      | Italian Codice Fiscale Number                                                                           |
       #   | Japan                  | `jp_cn`      | Japanese Corporate Number (_Hōjin Bangō_)                                                               |
       #   | Japan                  | `jp_rn`      | Japanese Registered Foreign Businesses' Registration Number (_Tōroku Kokugai Jigyōsha no Tōroku Bangō_) |
       #   | Japan                  | `jp_trn`     | Japanese Tax Registration Number (_Tōroku Bangō_)                                                       |
@@ -160,6 +163,7 @@ module Orb
       #   | Norway                 | `no_vat`     | Norwegian VAT Number                                                                                    |
       #   | Norway                 | `no_voec`    | Norwegian VAT on e-commerce Number                                                                      |
       #   | Oman                   | `om_vat`     | Omani VAT Number                                                                                        |
+      #   | Paraguay               | `py_ruc`     | Paraguayan RUC Number                                                                                   |
       #   | Peru                   | `pe_ruc`     | Peruvian RUC Number                                                                                     |
       #   | Philippines            | `ph_tin`     | Philippines Tax Identification Number                                                                   |
       #   | Poland                 | `eu_vat`     | European VAT Number                                                                                     |
@@ -181,6 +185,7 @@ module Orb
       #   | South Korea            | `kr_brn`     | Korean BRN                                                                                              |
       #   | Spain                  | `es_cif`     | Spanish NIF Number (previously Spanish CIF Number)                                                      |
       #   | Spain                  | `eu_vat`     | European VAT Number                                                                                     |
+      #   | Sri Lanka              | `lk_vat`     | Sri Lanka VAT Number                                                                                    |
       #   | Suriname               | `sr_fin`     | Suriname FIN Number                                                                                     |
       #   | Sweden                 | `eu_vat`     | European VAT Number                                                                                     |
       #   | Switzerland            | `ch_uid`     | Switzerland UID Number                                                                                  |
@@ -222,8 +227,8 @@ module Orb
       required :eligible_to_issue_at, Time, nil?: true
 
       # @!attribute hosted_invoice_url
-      #   A URL for the customer-facing invoice portal. This URL expires 30 days after the
-      #   invoice's due date, or 60 days after being re-generated through the UI.
+      #   A URL for the customer-facing invoice portal. This URL expires 60 days after the
+      #   link is generated, or 30 days after the invoice's due date — whichever is later.
       #
       #   @return [String, nil]
       required :hosted_invoice_url, String, nil?: true
@@ -391,7 +396,7 @@ module Orb
       #
       #   @param eligible_to_issue_at [Time, nil] If the invoice has a status of `draft`, this will be the time that the invoice w
       #
-      #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 30 days after the
+      #   @param hosted_invoice_url [String, nil] A URL for the customer-facing invoice portal. This URL expires 60 days after the
       #
       #   @param invoice_date [Time] The scheduled date of the invoice
       #
@@ -735,6 +740,7 @@ module Orb
           extend Orb::Internal::Type::Enum
 
           STRIPE = :stripe
+          ADYEN = :adyen
 
           # @!method self.values
           #   @return [Array<Symbol>]

data/lib/orb/models/invoice_mark_paid_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute invoice_id
+      #
+      #   @return [String]
+      required :invoice_id, String
+
       # @!attribute payment_received_date
       #   A date string to specify the date of the payment.
       #
@@ -25,7 +30,9 @@ module Orb
       #   @return [String, nil]
       optional :notes, String, nil?: true
 
-      # @!method initialize(payment_received_date:, external_id: nil, notes: nil, request_options: {})
+      # @!method initialize(invoice_id:, payment_received_date:, external_id: nil, notes: nil, request_options: {})
+      #   @param invoice_id [String]
+      #
       #   @param payment_received_date [Date] A date string to specify the date of the payment.
       #
       #   @param external_id [String, nil] An optional external ID to associate with the payment.

data/lib/orb/models/invoice_pay_params.rb

@@ -7,7 +7,22 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute invoice_id
+      #
+      #   @return [String]
+      required :invoice_id, String
+
+      # @!attribute shared_payment_token_id
+      #   The ID of a shared payment token granted by an agent to use for this payment.
+      #
+      #   @return [String]
+      required :shared_payment_token_id, String
+
+      # @!method initialize(invoice_id:, shared_payment_token_id:, request_options: {})
+      #   @param invoice_id [String]
+      #
+      #   @param shared_payment_token_id [String] The ID of a shared payment token granted by an agent to use for this payment.
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/invoice_update_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute invoice_id
+      #
+      #   @return [String]
+      required :invoice_id, String
+
       # @!attribute auto_collection
       #   Determines whether this invoice will automatically attempt to charge a saved
       #   payment method, if any. Can only be modified on draft invoices. If not
@@ -46,10 +51,12 @@ module Orb
       #   @return [Integer, nil]
       optional :net_terms, Integer, nil?: true
 
-      # @!method initialize(auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
+      # @!method initialize(invoice_id:, auto_collection: nil, due_date: nil, invoice_date: nil, metadata: nil, net_terms: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::InvoiceUpdateParams} for more details.
       #
+      #   @param invoice_id [String]
+      #
       #   @param auto_collection [Boolean, nil] Determines whether this invoice will automatically attempt to charge a saved pay
       #
       #   @param due_date [Date, Time, nil] An optional custom due date for the invoice. If not set, the due date will be ca

data/lib/orb/models/invoice_void_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute invoice_id
+      #
+      #   @return [String]
+      required :invoice_id, String
+
+      # @!method initialize(invoice_id:, request_options: {})
+      #   @param invoice_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/item_archive_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute item_id
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!method initialize(item_id:, request_options: {})
+      #   @param item_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/item_fetch_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute item_id
+      #
+      #   @return [String]
+      required :item_id, String
+
+      # @!method initialize(item_id:, request_options: {})
+      #   @param item_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/item_update_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute item_id
+      #
+      #   @return [String]
+      required :item_id, String
+
       # @!attribute external_connections
       #
       #   @return [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
@@ -27,10 +32,12 @@ module Orb
       #   @return [String, nil]
       optional :name, String, nil?: true
 
-      # @!method initialize(external_connections: nil, metadata: nil, name: nil, request_options: {})
+      # @!method initialize(item_id:, external_connections: nil, metadata: nil, name: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::ItemUpdateParams} for more details.
       #
+      #   @param item_id [String]
+      #
       #   @param external_connections [Array<Orb::Models::ItemUpdateParams::ExternalConnection>, nil]
       #
       #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed

data/lib/orb/models/license_deactivate_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute license_id
+      #
+      #   @return [String]
+      required :license_id, String
+
       # @!attribute end_date
       #   The date to deactivate the license. If not provided, defaults to end of day
       #   today in the customer's timezone.
@@ -14,10 +19,12 @@ module Orb
       #   @return [Date, nil]
       optional :end_date, Date, nil?: true
 
-      # @!method initialize(end_date: nil, request_options: {})
+      # @!method initialize(license_id:, end_date: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::LicenseDeactivateParams} for more details.
       #
+      #   @param license_id [String]
+      #
       #   @param end_date [Date, nil] The date to deactivate the license. If not provided, defaults to end of day toda
       #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]

data/lib/orb/models/license_retrieve_by_external_id_params.rb

@@ -7,6 +7,11 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
+      # @!attribute external_license_id
+      #
+      #   @return [String]
+      required :external_license_id, String
+
       # @!attribute license_type_id
       #   The ID of the license type to fetch the license for.
       #
@@ -19,7 +24,9 @@ module Orb
       #   @return [String]
       required :subscription_id, String
 
-      # @!method initialize(license_type_id:, subscription_id:, request_options: {})
+      # @!method initialize(external_license_id:, license_type_id:, subscription_id:, request_options: {})
+      #   @param external_license_id [String]
+      #
       #   @param license_type_id [String] The ID of the license type to fetch the license for.
       #
       #   @param subscription_id [String] The ID of the subscription to fetch the license for.

data/lib/orb/models/license_retrieve_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute license_id
+      #
+      #   @return [String]
+      required :license_id, String
+
+      # @!method initialize(license_id:, request_options: {})
+      #   @param license_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/license_type_retrieve_params.rb

@@ -7,7 +7,13 @@ module Orb
       extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!method initialize(request_options: {})
+      # @!attribute license_type_id
+      #
+      #   @return [String]
+      required :license_type_id, String
+
+      # @!method initialize(license_type_id:, request_options: {})
+      #   @param license_type_id [String]
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/licenses/external_license_get_usage_params.rb

@@ -8,6 +8,11 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
+        # @!attribute external_license_id
+        #
+        #   @return [String]
+        required :external_license_id, String
+
         # @!attribute license_type_id
         #   The license type ID to filter licenses by.
         #
@@ -37,8 +42,8 @@ module Orb
         #   How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #   'license,day').
         #
-        #   @return [Array<String>, nil]
-        optional :group_by, Orb::Internal::Type::ArrayOf[String], nil?: true
+        #   @return [String, nil]
+        optional :group_by, String, nil?: true
 
         # @!attribute limit
         #   Maximum number of rows in the response data (default 20, max 100).
@@ -53,10 +58,12 @@ module Orb
         #   @return [Date, nil]
         optional :start_date, Date, nil?: true
 
-        # @!method initialize(license_type_id:, subscription_id:, cursor: nil, end_date: nil, group_by: nil, limit: nil, start_date: nil, request_options: {})
+        # @!method initialize(external_license_id:, license_type_id:, subscription_id:, cursor: nil, end_date: nil, group_by: nil, limit: nil, start_date: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Licenses::ExternalLicenseGetUsageParams} for more details.
         #
+        #   @param external_license_id [String]
+        #
         #   @param license_type_id [String] The license type ID to filter licenses by.
         #
         #   @param subscription_id [String] The subscription ID to get license usage for.
@@ -65,7 +72,7 @@ module Orb
         #
         #   @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
         #
-        #   @param group_by [Array<String>, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
+        #   @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #
         #   @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
         #

data/lib/orb/models/licenses/usage_get_all_usage_params.rb

@@ -37,8 +37,8 @@ module Orb
         #   How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #   'license,day').
         #
-        #   @return [Array<String>, nil]
-        optional :group_by, Orb::Internal::Type::ArrayOf[String], nil?: true
+        #   @return [String, nil]
+        optional :group_by, String, nil?: true
 
         # @!attribute limit
         #   Maximum number of rows in the response data (default 20, max 100).
@@ -65,7 +65,7 @@ module Orb
         #
         #   @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
         #
-        #   @param group_by [Array<String>, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
+        #   @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #
         #   @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
         #

data/lib/orb/models/licenses/usage_get_usage_params.rb

@@ -8,6 +8,11 @@ module Orb
         extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
+        # @!attribute license_id
+        #
+        #   @return [String]
+        required :license_id, String
+
         # @!attribute cursor
         #   Pagination cursor from a previous request.
         #
@@ -25,8 +30,8 @@ module Orb
         #   How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #   'license,day').
         #
-        #   @return [Array<String>, nil]
-        optional :group_by, Orb::Internal::Type::ArrayOf[String], nil?: true
+        #   @return [String, nil]
+        optional :group_by, String, nil?: true
 
         # @!attribute limit
         #   Maximum number of rows in the response data (default 20, max 100).
@@ -41,15 +46,17 @@ module Orb
         #   @return [Date, nil]
         optional :start_date, Date, nil?: true
 
-        # @!method initialize(cursor: nil, end_date: nil, group_by: nil, limit: nil, start_date: nil, request_options: {})
+        # @!method initialize(license_id:, cursor: nil, end_date: nil, group_by: nil, limit: nil, start_date: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {Orb::Models::Licenses::UsageGetUsageParams} for more details.
         #
+        #   @param license_id [String]
+        #
         #   @param cursor [String, nil] Pagination cursor from a previous request.
         #
         #   @param end_date [Date, nil] End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p
         #
-        #   @param group_by [Array<String>, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
+        #   @param group_by [String, nil] How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,
         #
         #   @param limit [Integer] Maximum number of rows in the response data (default 20, max 100).
         #