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

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

@@ -44,7 +44,7 @@ module MetronomeSDK
           #   List of rate selectors, rates matching ANY of the selector will be included in
           #   the response Passing no selectors will result in all rates being returned.
           #
-          #   @return [Array<MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>, nil]
+          #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>, nil]
           optional :selectors,
                    -> {
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector]
@@ -65,11 +65,21 @@ module MetronomeSDK
           #
           #   @param ending_before [Time] optional exclusive end date for the rates schedule. When not specified rates wil
           #
-          #   @param selectors [Array<MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector>] List of rate selectors, rates matching ANY of the selector will be included in t
+          #   @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,16 +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::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector} for
-            #   more details.
+            #   {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

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

@@ -49,7 +49,7 @@ module MetronomeSDK
 
             # @!attribute rate
             #
-            #   @return [MetronomeSDK::Rate]
+            #   @return [MetronomeSDK::Models::Rate]
             required :rate, -> { MetronomeSDK::Rate }
 
             # @!attribute starting_at
@@ -57,6 +57,12 @@ module MetronomeSDK
             #   @return [Time]
             required :starting_at, Time
 
+            # @!attribute billing_frequency
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency, nil]
+            optional :billing_frequency,
+                     enum: -> { MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::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.
@@ -75,7 +81,7 @@ module MetronomeSDK
             #   @return [Hash{Symbol=>String}, nil]
             optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
 
-            # @!method initialize(entitled:, product_custom_fields:, product_id:, product_name:, product_tags:, rate:, starting_at:, commit_rate: nil, ending_before: nil, pricing_group_values: nil)
+            # @!method initialize(entitled:, product_custom_fields:, product_id:, product_name:, product_tags:, rate:, starting_at:, billing_frequency: nil, commit_rate: nil, ending_before: nil, pricing_group_values: nil)
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data}
             #   for more details.
@@ -90,16 +96,31 @@ module MetronomeSDK
             #
             #   @param product_tags [Array<String>]
             #
-            #   @param rate [MetronomeSDK::Rate]
+            #   @param rate [MetronomeSDK::Models::Rate]
             #
             #   @param starting_at [Time]
             #
+            #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency]
+            #
             #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
             #
             #   @param ending_before [Time]
             #
             #   @param pricing_group_values [Hash{Symbol=>String}]
 
+            # @see MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::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::Contracts::RateCardRetrieveRateScheduleResponse::Data#commit_rate
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute rate_type
@@ -117,7 +138,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)
@@ -128,7 +149,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::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate#rate_type
               module RateType

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

@@ -60,7 +60,7 @@ module MetronomeSDK
 
             # @!attribute fiat_credit_type
             #
-            #   @return [MetronomeSDK::CreditTypeData, nil]
+            #   @return [MetronomeSDK::Models::CreditTypeData, nil]
             optional :fiat_credit_type, -> { MetronomeSDK::CreditTypeData }
 
             # @!method initialize(id:, created_at:, created_by:, name:, aliases: nil, credit_type_conversions: nil, custom_fields: nil, description: nil, fiat_credit_type: nil)
@@ -72,7 +72,7 @@ module MetronomeSDK
             #   @param credit_type_conversions [Array<MetronomeSDK::Models::V1::Contracts::RateCardRetrieveResponse::Data::CreditTypeConversion>]
             #   @param custom_fields [Hash{Symbol=>String}]
             #   @param description [String]
-            #   @param fiat_credit_type [MetronomeSDK::CreditTypeData]
+            #   @param fiat_credit_type [MetronomeSDK::Models::CreditTypeData]
 
             class Alias < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute name
@@ -99,7 +99,7 @@ module MetronomeSDK
             class CreditTypeConversion < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute custom_credit_type
               #
-              #   @return [MetronomeSDK::CreditTypeData]
+              #   @return [MetronomeSDK::Models::CreditTypeData]
               required :custom_credit_type, -> { MetronomeSDK::CreditTypeData }
 
               # @!attribute fiat_per_custom_credit
