metronome-sdk 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/lib/metronome_sdk/models/v1/contracts/product_update_params.rb

@@ -104,8 +104,10 @@ module MetronomeSDK
           #   GB. In this case, the conversion factor would be 1024 and the operation would be
           #   "divide".
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil]
-          optional :quantity_conversion, -> { MetronomeSDK::Models::V1::Contracts::QuantityConversion }, nil?: true
+          #   @return [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion, nil]
+          optional :quantity_conversion,
+                   -> { MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityConversion },
+                   nil?: true
 
           # @!attribute quantity_rounding
           #   Optional. Only valid for USAGE products. If provided, the quantity will be
@@ -113,8 +115,10 @@ module MetronomeSDK
           #   the method is "round up" and the decimal places is 0, then the quantity will be
           #   rounded up to the nearest integer.
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
-          optional :quantity_rounding, -> { MetronomeSDK::Models::V1::Contracts::QuantityRounding }, nil?: true
+          #   @return [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding, nil]
+          optional :quantity_rounding,
+                   -> { MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityRounding },
+                   nil?: true
 
           # @!attribute tags
           #   If not provided, defaults to product's current tags
@@ -129,46 +133,121 @@ module MetronomeSDK
           #   @param product_id [String] ID of the product to update
           #
           #   @param starting_at [Time] Timestamp representing when the update should go into effect. It must be on an h
-          #   ...
           #
           #   @param billable_metric_id [String] Available for USAGE products only. If not provided, defaults to product's curren
-          #   ...
           #
           #   @param composite_product_ids [Array<String>] Available for COMPOSITE products only. If not provided, defaults to product's cu
-          #   ...
           #
           #   @param composite_tags [Array<String>] Available for COMPOSITE products only. If not provided, defaults to product's cu
-          #   ...
           #
           #   @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
-          #   ...
           #
           #   @param is_refundable [Boolean] Defaults to product's current refundability status. This field's availability is
-          #   ...
           #
           #   @param name [String] displayed on invoices. If not provided, defaults to product's current name.
           #
           #   @param netsuite_internal_item_id [String] If not provided, defaults to product's current netsuite_internal_item_id. This f
-          #   ...
           #
           #   @param netsuite_overage_item_id [String] Available for USAGE and COMPOSITE products only. If not provided, defaults to pr
-          #   ...
           #
           #   @param presentation_group_key [Array<String>] For USAGE products only. Groups usage line items on invoices. The superset of va
-          #   ...
           #
           #   @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
-          #   ...
           #
-          #   @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
-          #   ...
+          #   @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
           #
-          #   @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
-          #   ...
+          #   @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
           #
           #   @param tags [Array<String>] If not provided, defaults to product's current tags
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+          class QuantityConversion < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute conversion_factor
+            #   The factor to multiply or divide the quantity by.
+            #
+            #   @return [Float]
+            required :conversion_factor, Float
+
+            # @!attribute operation
+            #   The operation to perform on the quantity
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion::Operation]
+            required :operation,
+                     enum: -> {
+                       MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityConversion::Operation
+                     }
+
+            # @!attribute name
+            #   Optional name for this conversion.
+            #
+            #   @return [String, nil]
+            optional :name, String
+
+            # @!method initialize(conversion_factor:, operation:, name: nil)
+            #   Optional. Only valid for USAGE products. If provided, the quantity will be
+            #   converted using the provided conversion factor and operation. For example, if
+            #   the operation is "multiply" and the conversion factor is 100, then the quantity
+            #   will be multiplied by 100. This can be used in cases where data is sent in one
+            #   unit and priced in another. For example, data could be sent in MB and priced in
+            #   GB. In this case, the conversion factor would be 1024 and the operation would be
+            #   "divide".
+            #
+            #   @param conversion_factor [Float] The factor to multiply or divide the quantity by.
+            #
+            #   @param operation [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion::Operation] The operation to perform on the quantity
+            #
+            #   @param name [String] Optional name for this conversion.
+
+            # The operation to perform on the quantity
+            #
+            # @see MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityConversion#operation
+            module Operation
+              extend MetronomeSDK::Internal::Type::Enum
+
+              MULTIPLY = :MULTIPLY
+              DIVIDE = :DIVIDE
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute decimal_places
+            #
+            #   @return [Float]
+            required :decimal_places, Float
+
+            # @!attribute rounding_method
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding::RoundingMethod]
+            required :rounding_method,
+                     enum: -> {
+                       MetronomeSDK::V1::Contracts::ProductUpdateParams::QuantityRounding::RoundingMethod
+                     }
+
+            # @!method initialize(decimal_places:, rounding_method:)
+            #   Optional. Only valid for USAGE products. If provided, the quantity will be
+            #   rounded using the provided rounding method and decimal places. For example, if
+            #   the method is "round up" and the decimal places is 0, then the quantity will be
+            #   rounded up to the nearest integer.
+            #
+            #   @param decimal_places [Float]
+            #   @param rounding_method [Symbol, MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding::RoundingMethod]
+
+            # @see MetronomeSDK::Models::V1::Contracts::ProductUpdateParams::QuantityRounding#rounding_method
+            module RoundingMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              ROUND_UP = :ROUND_UP
+              ROUND_DOWN = :ROUND_DOWN
+              ROUND_HALF_UP = :ROUND_HALF_UP
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
       end
     end

