orb-billing 0.1.3 → 0.3.0

data/lib/orb/models/customers/credits/top_up_list_by_external_id_response.rb

@@ -59,31 +59,29 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpListByExternalIDResponse} for more
+          #   details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::ExpiresAfterUnit, nil] The unit of expires_after.
 
           # @see Orb::Models::Customers::Credits::TopUpListByExternalIDResponse#invoice_settings
           class InvoiceSettings < Orb::Internal::Type::BaseModel
@@ -108,28 +106,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   If true, new credit blocks created by this top-up will require that the
             #   corresponding invoice is paid before they can be drawn down from.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpListByExternalIDResponse::InvoiceSettings}
+            #   for more details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -141,11 +141,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

data/lib/orb/models/customers/credits/top_up_list_params.rb

@@ -6,8 +6,7 @@ module Orb
       module Credits
         # @see Orb::Resources::Customers::Credits::TopUps#list
         class TopUpListParams < Orb::Internal::Type::BaseModel
-          # @!parse
-          #   extend Orb::Internal::Type::RequestParameters::Converter
+          extend Orb::Internal::Type::RequestParameters::Converter
           include Orb::Internal::Type::RequestParameters
 
           # @!attribute cursor
@@ -17,24 +16,22 @@ module Orb
           #   @return [String, nil]
           optional :cursor, String, nil?: true
 
-          # @!attribute [r] limit
+          # @!attribute limit
           #   The number of items to fetch. Defaults to 20.
           #
           #   @return [Integer, nil]
           optional :limit, Integer
 
-          # @!parse
-          #   # @return [Integer]
-          #   attr_writer :limit
-
-          # @!parse
-          #   # @param cursor [String, nil]
-          #   # @param limit [Integer]
-          #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-          #   #
-          #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(cursor: nil, limit: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpListParams} for more details.
+          #
+          #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+          #   ...
+          #
+          #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+          #
+          #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
         end
       end
     end

data/lib/orb/models/customers/credits/top_up_list_response.rb

@@ -58,31 +58,28 @@ module Orb
                    enum: -> { Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit },
                    nil?: true
 
-          # @!parse
-          #   # @param id [String]
-          #   # @param amount [String]
-          #   # @param currency [String]
-          #   # @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings]
-          #   # @param per_unit_cost_basis [String]
-          #   # @param threshold [String]
-          #   # @param expires_after [Integer, nil]
-          #   # @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil]
-          #   #
-          #   def initialize(
-          #     id:,
-          #     amount:,
-          #     currency:,
-          #     invoice_settings:,
-          #     per_unit_cost_basis:,
-          #     threshold:,
-          #     expires_after: nil,
-          #     expires_after_unit: nil,
-          #     **
-          #   )
-          #     super
-          #   end
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(id:, amount:, currency:, invoice_settings:, per_unit_cost_basis:, threshold:, expires_after: nil, expires_after_unit: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Orb::Models::Customers::Credits::TopUpListResponse} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param amount [String] The amount to increment when the threshold is reached.
+          #
+          #   @param currency [String] The currency or custom pricing unit to use for this top-up. If this is a real-wo
+          #   ...
+          #
+          #   @param invoice_settings [Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings] Settings for invoices generated by triggered top-ups.
+          #
+          #   @param per_unit_cost_basis [String] How much, in the customer's currency, to charge for each unit.
+          #
+          #   @param threshold [String] The threshold at which to trigger the top-up. If the balance is at or below this
+          #   ...
+          #
+          #   @param expires_after [Integer, nil] The number of days or months after which the top-up expires. If unspecified, it
+          #   ...
+          #
+          #   @param expires_after_unit [Symbol, Orb::Models::Customers::Credits::TopUpListResponse::ExpiresAfterUnit, nil] The unit of expires_after.
 
           # @see Orb::Models::Customers::Credits::TopUpListResponse#invoice_settings
           class InvoiceSettings < Orb::Internal::Type::BaseModel
@@ -107,28 +104,30 @@ module Orb
             #   @return [String, nil]
             optional :memo, String, nil?: true
 