@@ -108,7 +108,7 @@ module MetronomeSDK
               required :fiat_per_custom_credit, String
 
               # @!method initialize(custom_credit_type:, fiat_per_custom_credit:)
-              #   @param custom_credit_type [MetronomeSDK::CreditTypeData]
+              #   @param custom_credit_type [MetronomeSDK::Models::CreditTypeData]
               #   @param fiat_per_custom_credit [String]
             end
           end

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

@@ -20,7 +20,7 @@ module MetronomeSDK
           #   multiple rate cards, it will reference the rate card to which it was most
           #   recently assigned. It is not exposed to end customers.
           #
-          #   @return [Array<MetronomeSDK::V1::Contracts::RateCardUpdateParams::Alias>, nil]
+          #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>, nil]
           optional :aliases,
                    -> {
                      MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCardUpdateParams::Alias]
@@ -43,7 +43,7 @@ module MetronomeSDK
           #
           #   @param rate_card_id [String] ID of the rate card to update
           #
-          #   @param aliases [Array<MetronomeSDK::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
+          #   @param aliases [Array<MetronomeSDK::Models::V1::Contracts::RateCardUpdateParams::Alias>] Reference this alias when creating a contract. If the same alias is assigned to
           #
           #   @param description [String]
           #

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

@@ -8,11 +8,11 @@ module MetronomeSDK
         class RateCardUpdateResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::ID]
+          #   @return [MetronomeSDK::Models::ID]
           required :data, -> { MetronomeSDK::ID }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::ID]
+          #   @param data [MetronomeSDK::Models::ID]
         end
       end
     end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_set_response.rb

@@ -9,11 +9,11 @@ module MetronomeSDK
           class ProductOrderSetResponse < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute data
             #
-            #   @return [MetronomeSDK::ID]
+            #   @return [MetronomeSDK::Models::ID]
             required :data, -> { MetronomeSDK::ID }
 
             # @!method initialize(data:)
-            #   @param data [MetronomeSDK::ID]
+            #   @param data [MetronomeSDK::Models::ID]
           end
         end
       end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_params.rb

@@ -12,7 +12,7 @@ module MetronomeSDK
 
             # @!attribute product_moves
             #
-            #   @return [Array<MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
+            #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
             required :product_moves,
                      -> {
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove]
@@ -25,7 +25,7 @@ module MetronomeSDK
             required :rate_card_id, String
 
             # @!method initialize(product_moves:, rate_card_id:, request_options: {})
-            #   @param product_moves [Array<MetronomeSDK::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
+            #   @param product_moves [Array<MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove>]
             #
             #   @param rate_card_id [String] ID of the rate card to update
             #

data/lib/metronome_sdk/models/v1/contracts/rate_cards/product_order_update_response.rb

@@ -9,11 +9,11 @@ module MetronomeSDK
           class ProductOrderUpdateResponse < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute data
             #
-            #   @return [MetronomeSDK::ID]
+            #   @return [MetronomeSDK::Models::ID]
             required :data, -> { MetronomeSDK::ID }
 
             # @!method initialize(data:)
-            #   @param data [MetronomeSDK::ID]
+            #   @param data [MetronomeSDK::Models::ID]
           end
         end
       end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_params.rb

@@ -17,7 +17,7 @@ module MetronomeSDK
 
             # @!attribute rates
             #
-            #   @return [Array<MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate>]
+            #   @return [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate>]
             required :rates,
                      -> {
                        MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate]
@@ -25,7 +25,7 @@ module MetronomeSDK
 
             # @!method initialize(rate_card_id:, rates:, request_options: {})
             #   @param rate_card_id [String]
-            #   @param rates [Array<MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate>]
+            #   @param rates [Array<MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate>]
             #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
             class Rate < MetronomeSDK::Internal::Type::BaseModel