data/lib/metronome_sdk/models/v1/contracts/product_update_response.rb

@@ -8,11 +8,22 @@ module MetronomeSDK
         class ProductUpdateResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::Models::ID]
-          required :data, -> { MetronomeSDK::Models::ID }
+          #   @return [MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse::Data]
+          required :data, -> { MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse::Data }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::Models::ID]
+          #   @param data [MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse::Data]
+
+          # @see MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse#data
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   @param id [String]
+          end
         end
       end
     end

data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        # @see MetronomeSDK::Resources::V1::Contracts::RateCards#archive
+        class RateCardArchiveParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:, request_options: {})
+          #   @param id [String]
+          #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/contracts/rate_card_archive_response.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Contracts
+        # @see MetronomeSDK::Resources::V1::Contracts::RateCards#archive
+        class RateCardArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [MetronomeSDK::Models::V1::Contracts::RateCardArchiveResponse::Data]
+          required :data, -> { MetronomeSDK::Models::V1::Contracts::RateCardArchiveResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [MetronomeSDK::Models::V1::Contracts::RateCardArchiveResponse::Data]
+
+          # @see MetronomeSDK::Models::V1::Contracts::RateCardArchiveResponse#data
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   @param id [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/contracts/rate_card_create_params.rb

@@ -22,14 +22,18 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>, nil]
           optional :aliases,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias] }
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardCreateParams::Alias]
+                   }
 
           # @!attribute credit_type_conversions
           #   Required when using custom pricing units in rates.
           #
           #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>, nil]
           optional :credit_type_conversions,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion] }
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardCreateParams::CreditTypeConversion]
+                   }
 
           # @!attribute custom_fields
           #
@@ -55,7 +59,6 @@ module MetronomeSDK
           #   @param name [String] Used only in UI/API. It is not exposed to end customers.
           #
           #   @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
-          #   ...
           #
           #   @param credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardCreateParams::CreditTypeConversion>] Required when using custom pricing units in rates.
           #
@@ -64,7 +67,6 @@ module MetronomeSDK
           #   @param description [String]
           #
           #   @param fiat_credit_type_id [String] The Metronome ID of the credit type to associate with the rate card, defaults to
-          #   ...
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/metronome_sdk/models/v1/contracts/rate_card_create_response.rb

@@ -8,11 +8,22 @@ module MetronomeSDK
         class RateCardCreateResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::Models::ID]
-          required :data, -> { MetronomeSDK::Models::ID }
+          #   @return [MetronomeSDK::Models::V1::Contracts::RateCardCreateResponse::Data]
+          required :data, -> { MetronomeSDK::Models::V1::Contracts::RateCardCreateResponse::Data }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::Models::ID]
+          #   @param data [MetronomeSDK::Models::V1::Contracts::RateCardCreateResponse::Data]
+
+          # @see MetronomeSDK::Models::V1::Contracts::RateCardCreateResponse#data
+          class Data < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   @param id [String]
+          end
         end
       end
     end

data/lib/metronome_sdk/models/v1/contracts/rate_card_list_response.rb

@@ -50,8 +50,9 @@ module MetronomeSDK
 
           # @!attribute fiat_credit_type
           #
-          #   @return [MetronomeSDK::Models::CreditTypeData, nil]
-          optional :fiat_credit_type, -> { MetronomeSDK::Models::CreditTypeData }
+          #   @return [MetronomeSDK::Models::V1::Contracts::RateCardListResponse::FiatCreditType, nil]
+          optional :fiat_credit_type,
+                   -> { MetronomeSDK::Models::V1::Contracts::RateCardListResponse::FiatCreditType }
 
           # @!method initialize(id:, created_at:, created_by:, name:, aliases: nil, credit_type_conversions: nil, custom_fields: nil, description: nil, fiat_credit_type: nil)
           #   @param id [String]
