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

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_params.rbi

@@ -39,6 +39,25 @@ module MetronomeSDK
             sig { returns(Time) }
             attr_accessor :starting_at
 
+            # Optional. Frequency to bill subscriptions with. Required for subscription type
+            # products with Flat rate.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol
+                )
+              )
+            end
+            attr_reader :billing_frequency
+
+            sig do
+              params(
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol
+              ).void
+            end
+            attr_writer :billing_frequency
+
             # A distinct rate on the rate card. You can choose to use this rate rather than
             # list rate when consuming a credit or commit.
             sig do
@@ -115,10 +134,25 @@ module MetronomeSDK
             attr_writer :quantity
 
             # Only set for TIERED rate_type.
-            sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier
+                  ]
+                )
+              )
+            end
             attr_reader :tiers
 
-            sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
+            sig do
+              params(
+                tiers:
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier::OrHash
+                  ]
+              ).void
+            end
             attr_writer :tiers
 
             # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
@@ -138,6 +172,8 @@ module MetronomeSDK
                 rate_type:
                   MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
                 starting_at: Time,
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
                 commit_rate:
                   MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash,
                 credit_type_id: String,
@@ -147,7 +183,10 @@ module MetronomeSDK
                 price: Float,
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
-                tiers: T::Array[MetronomeSDK::Tier::OrHash],
+                tiers:
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier::OrHash
+                  ],
                 use_list_prices: T::Boolean,
                 request_options: MetronomeSDK::RequestOptions::OrHash
               ).returns(T.attached_class)
@@ -161,6 +200,9 @@ module MetronomeSDK
               rate_type:,
               # inclusive effective date
               starting_at:,
+              # Optional. Frequency to bill subscriptions with. Required for subscription type
+              # products with Flat rate.
+              billing_frequency: 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.
               commit_rate: nil,
@@ -204,6 +246,8 @@ module MetronomeSDK
                   rate_type:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
                   starting_at: Time,
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
                   commit_rate:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate,
                   credit_type_id: String,
@@ -213,7 +257,10 @@ module MetronomeSDK
                   price: Float,
                   pricing_group_values: T::Hash[Symbol, String],
                   quantity: Float,
-                  tiers: T::Array[MetronomeSDK::Tier],
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier
+                    ],
                   use_list_prices: T::Boolean,
                   request_options: MetronomeSDK::RequestOptions
                 }
@@ -271,6 +318,52 @@ module MetronomeSDK
               end
             end
 
+            # Optional. Frequency to bill subscriptions with. Required for subscription type
+            # products with Flat rate.
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTHLY =
+                T.let(
+                  :MONTHLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :QUARTERLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :ANNUAL,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+              WEEKLY =
+                T.let(
+                  :WEEKLY,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do
@@ -295,10 +388,25 @@ module MetronomeSDK
               attr_writer :price
 
               # Only set for TIERED rate_type.
-              sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier
+                    ]
+                  )
+                )
+              end
               attr_reader :tiers
 
-              sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
+              sig do
+                params(
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier::OrHash
+                    ]
+                ).void
+              end
               attr_writer :tiers
 
               # A distinct rate on the rate card. You can choose to use this rate rather than
@@ -308,7 +416,10 @@ module MetronomeSDK
                   rate_type:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
                   price: Float,
-                  tiers: T::Array[MetronomeSDK::Tier::OrHash]
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier::OrHash
+                    ]
                 ).returns(T.attached_class)
               end
               def self.new(
@@ -326,7 +437,10 @@ module MetronomeSDK
                     rate_type:
                       MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
                     price: Float,
-                    tiers: T::Array[MetronomeSDK::Tier]
+                    tiers:
+                      T::Array[
+                        MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier
+                      ]
                   }
                 )
               end
@@ -381,6 +495,64 @@ module MetronomeSDK
                 def self.values
                 end
               end
