orb-billing 0.5.4 → 0.6.0

data/lib/orb/models/item.rb

@@ -19,19 +19,36 @@ module Orb
       #   @return [Array<Orb::Models::Item::ExternalConnection>]
       required :external_connections, -> { Orb::Internal::Type::ArrayOf[Orb::Item::ExternalConnection] }
 
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #   to an empty dictionary. Individual keys can be removed by setting the value to
+      #   `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #   `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::Internal::Type::HashOf[String]
+
       # @!attribute name
       #
       #   @return [String]
       required :name, String
 
-      # @!method initialize(id:, created_at:, external_connections:, name:)
+      # @!method initialize(id:, created_at:, external_connections:, metadata:, name:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Item} for
+      #   more details.
+      #
       #   The Item resource represents a sellable product or good. Items are associated
       #   with all line items, billable metrics, and prices and are used for defining
       #   external sync behavior for invoices and tax calculation purposes.
       #
       #   @param id [String]
+      #
       #   @param created_at [Time]
+      #
       #   @param external_connections [Array<Orb::Models::Item::ExternalConnection>]
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #
       #   @param name [String]
 
       class ExternalConnection < Orb::Internal::Type::BaseModel

data/lib/orb/models/item_archive_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Items#archive
+    class ItemArchiveParams < Orb::Internal::Type::BaseModel
+      extend Orb::Internal::Type::RequestParameters::Converter
+      include Orb::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/orb/models/item_create_params.rb

@@ -13,9 +13,22 @@ module Orb
       #   @return [String]
       required :name, String
 
-      # @!method initialize(name:, request_options: {})
+      # @!attribute metadata
+      #   User-specified key/value pairs for the resource. Individual keys can be removed
+      #   by setting the value to `null`, and the entire metadata mapping can be cleared
+      #   by setting `metadata` to `null`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
+
+      # @!method initialize(name:, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::ItemCreateParams} for more details.
+      #
       #   @param name [String] The name of the item.
       #
+      #   @param metadata [Hash{Symbol=>String, nil}, nil] User-specified key/value pairs for the resource. Individual keys can be removed
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end

data/lib/orb/models/item_update_params.rb

@@ -14,14 +14,29 @@ module Orb
                -> { Orb::Internal::Type::ArrayOf[Orb::ItemUpdateParams::ExternalConnection] },
                nil?: true
 
+      # @!attribute metadata
+      #   User-specified key/value pairs for the resource. Individual keys can be removed
+      #   by setting the value to `null`, and the entire metadata mapping can be cleared
+      #   by setting `metadata` to `null`.
+      #
+      #   @return [Hash{Symbol=>String, nil}, nil]
+      optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
+
       # @!attribute name
       #
       #   @return [String, nil]
       optional :name, String, nil?: true
 
-      # @!method initialize(external_connections: nil, name: nil, request_options: {})
+      # @!method initialize(external_connections: nil, metadata: nil, name: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::ItemUpdateParams} for more details.
+      #
       #   @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
+      #
       #   @param name [String, nil]
+      #
       #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       class ExternalConnection < Orb::Internal::Type::BaseModel

data/lib/orb/models/percentage_discount.rb

@@ -3,13 +3,6 @@
 module Orb
   module Models
     class PercentageDiscount < Orb::Internal::Type::BaseModel
-      # @!attribute applies_to_price_ids
-      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #   this can be a subset of prices.
-      #
-      #   @return [Array<String>]
-      required :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String]
-
       # @!attribute discount_type
       #
       #   @return [Symbol, Orb::Models::PercentageDiscount::DiscountType]
@@ -22,21 +15,28 @@ module Orb
       #   @return [Float]
       required :percentage_discount, Float
 
+      # @!attribute applies_to_price_ids
+      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   this can be a subset of prices.
+      #
+      #   @return [Array<String>, nil]
+      optional :applies_to_price_ids, Orb::Internal::Type::ArrayOf[String], nil?: true
+
       # @!attribute reason
       #
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!method initialize(applies_to_price_ids:, discount_type:, percentage_discount:, reason: nil)
+      # @!method initialize(discount_type:, percentage_discount:, applies_to_price_ids: nil, reason: nil)
       #   Some parameter documentations has been truncated, see
       #   {Orb::Models::PercentageDiscount} for more details.
       #
-      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
-      #
       #   @param discount_type [Symbol, Orb::Models::PercentageDiscount::DiscountType]
       #
       #   @param percentage_discount [Float] Only available if discount_type is `percentage`. This is a number between 0 and
       #
+      #   @param applies_to_price_ids [Array<String>, nil] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #
       #   @param reason [String, nil]
 
       # @see Orb::Models::PercentageDiscount#discount_type