-            # @!attribute [r] require_successful_payment
+            # @!attribute require_successful_payment
             #   If true, new credit blocks created by this top-up will require that the
             #   corresponding invoice is paid before they can be drawn down from.
             #
             #   @return [Boolean, nil]
             optional :require_successful_payment, Orb::Internal::Type::Boolean
 
-            # @!parse
-            #   # @return [Boolean]
-            #   attr_writer :require_successful_payment
-
-            # @!parse
-            #   # Settings for invoices generated by triggered top-ups.
-            #   #
-            #   # @param auto_collection [Boolean]
-            #   # @param net_terms [Integer]
-            #   # @param memo [String, nil]
-            #   # @param require_successful_payment [Boolean]
-            #   #
-            #   def initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil, **) = super
-
-            # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+            # @!method initialize(auto_collection:, net_terms:, memo: nil, require_successful_payment: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Orb::Models::Customers::Credits::TopUpListResponse::InvoiceSettings} for more
+            #   details.
+            #
+            #   Settings for invoices generated by triggered top-ups.
+            #
+            #   @param auto_collection [Boolean] Whether the credits purchase invoice should auto collect with the customer's sav
+            #   ...
+            #
+            #   @param net_terms [Integer] The net terms determines the difference between the invoice date and the issue d
+            #   ...
+            #
+            #   @param memo [String, nil] An optional memo to display on the invoice.
+            #
+            #   @param require_successful_payment [Boolean] If true, new credit blocks created by this top-up will require that the correspo
+            #   ...
           end
 
           # The unit of expires_after.
@@ -140,11 +139,8 @@ module Orb
             DAY = :day
             MONTH = :month
 
-            finalize!
-
-            # @!parse
-            #   # @return [Array<Symbol>]
-            #   def self.values; end
+            # @!method self.values
+            #   @return [Array<Symbol>]
           end
         end
       end

data/lib/orb/models/dimensional_price_group.rb

@@ -44,21 +44,27 @@ module Orb
       #   @return [String]
       required :name, String
 
-      # @!parse
-      #   # A dimensional price group is used to partition the result of a billable metric
-      #   # by a set of dimensions. Prices in a price group must specify the parition used
-      #   # to derive their usage.
-      #   #
-      #   # @param id [String]
-      #   # @param billable_metric_id [String]
-      #   # @param dimensions [Array<String>]
-      #   # @param external_dimensional_price_group_id [String, nil]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String]
-      #   #
-      #   def initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, billable_metric_id:, dimensions:, external_dimensional_price_group_id:, metadata:, name:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::DimensionalPriceGroup} for more details.
+      #
+      #   A dimensional price group is used to partition the result of a billable metric
+      #   by a set of dimensions. Prices in a price group must specify the parition used
+      #   to derive their usage.
+      #
+      #   @param id [String]
+      #
+      #   @param billable_metric_id [String] The billable metric associated with this dimensional price group. All prices ass
+      #   ...
+      #
+      #   @param dimensions [Array<String>] The dimensions that this dimensional price group is defined over
+      #
+      #   @param external_dimensional_price_group_id [String, nil] An alias for the dimensional price group
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #   ...
+      #
+      #   @param name [String] The name of the dimensional price group
     end
   end
 end

data/lib/orb/models/dimensional_price_group_create_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::DimensionalPriceGroups#create
     class DimensionalPriceGroupCreateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute billable_metric_id
@@ -37,27 +36,22 @@ module Orb
       #   @return [Hash{Symbol=>String, nil}, nil]
       optional :metadata, Orb::Internal::Type::HashOf[String, nil?: true], nil?: true
 
-      # @!parse
-      #   # @param billable_metric_id [String]
-      #   # @param dimensions [Array<String>]
-      #   # @param name [String]
-      #   # @param external_dimensional_price_group_id [String, nil]
-      #   # @param metadata [Hash{Symbol=>String, nil}, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(
-      #     billable_metric_id:,
-      #     dimensions:,
-      #     name:,
-      #     external_dimensional_price_group_id: nil,
-      #     metadata: nil,
-      #     request_options: {},
-      #     **
-      #   )
-      #     super
-      #   end
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(billable_metric_id:, dimensions:, name:, external_dimensional_price_group_id: nil, metadata: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::DimensionalPriceGroupCreateParams} for more details.
+      #
+      #   @param billable_metric_id [String]
+      #
+      #   @param dimensions [Array<String>] The set of keys (in order) used to disambiguate prices in the group.
+      #
+      #   @param name [String]
+      #
+      #   @param external_dimensional_price_group_id [String, nil]
+      #
+      #   @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
 end