@@ -62,7 +63,7 @@ module MetronomeSDK
           #   @param credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardListResponse::CreditTypeConversion>]
           #   @param custom_fields [Hash{Symbol=>String}]
           #   @param description [String]
-          #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
+          #   @param fiat_credit_type [MetronomeSDK::Models::V1::Contracts::RateCardListResponse::FiatCreditType]
 
           class Alias < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute name
@@ -89,8 +90,9 @@ module MetronomeSDK
           class CreditTypeConversion < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute custom_credit_type
             #
-            #   @return [MetronomeSDK::Models::CreditTypeData]
-            required :custom_credit_type, -> { MetronomeSDK::Models::CreditTypeData }
+            #   @return [MetronomeSDK::Models::V1::Contracts::RateCardListResponse::CreditTypeConversion::CustomCreditType]
+            required :custom_credit_type,
+                     -> { MetronomeSDK::Models::V1::Contracts::RateCardListResponse::CreditTypeConversion::CustomCreditType }
 
             # @!attribute fiat_per_custom_credit
             #
@@ -98,8 +100,42 @@ module MetronomeSDK
             required :fiat_per_custom_credit, String
 
             # @!method initialize(custom_credit_type:, fiat_per_custom_credit:)
-            #   @param custom_credit_type [MetronomeSDK::Models::CreditTypeData]
+            #   @param custom_credit_type [MetronomeSDK::Models::V1::Contracts::RateCardListResponse::CreditTypeConversion::CustomCreditType]
             #   @param fiat_per_custom_credit [String]
+
+            # @see MetronomeSDK::Models::V1::Contracts::RateCardListResponse::CreditTypeConversion#custom_credit_type
+            class CustomCreditType < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!method initialize(id:, name:)
+              #   @param id [String]
+              #   @param name [String]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::Contracts::RateCardListResponse#fiat_credit_type
+          class FiatCreditType < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute name
+            #
+            #   @return [String]
+            required :name, String
+
+            # @!method initialize(id:, name:)
+            #   @param id [String]
+            #   @param name [String]
           end
         end
       end

data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_params.rb

@@ -5,11 +5,17 @@ module MetronomeSDK
     module V1
       module Contracts
         # @see MetronomeSDK::Resources::V1::Contracts::RateCards#retrieve
-        class RateCardRetrieveParams < MetronomeSDK::Models::ID
+        class RateCardRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
           extend MetronomeSDK::Internal::Type::RequestParameters::Converter
           include MetronomeSDK::Internal::Type::RequestParameters
 
-          # @!method initialize(request_options: {})
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:, request_options: {})
+          #   @param id [String]
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
         end
       end

data/lib/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rb

@@ -46,7 +46,9 @@ module MetronomeSDK
           #
           #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>, nil]
           optional :selectors,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector] }
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector]
+                   }
 
           # @!method initialize(rate_card_id:, starting_at:, limit: nil, next_page: nil, ending_before: nil, selectors: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
@@ -62,14 +64,22 @@ module MetronomeSDK
           #   @param next_page [String] Cursor that indicates where the next page of results should start.
           #
           #   @param ending_before [Time] optional exclusive end date for the rates schedule. When not specified rates wil
-          #   ...
           #
           #   @param selectors [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] List of rate selectors, rates matching ANY of the selector will be included in t
-          #   ...
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
           class Selector < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute billing_frequency
+            #   Subscription rates matching the billing frequency will be included in the
+            #   response.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency, nil]
+            optional :billing_frequency,
+                     enum: -> {
+                       MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency
+                     }
+
             # @!attribute partial_pricing_group_values
             #   List of pricing group key value pairs, rates containing the matching key / value
             #   pairs will be included in the response.
@@ -90,18 +100,34 @@ module MetronomeSDK
             #   @return [String, nil]
             optional :product_id, String
 
-            # @!method initialize(partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil)
+            # @!method initialize(billing_frequency: nil, partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector}
             #   for more details.
             #
+            #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency] Subscription rates matching the billing frequency will be included in the respon
+            #
             #   @param partial_pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates containing the matching key / value
-            #   ...
             #
             #   @param pricing_group_values [Hash{Symbol=>String}] List of pricing group key value pairs, rates matching all of the key / value pai
-            #   ...
             #
             #   @param product_id [String] Rates matching the product id will be included in the response.
+
+            # Subscription rates matching the billing frequency will be included in the
+            # response.
+            #
+            # @see MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector#billing_frequency
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              MONTHLY = :MONTHLY
+              QUARTERLY = :QUARTERLY
+              ANNUAL = :ANNUAL
+              WEEKLY = :WEEKLY
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
           end
         end
       end