metronome-sdk 0.1.0.pre.alpha.2 → 0.1.0.pre.alpha.4

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

@@ -43,7 +43,7 @@ module MetronomeSDK
         #   List of rate selectors, rates matching ANY of the selectors will be included in
         #   the response. Passing no selectors will result in all rates being returned.
         #
-        #   @return [Array<MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector>, nil]
+        #   @return [Array<MetronomeSDK::Models::V1::ContractRetrieveRateScheduleParams::Selector>, nil]
         optional :selectors,
                  -> {
                    MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector]
@@ -63,11 +63,21 @@ module MetronomeSDK
         #
         #   @param at [Time] optional timestamp which overlaps with the returned rate schedule segments. When
         #
-        #   @param selectors [Array<MetronomeSDK::V1::ContractRetrieveRateScheduleParams::Selector>] List of rate selectors, rates matching ANY of the selectors will be included in
+        #   @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,10 +105,12 @@ 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::V1::ContractRetrieveRateScheduleParams::Selector} for more
-          #   details.
+          #   {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
           #
@@ -107,6 +119,22 @@ module MetronomeSDK
           #   @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,7 +28,7 @@ module MetronomeSDK
 
           # @!attribute list_rate
           #
-          #   @return [MetronomeSDK::Rate]
+          #   @return [MetronomeSDK::Models::Rate]
           required :list_rate, -> { MetronomeSDK::Rate }
 
           # @!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,7 +82,7 @@ module MetronomeSDK
 
           # @!attribute override_rate
           #
-          #   @return [MetronomeSDK::Rate, nil]
+          #   @return [MetronomeSDK::Models::Rate, nil]
           optional :override_rate, -> { MetronomeSDK::Rate }
 
           # @!attribute pricing_group_values
@@ -84,14 +90,14 @@ module MetronomeSDK
           #   @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::Rate]
+          #   @param list_rate [MetronomeSDK::Models::Rate]
           #
           #   @param product_custom_fields [Hash{Symbol=>String}]
           #
@@ -105,14 +111,29 @@ 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::Rate]
+          #   @param override_rate [MetronomeSDK::Models::Rate]
           #
           #   @param pricing_group_values [Hash{Symbol=>String}]
 
+          # @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
@@ -130,7 +151,7 @@ module MetronomeSDK
             # @!attribute tiers
             #   Only set for TIERED rate_type.
             #
-            #   @return [Array<MetronomeSDK::Tier>, nil]
+            #   @return [Array<MetronomeSDK::Models::Tier>, nil]
             optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
 
             # @!method initialize(rate_type:, price: nil, tiers: nil)
@@ -141,7 +162,7 @@ module MetronomeSDK
             #
             #   @param price [Float] Commit rate price. For FLAT rate_type, this must be >=0.
             #
-            #   @param tiers [Array<MetronomeSDK::Tier>] Only set for TIERED rate_type.
+            #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
 
             # @see MetronomeSDK::Models::V1::ContractRetrieveRateScheduleResponse::Data::CommitRate#rate_type
             module RateType