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

data/lib/metronome_sdk/models/v1/contract_retrieve_params.rb

@@ -41,10 +41,8 @@ module MetronomeSDK
         #   @param customer_id [String]
         #
         #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
-        #   ...
         #
         #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_params.rb

@@ -45,7 +45,9 @@ module MetronomeSDK
         #
         #   @return [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>, nil]
         optional :selectors,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector] }
+                 -> {
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector]
+                 }
 
         # @!method initialize(contract_id:, customer_id:, limit: nil, next_page: nil, at: nil, selectors: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
@@ -60,14 +62,22 @@ module MetronomeSDK
         #   @param next_page [String] Cursor that indicates where the next page of results should start.
         #
         #   @param at [Time] optional timestamp which overlaps with the returned rate schedule segments. When
-        #   ...
         #
         #   @param selectors [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>] List of rate selectors, rates matching ANY of the selectors will be included in
-        #   ...
         #
         #   @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::ContractRetrieveRateScheduleParams::Selector::BillingFrequency, nil]
+          optional :billing_frequency,
+                   enum: -> {
+                     MetronomeSDK::V1::ContractRetrieveRateScheduleParams::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.
@@ -95,21 +105,36 @@ module MetronomeSDK
           #   @return [Array<String>, nil]
           optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
 
-          # @!method initialize(partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
+          # @!method initialize(billing_frequency: nil, partial_pricing_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector} for
           #   more details.
           #
+          #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::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.
           #
           #   @param product_tags [Array<String>] List of product tags, rates matching any of the tags will be included in the res
-          #   ...
+
+          # Subscription rates matching the billing frequency will be included in the
+          # response.
+          #
+          # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::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

data/lib/metronome_sdk/models/v1/contract_retrieve_rate_schedule_response.rb

@@ -28,8 +28,8 @@ module MetronomeSDK
 
           # @!attribute list_rate
           #
-          #   @return [MetronomeSDK::Models::Rate]
-          required :list_rate, -> { MetronomeSDK::Models::Rate }
+          #   @return [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate]
+          required :list_rate, -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate }
 
           # @!attribute product_custom_fields
           #
@@ -61,6 +61,12 @@ module MetronomeSDK
           #   @return [Time]
           required :starting_at, Time
 
+          # @!attribute billing_frequency
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::BillingFrequency, nil]
+          optional :billing_frequency,
+                   enum: -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::BillingFrequency }
+
           # @!attribute commit_rate
           #   A distinct rate on the rate card. You can choose to use this rate rather than
           #   list rate when consuming a credit or commit.
@@ -76,22 +82,23 @@ module MetronomeSDK
 
           # @!attribute override_rate
           #
-          #   @return [MetronomeSDK::Models::Rate, nil]
-          optional :override_rate, -> { MetronomeSDK::Models::Rate }
+          #   @return [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate, nil]
+          optional :override_rate,
+                   -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate }
 
           # @!attribute pricing_group_values
           #
           #   @return [Hash{Symbol=>String}, nil]
           optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
 
-          # @!method initialize(entitled:, list_rate:, product_custom_fields:, product_id:, product_name:, product_tags:, rate_card_id:, starting_at:, commit_rate: nil, ending_before: nil, override_rate: nil, pricing_group_values: nil)
+          # @!method initialize(entitled:, list_rate:, product_custom_fields:, product_id:, product_name:, product_tags:, rate_card_id:, starting_at:, billing_frequency: nil, commit_rate: nil, ending_before: nil, override_rate: nil, pricing_group_values: nil)
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data} for more
           #   details.
           #
           #   @param entitled [Boolean]
           #
-          #   @param list_rate [MetronomeSDK::Models::Rate]
+          #   @param list_rate [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate]
           #
           #   @param product_custom_fields [Hash{Symbol=>String}]
           #
@@ -105,15 +112,163 @@ module MetronomeSDK
           #
           #   @param starting_at [Time]
           #
+          #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::BillingFrequency]
+          #
           #   @param commit_rate [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
-          #   ...
           #
           #   @param ending_before [Time]
           #
-          #   @param override_rate [MetronomeSDK::Models::Rate]
+          #   @param override_rate [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate]
           #
           #   @param pricing_group_values [Hash{Symbol=>String}]
 