@@ -42,7 +42,7 @@ module MetronomeSDK
 
               # @!attribute rate_type
               #
-              #   @return [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType]
+              #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType]
               required :rate_type,
                        enum: -> { MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType }
 
@@ -52,11 +52,21 @@ module MetronomeSDK
               #   @return [Time]
               required :starting_at, Time
 
+              # @!attribute billing_frequency
+              #   Optional. Frequency to bill subscriptions with. Required for subscription type
+              #   products with Flat rate.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency, nil]
+              optional :billing_frequency,
+                       enum: -> {
+                         MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::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.
               #
-              #   @return [MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate, nil]
+              #   @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate, nil]
               optional :commit_rate,
                        -> {
                          MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate
@@ -115,7 +125,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] }
 
               # @!attribute use_list_prices
@@ -126,20 +136,22 @@ module MetronomeSDK
               #   @return [Boolean, nil]
               optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
 
-              # @!method initialize(entitled:, product_id:, rate_type:, starting_at:, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+              # @!method initialize(entitled:, product_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: 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::V1::Contracts::RateCards::RateAddManyParams::Rate} for more
-              #   details.
+              #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate} for
+              #   more details.
               #
               #   @param entitled [Boolean]
               #
               #   @param product_id [String] ID of the product to add a rate for
               #
-              #   @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType]
+              #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType]
               #
               #   @param starting_at [Time] inclusive effective date
               #
-              #   @param commit_rate [MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
+              #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency] Optional. Frequency to bill subscriptions with. Required for subscription type p
+              #
+              #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
               #
               #   @param credit_type_id [String] "The Metronome ID of the credit type to associate with price, defaults to USD (c
               #
@@ -155,11 +167,11 @@ module MetronomeSDK
               #
               #   @param quantity [Float] Default quantity. For SUBSCRIPTION 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.
               #
               #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
-              # @see MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate#rate_type
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate#rate_type
               module RateType
                 extend MetronomeSDK::Internal::Type::Enum
 
@@ -173,11 +185,27 @@ module MetronomeSDK
                 #   @return [Array<Symbol>]
               end
 
-              # @see MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate#commit_rate
+              # Optional. Frequency to bill subscriptions with. Required for subscription type
+              # products with Flat rate.
+              #
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate#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::Contracts::RateCards::RateAddManyParams::Rate#commit_rate
               class CommitRate < MetronomeSDK::Internal::Type::BaseModel
                 # @!attribute rate_type
                 #
-                #   @return [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType]
+                #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType]
                 required :rate_type,
                          enum: -> {
                            MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType
@@ -192,20 +220,20 @@ 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)
                 #   A distinct rate on the rate card. You can choose to use this rate rather than
                 #   list rate when consuming a credit or commit.
                 #
-                #   @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType]
+                #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::RateType]
                 #
                 #   @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::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate#rate_type
+                # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate#rate_type
                 module RateType
                   extend MetronomeSDK::Internal::Type::Enum
 

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_many_response.rb

@@ -10,11 +10,11 @@ module MetronomeSDK
             # @!attribute data
             #   The ID of the rate card to which the rates were added.
             #
-            #   @return [MetronomeSDK::ID]
+            #   @return [MetronomeSDK::Models::ID]
             required :data, -> { MetronomeSDK::ID }
 
             # @!method initialize(data:)
-            #   @param data [MetronomeSDK::ID] The ID of the rate card to which the rates were added.
+            #   @param data [MetronomeSDK::Models::ID] The ID of the rate card to which the rates were added.
           end
         end
       end

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rb

@@ -29,7 +29,7 @@ module MetronomeSDK
 
             # @!attribute rate_type
             #
-            #   @return [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType]
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType]
             required :rate_type, enum: -> { MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType }
 
             # @!attribute starting_at
@@ -38,11 +38,19 @@ module MetronomeSDK
             #   @return [Time]
             required :starting_at, Time
 