+
+              class Tier < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(Float) }
+                attr_accessor :price
+
+                sig { returns(T.nilable(Float)) }
+                attr_reader :size
+
+                sig { params(size: Float).void }
+                attr_writer :size
+
+                sig do
+                  params(price: Float, size: Float).returns(T.attached_class)
+                end
+                def self.new(price:, size: nil)
+                end
+
+                sig { override.returns({ price: Float, size: Float }) }
+                def to_hash
+                end
+              end
+            end
+
+            class Tier < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Float) }
+              attr_accessor :price
+
+              sig { returns(T.nilable(Float)) }
+              attr_reader :size
+
+              sig { params(size: Float).void }
+              attr_writer :size
+
+              sig do
+                params(price: Float, size: Float).returns(T.attached_class)
+              end
+              def self.new(price:, size: nil)
+              end
+
+              sig { override.returns({ price: Float, size: Float }) }
+              def to_hash
+              end
             end
           end
         end

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_add_response.rbi

@@ -84,11 +84,20 @@ module MetronomeSDK
               end
               attr_writer :commit_rate
 
-              sig { returns(T.nilable(MetronomeSDK::CreditTypeData)) }
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CreditType
+                  )
+                )
+              end
               attr_reader :credit_type
 
               sig do
-                params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void
+                params(
+                  credit_type:
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CreditType::OrHash
+                ).void
               end
               attr_writer :credit_type
 
@@ -132,10 +141,25 @@ module MetronomeSDK
               attr_writer :quantity
 
               # Only set for TIERED rate_type.
-              sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::Tier
+                    ]
+                  )
+                )
+              end
               attr_reader :tiers
 
-              sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
+              sig do
+                params(
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::Tier::OrHash
+                    ]
+                ).void
+              end
               attr_writer :tiers
 
               # Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
@@ -153,13 +177,17 @@ module MetronomeSDK
                     MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::RateType::OrSymbol,
                   commit_rate:
                     MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::OrHash,
-                  credit_type: MetronomeSDK::CreditTypeData::OrHash,
+                  credit_type:
+                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CreditType::OrHash,
                   custom_rate: T::Hash[Symbol, T.anything],
                   is_prorated: T::Boolean,
                   price: Float,
                   pricing_group_values: T::Hash[Symbol, String],
                   quantity: Float,
-                  tiers: T::Array[MetronomeSDK::Tier::OrHash],
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::Tier::OrHash
+                    ],
                   use_list_prices: T::Boolean
                 ).returns(T.attached_class)
               end
@@ -199,13 +227,17 @@ module MetronomeSDK
                       MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::RateType::TaggedSymbol,
                     commit_rate:
                       MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate,
-                    credit_type: MetronomeSDK::CreditTypeData,
+                    credit_type:
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CreditType,
                     custom_rate: T::Hash[Symbol, T.anything],
                     is_prorated: T::Boolean,
                     price: Float,
                     pricing_group_values: T::Hash[Symbol, String],
                     quantity: Float,
-                    tiers: T::Array[MetronomeSDK::Tier],
+                    tiers:
+                      T::Array[
+                        MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::Tier
+                      ],
                     use_list_prices: T::Boolean
                   }
                 )
@@ -286,10 +318,25 @@ module MetronomeSDK
                 attr_writer :price
 
                 # Only set for TIERED rate_type.
-                sig { returns(T.nilable(T::Array[MetronomeSDK::Tier])) }
+                sig do
+                  returns(
+                    T.nilable(
+                      T::Array[
+                        MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::Tier
+                      ]
+                    )
+                  )
+                end
                 attr_reader :tiers
 
-                sig { params(tiers: T::Array[MetronomeSDK::Tier::OrHash]).void }
+                sig do
+                  params(
+                    tiers:
+                      T::Array[
+                        MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::Tier::OrHash
+                      ]
+                  ).void
+                end
                 attr_writer :tiers
 
                 # A distinct rate on the rate card. You can choose to use this rate rather than
@@ -299,7 +346,10 @@ module MetronomeSDK
                     rate_type:
                       MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::RateType::OrSymbol,
                     price: Float,
-                    tiers: T::Array[MetronomeSDK::Tier::OrHash]
+                    tiers:
+                      T::Array[
+                        MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::Tier::OrHash
+                      ]
                   ).returns(T.attached_class)
                 end
                 def self.new(
@@ -317,7 +367,10 @@ module MetronomeSDK
                       rate_type:
                         MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::RateType::TaggedSymbol,
                       price: Float,
-                      tiers: T::Array[MetronomeSDK::Tier]
+                      tiers:
+                        T::Array[
+                          MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::Tier
+                        ]
                     }
                   )
                 end