+          # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data#list_rate
+          class ListRate < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute rate_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::RateType]
+            required :rate_type,
+                     enum: -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::RateType }
+
+            # @!attribute credit_type
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::CreditType, nil]
+            optional :credit_type,
+                     -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::CreditType }
+
+            # @!attribute custom_rate
+            #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+            #   processors.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+            # @!attribute is_prorated
+            #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+            #   set to true.
+            #
+            #   @return [Boolean, nil]
+            optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+            # @!attribute price
+            #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+            #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+            #
+            #   @return [Float, nil]
+            optional :price, Float
+
+            # @!attribute pricing_group_values
+            #   if pricing groups are used, this will contain the values used to calculate the
+            #   price
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!attribute quantity
+            #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+            #
+            #   @return [Float, nil]
+            optional :quantity, Float
+
+            # @!attribute tiers
+            #   Only set for TIERED rate_type.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::Tier>, nil]
+            optional :tiers,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::Tier] }
+
+            # @!attribute use_list_prices
+            #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+            #   using list prices rather than the standard rates for this product on the
+            #   contract.
+            #
+            #   @return [Boolean, nil]
+            optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
+
+            # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate}
+            #   for more details.
+            #
+            #   @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::RateType]
+            #
+            #   @param credit_type [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::CreditType]
+            #
+            #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+            #
+            #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+            #
+            #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+            #
+            #   @param pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
+            #
+            #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+            #
+            #   @param tiers [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate::Tier>] Only set for TIERED rate_type.
+            #
+            #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+
+            # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate#rate_type
+            module RateType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              FLAT = :FLAT
+              PERCENTAGE = :PERCENTAGE
+              SUBSCRIPTION = :SUBSCRIPTION
+              CUSTOM = :CUSTOM
+              TIERED = :TIERED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::ListRate#credit_type
+            class CreditType < 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
+
+            class Tier < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute price
+              #
+              #   @return [Float]
+              required :price, Float
+
+              # @!attribute size
+              #
+              #   @return [Float, nil]
+              optional :size, Float
+
+              # @!method initialize(price:, size: nil)
+              #   @param price [Float]
+              #   @param size [Float]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data#billing_frequency
+          module BillingFrequency
+            extend MetronomeSDK::Internal::Type::Enum
+
+            MONTHLY = :MONTHLY
+            QUARTERLY = :QUARTERLY
+            ANNUAL = :ANNUAL
+            WEEKLY = :WEEKLY
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data#commit_rate
           class CommitRate < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute rate_type
@@ -131,8 +286,9 @@ module MetronomeSDK
             # @!attribute tiers
             #   Only set for TIERED rate_type.
             #
-            #   @return [Array<MetronomeSDK::Models::Tier>, nil]
-            optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Tier] }
+            #   @return [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::Tier>, nil]
+            optional :tiers,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::Tier] }
 
             # @!method initialize(rate_type:, price: nil, tiers: nil)
             #   A distinct rate on the rate card. You can choose to use this rate rather than
@@ -142,7 +298,7 @@ module MetronomeSDK
             #
             #   @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
             #
-            #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+            #   @param tiers [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate::Tier>] Only set for TIERED rate_type.
 
             # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate#rate_type
             module RateType
@@ -157,6 +313,156 @@ module MetronomeSDK
               # @!method self.values
               #   @return [Array<Symbol>]
             end
+
+            class Tier < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute price
+              #
+              #   @return [Float]
+              required :price, Float
+
+              # @!attribute size
+              #
+              #   @return [Float, nil]
+              optional :size, Float
+
+              # @!method initialize(price:, size: nil)
+              #   @param price [Float]
+              #   @param size [Float]
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data#override_rate
+          class OverrideRate < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute rate_type
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::RateType]
+            required :rate_type,
+                     enum: -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::RateType }
+
+            # @!attribute credit_type
+            #
+            #   @return [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::CreditType, nil]
+            optional :credit_type,
+                     -> { MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::CreditType }
+
+            # @!attribute custom_rate
+            #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+            #   processors.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+            # @!attribute is_prorated
+            #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+            #   set to true.
+            #
+            #   @return [Boolean, nil]
+            optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+            # @!attribute price
+            #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+            #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+            #
+            #   @return [Float, nil]
+            optional :price, Float
+
+            # @!attribute pricing_group_values
+            #   if pricing groups are used, this will contain the values used to calculate the
+            #   price
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!attribute quantity
+            #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+            #
+            #   @return [Float, nil]
+            optional :quantity, Float
+
+            # @!attribute tiers
+            #   Only set for TIERED rate_type.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::Tier>, nil]
+            optional :tiers,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::Tier] }
+
+            # @!attribute use_list_prices
+            #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+            #   using list prices rather than the standard rates for this product on the
+            #   contract.
+            #
+            #   @return [Boolean, nil]
+            optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
+
+            # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate}
+            #   for more details.
+            #
+            #   @param rate_type [Symbol, MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::RateType]
+            #
+            #   @param credit_type [MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::CreditType]
+            #
+            #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+            #
+            #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+            #
+            #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+            #
+            #   @param pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
+            #
+            #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+            #
+            #   @param tiers [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate::Tier>] Only set for TIERED rate_type.
+            #
+            #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+
+            # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate#rate_type
+            module RateType
+              extend MetronomeSDK::Internal::Type::Enum
+
+              FLAT = :FLAT
+              PERCENTAGE = :PERCENTAGE
+              SUBSCRIPTION = :SUBSCRIPTION
+              CUSTOM = :CUSTOM
+              TIERED = :TIERED
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::OverrideRate#credit_type
+            class CreditType < 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
+
+            class Tier < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute price
+              #
+              #   @return [Float]
+              required :price, Float
+
+              # @!attribute size
+              #
+              #   @return [Float, nil]
+              optional :size, Float
+
+              # @!method initialize(price:, size: nil)
+              #   @param price [Float]
+              #   @param size [Float]
+            end
           end
         end
       end