data/lib/orb/models/dimensional_price_group_list_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::DimensionalPriceGroups#list
     class DimensionalPriceGroupListParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute cursor
@@ -15,24 +14,22 @@ module Orb
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
-      # @!attribute [r] limit
+      # @!attribute limit
       #   The number of items to fetch. Defaults to 20.
       #
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!parse
-      #   # @return [Integer]
-      #   attr_writer :limit
-
-      # @!parse
-      #   # @param cursor [String, nil]
-      #   # @param limit [Integer]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::DimensionalPriceGroupListParams} for more details.
+      #
+      #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   ...
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/dimensional_price_group_retrieve_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::DimensionalPriceGroups#retrieve
     class DimensionalPriceGroupRetrieveParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params.rb

@@ -5,16 +5,11 @@ module Orb
     module DimensionalPriceGroups
       # @see Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID#retrieve
       class ExternalDimensionalPriceGroupIDRetrieveParams < Orb::Internal::Type::BaseModel
-        # @!parse
-        #   extend Orb::Internal::Type::RequestParameters::Converter
+        extend Orb::Internal::Type::RequestParameters::Converter
         include Orb::Internal::Type::RequestParameters
 
-        # @!parse
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(request_options: {})
+        #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end

data/lib/orb/models/dimensional_price_groups.rb

@@ -13,13 +13,9 @@ module Orb
       #   @return [Orb::Models::PaginationMetadata]
       required :pagination_metadata, -> { Orb::Models::PaginationMetadata }
 
-      # @!parse
-      #   # @param data [Array<Orb::Models::DimensionalPriceGroup>]
-      #   # @param pagination_metadata [Orb::Models::PaginationMetadata]
-      #   #
-      #   def initialize(data:, pagination_metadata:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(data:, pagination_metadata:)
+      #   @param data [Array<Orb::Models::DimensionalPriceGroup>]
+      #   @param pagination_metadata [Orb::Models::PaginationMetadata]
     end
   end
 end

data/lib/orb/models/discount.rb

@@ -15,9 +15,8 @@ module Orb
 
       variant :amount, -> { Orb::Models::AmountDiscount }
 
-      # @!parse
-      #   # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
-      #   def self.variants; end
+      # @!method self.variants
+      #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::TrialDiscount, Orb::Models::UsageDiscount, Orb::Models::AmountDiscount)]
     end
   end
 end

data/lib/orb/models/evaluate_price_group.rb

@@ -22,14 +22,12 @@ module Orb
       #   @return [Float]
       required :quantity, Float
 
-      # @!parse
-      #   # @param amount [String]
-      #   # @param grouping_values [Array<String, Float, Boolean>]
-      #   # @param quantity [Float]
-      #   #
-      #   def initialize(amount:, grouping_values:, quantity:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount:, grouping_values:, quantity:)
+      #   @param amount [String] The price's output for the group
+      #
+      #   @param grouping_values [Array<String, Float, Boolean>] The values for the group in the order specified by `grouping_keys`
+      #
+      #   @param quantity [Float] The price's usage quantity for the group
 
       module GroupingValue
         extend Orb::Internal::Type::Union
@@ -40,9 +38,8 @@ module Orb
 
         variant Orb::Internal::Type::Boolean
 
-        # @!parse
-        #   # @return [Array(String, Float, Boolean)]
-        #   def self.variants; end
+        # @!method self.variants
+        #   @return [Array(String, Float, Boolean)]
       end
     end
   end

data/lib/orb/models/event_deprecate_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::Events#deprecate
     class EventDeprecateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
-      # @!parse
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(request_options: {})
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/event_deprecate_response.rb

@@ -10,12 +10,8 @@ module Orb
       #   @return [String]
       required :deprecated, String
 
-      # @!parse
-      #   # @param deprecated [String]
-      #   #
-      #   def initialize(deprecated:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(deprecated:)
+      #   @param deprecated [String] event_id of the deprecated event, if successfully updated
     end
   end
 end