@@ -372,6 +425,90 @@ module MetronomeSDK
                   def self.values
                   end
                 end
+
+                class Tier < MetronomeSDK::Internal::Type::BaseModel
+                  OrHash =
+                    T.type_alias do
+                      T.any(
+                        MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CommitRate::Tier,
+                        MetronomeSDK::Internal::AnyHash
+                      )
+                    end
+
+                  sig { returns(Float) }
+                  attr_accessor :price
+
+                  sig { returns(T.nilable(Float)) }
+                  attr_reader :size
+
+                  sig { params(size: Float).void }
+                  attr_writer :size
+
+                  sig do
+                    params(price: Float, size: Float).returns(T.attached_class)
+                  end
+                  def self.new(price:, size: nil)
+                  end
+
+                  sig { override.returns({ price: Float, size: Float }) }
+                  def to_hash
+                  end
+                end
+              end
+
+              class CreditType < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::CreditType,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(String) }
+                attr_accessor :id
+
+                sig { returns(String) }
+                attr_accessor :name
+
+                sig do
+                  params(id: String, name: String).returns(T.attached_class)
+                end
+                def self.new(id:, name:)
+                end
+
+                sig { override.returns({ id: String, name: String }) }
+                def to_hash
+                end
+              end
+
+              class Tier < MetronomeSDK::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      MetronomeSDK::Models::V1::Contracts::RateCards::RateAddResponse::Data::Tier,
+                      MetronomeSDK::Internal::AnyHash
+                    )
+                  end
+
+                sig { returns(Float) }
+                attr_accessor :price
+
+                sig { returns(T.nilable(Float)) }
+                attr_reader :size
+
+                sig { params(size: Float).void }
+                attr_writer :size
+
+                sig do
+                  params(price: Float, size: Float).returns(T.attached_class)
+                end
+                def self.new(price:, size: nil)
+                end
+
+                sig { override.returns({ price: Float, size: Float }) }
+                def to_hash
+                end
               end
             end
           end

data/rbi/metronome_sdk/models/v1/contracts/rate_cards/rate_list_params.rbi

@@ -118,6 +118,25 @@ module MetronomeSDK
                   )
                 end
 
+              # Subscription rates matching the billing frequency will be included in the
+              # response.
+              sig do
+                returns(
+                  T.nilable(
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol
+                  )
+                )
+              end
+              attr_reader :billing_frequency
+
+              sig do
+                params(
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol
+                ).void
+              end
+              attr_writer :billing_frequency
+
               # List of pricing group key value pairs, rates containing the matching key / value
               # pairs will be included in the response.
               sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -155,6 +174,8 @@ module MetronomeSDK
 
               sig do
                 params(
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol,
                   partial_pricing_group_values: T::Hash[Symbol, String],
                   pricing_group_values: T::Hash[Symbol, String],
                   product_id: String,
@@ -162,6 +183,9 @@ module MetronomeSDK
                 ).returns(T.attached_class)
               end
               def self.new(
+                # Subscription rates matching the billing frequency will be included in the
+                # response.
+                billing_frequency: nil,
                 # List of pricing group key value pairs, rates containing the matching key / value
                 # pairs will be included in the response.
                 partial_pricing_group_values: nil,
@@ -179,6 +203,8 @@ module MetronomeSDK
               sig do
                 override.returns(
                   {
+                    billing_frequency:
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::OrSymbol,
                     partial_pricing_group_values: T::Hash[Symbol, String],
                     pricing_group_values: T::Hash[Symbol, String],
                     product_id: String,
@@ -188,6 +214,52 @@ module MetronomeSDK
               end
               def to_hash
               end
+
+              # Subscription rates matching the billing frequency will be included in the
+              # response.
+              module BillingFrequency
+                extend MetronomeSDK::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                MONTHLY =
+                  T.let(
+                    :MONTHLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                QUARTERLY =
+                  T.let(
+                    :QUARTERLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                ANNUAL =
+                  T.let(
+                    :ANNUAL,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+                WEEKLY =
+                  T.let(
+                    :WEEKLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateListParams::Selector::BillingFrequency::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
             end
           end
         end