+            # @!attribute billing_frequency
+            #   Optional. Frequency to bill subscriptions with. Required for subscription type
+            #   products with Flat rate.
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::BillingFrequency, nil]
+            optional :billing_frequency,
+                     enum: -> { MetronomeSDK::V1::Contracts::RateCards::RateAddParams::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.
             #
-            #   @return [MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate, nil]
+            #   @return [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate, nil]
             optional :commit_rate, -> { MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate }
 
             # @!attribute credit_type_id
@@ -97,7 +105,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] }
 
             # @!attribute use_list_prices
@@ -108,7 +116,7 @@ module MetronomeSDK
             #   @return [Boolean, nil]
             optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
 
-            # @!method initialize(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
+            # @!method initialize(entitled:, product_id:, rate_card_id:, rate_type:, starting_at:, billing_frequency: nil, commit_rate: nil, credit_type_id: nil, custom_rate: nil, ending_before: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil, request_options: {})
             #   Some parameter documentations has been truncated, see
             #   {MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams} for more
             #   details.
@@ -119,11 +127,13 @@ module MetronomeSDK
             #
             #   @param rate_card_id [String] ID of the rate card to update
             #
-            #   @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType]
+            #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType]
             #
             #   @param starting_at [Time] inclusive effective date
             #
-            #   @param commit_rate [MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
+            #   @param billing_frequency [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::BillingFrequency] Optional. Frequency to bill subscriptions with. Required for subscription type p
+            #
+            #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
             #
             #   @param credit_type_id [String] The Metronome ID of the credit type to associate with price, defaults to USD (ce
             #
@@ -139,7 +149,7 @@ module MetronomeSDK
             #
             #   @param quantity [Float] Default quantity. For SUBSCRIPTION 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.
             #
             #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
             #
@@ -158,10 +168,24 @@ module MetronomeSDK
               #   @return [Array<Symbol>]
             end
 
+            # Optional. Frequency to bill subscriptions with. Required for subscription type
+            # products with Flat rate.
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              MONTHLY = :MONTHLY
+              QUARTERLY = :QUARTERLY
+              ANNUAL = :ANNUAL
+              WEEKLY = :WEEKLY
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute rate_type
               #
-              #   @return [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType]
+              #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType]
               required :rate_type,
                        enum: -> {
                          MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType
@@ -176,20 +200,20 @@ 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)
               #   A distinct rate on the rate card. You can choose to use this rate rather than
               #   list rate when consuming a credit or commit.
               #
-              #   @param rate_type [Symbol, MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType]
+              #   @param rate_type [Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType]
               #
               #   @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::V1::Contracts::RateCards::RateAddParams::CommitRate#rate_type
+              # @see MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate#rate_type
               module RateType
                 extend MetronomeSDK::Internal::Type::Enum
 

data/lib/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rb

@@ -33,7 +33,7 @@ module MetronomeSDK
 
               # @!attribute credit_type
               #
-              #   @return [MetronomeSDK::CreditTypeData, nil]
+              #   @return [MetronomeSDK::Models::CreditTypeData, nil]
               optional :credit_type, -> { MetronomeSDK::CreditTypeData }
 
               # @!attribute custom_rate
@@ -74,7 +74,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] }
 
               # @!attribute use_list_prices
@@ -94,7 +94,7 @@ module MetronomeSDK
               #
               #   @param commit_rate [MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate] A distinct rate on the rate card. You can choose to use this rate rather than li
               #
-              #   @param credit_type [MetronomeSDK::CreditTypeData]
+              #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
               #
               #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
               #
@@ -106,7 +106,7 @@ module MetronomeSDK
               #
               #   @param quantity [Float] Default quantity. For SUBSCRIPTION 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.
               #
               #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
 
@@ -141,7 +141,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)
@@ -152,7 +152,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::Contracts::RateCards::RateAddResponse::Data::CommitRate#rate_type
                 module RateType