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

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

@@ -9,6 +9,14 @@ module MetronomeSDK
             extend MetronomeSDK::Internal::Type::RequestParameters::Converter
             include MetronomeSDK::Internal::Type::RequestParameters
 
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
             sig { returns(T::Boolean) }
             attr_accessor :entitled
 
@@ -20,26 +28,52 @@ module MetronomeSDK
             sig { returns(String) }
             attr_accessor :rate_card_id
 
-            sig { returns(MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol) }
+            sig do
+              returns(
+                MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol
+              )
+            end
             attr_accessor :rate_type
 
             # inclusive effective date
             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 { returns(T.nilable(MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate)) }
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate
+                )
+              )
+            end
             attr_reader :commit_rate
 
             sig do
               params(
-                commit_rate: T.any(
-                  MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              )
-                .void
+                commit_rate:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash
+              ).void
             end
             attr_writer :commit_rate
 
@@ -100,10 +134,25 @@ module MetronomeSDK
             attr_writer :quantity
 
             # Only set for TIERED rate_type.
-            sig { returns(T.nilable(T::Array[MetronomeSDK::Models::Tier])) }
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier
+                  ]
+                )
+              )
+            end
             attr_reader :tiers
 
-            sig { params(tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)]).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
@@ -120,12 +169,13 @@ module MetronomeSDK
                 entitled: T::Boolean,
                 product_id: String,
                 rate_card_id: String,
-                rate_type: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
+                rate_type:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
                 starting_at: Time,
-                commit_rate: T.any(
-                  MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate,
-                  MetronomeSDK::Internal::AnyHash
-                ),
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::OrSymbol,
+                commit_rate:
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::OrHash,
                 credit_type_id: String,
                 custom_rate: T::Hash[Symbol, T.anything],
                 ending_before: Time,
@@ -133,11 +183,13 @@ module MetronomeSDK
                 price: Float,
                 pricing_group_values: T::Hash[Symbol, String],
                 quantity: Float,
-                tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)],
+                tiers:
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier::OrHash
+                  ],
                 use_list_prices: T::Boolean,
-                request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
-              )
-                .returns(T.attached_class)
+                request_options: MetronomeSDK::RequestOptions::OrHash
+              ).returns(T.attached_class)
             end
             def self.new(
               entitled:,
@@ -148,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,
@@ -179,62 +234,150 @@ module MetronomeSDK
               # contract.
               use_list_prices: nil,
               request_options: {}
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    entitled: T::Boolean,
-                    product_id: String,
-                    rate_card_id: String,
-                    rate_type: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::OrSymbol,
-                    starting_at: Time,
-                    commit_rate: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate,
-                    credit_type_id: String,
-                    custom_rate: T::Hash[Symbol, T.anything],
-                    ending_before: Time,
-                    is_prorated: T::Boolean,
-                    price: Float,
-                    pricing_group_values: T::Hash[Symbol, String],
-                    quantity: Float,
-                    tiers: T::Array[MetronomeSDK::Models::Tier],
-                    use_list_prices: T::Boolean,
-                    request_options: MetronomeSDK::RequestOptions
-                  }
-                )
+              override.returns(
+                {
+                  entitled: T::Boolean,
+                  product_id: String,
+                  rate_card_id: String,
+                  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,
+                  custom_rate: T::Hash[Symbol, T.anything],
+                  ending_before: Time,
+                  is_prorated: T::Boolean,
+                  price: Float,
+                  pricing_group_values: T::Hash[Symbol, String],
+                  quantity: Float,
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::Tier
+                    ],
+                  use_list_prices: T::Boolean,
+                  request_options: MetronomeSDK::RequestOptions
+                }
+              )
+            end
+            def to_hash
             end
-            def to_hash; end
 
             module RateType
               extend MetronomeSDK::Internal::Type::Enum
 
               TaggedSymbol =
-                T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType) }
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType
+                  )
+                end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
 
               FLAT =
-                T.let(:FLAT, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol)
+                T.let(
+                  :FLAT,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                )
               PERCENTAGE =
-                T.let(:PERCENTAGE, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol)
+                T.let(
+                  :PERCENTAGE,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                )
               SUBSCRIPTION =
                 T.let(
                   :SUBSCRIPTION,
-                  MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
                 )
               TIERED =
-                T.let(:TIERED, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol)
+                T.let(
+                  :TIERED,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                )
               CUSTOM =
-                T.let(:CUSTOM, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol)
+                T.let(
+                  :CUSTOM,
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              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::Models::V1::Contracts::RateCards::RateAddParams::RateType::TaggedSymbol])
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
               end
-              def self.values; end
             end
 
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
-              sig { returns(MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol) }
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig do
+                returns(
+                  MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol
+                )
+              end
               attr_accessor :rate_type
 
               # Commit rate price. For FLAT rate_type, this must be >=0.
@@ -245,21 +388,39 @@ module MetronomeSDK
               attr_writer :price
 
               # Only set for TIERED rate_type.
-              sig { returns(T.nilable(T::Array[MetronomeSDK::Models::Tier])) }
+              sig do
+                returns(
+                  T.nilable(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier
+                    ]
+                  )
+                )
+              end
               attr_reader :tiers
 
-              sig { params(tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)]).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
               # list rate when consuming a credit or commit.
               sig do
                 params(
-                  rate_type: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
+                  rate_type:
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
                   price: Float,
-                  tiers: T::Array[T.any(MetronomeSDK::Models::Tier, MetronomeSDK::Internal::AnyHash)]
-                )
-                  .returns(T.attached_class)
+                  tiers:
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier::OrHash
+                    ]
+                ).returns(T.attached_class)
               end
               def self.new(
                 rate_type:,
@@ -267,59 +428,130 @@ module MetronomeSDK
                 price: nil,
                 # Only set for TIERED rate_type.
                 tiers: nil
-              ); end
+              )
+              end
+
               sig do
-                override
-                  .returns(
-                    {
-                      rate_type: MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
-                      price: Float,
-                      tiers: T::Array[MetronomeSDK::Models::Tier]
-                    }
-                  )
+                override.returns(
+                  {
+                    rate_type:
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::OrSymbol,
+                    price: Float,
+                    tiers:
+                      T::Array[
+                        MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::Tier
+                      ]
+                  }
+                )
+              end
+              def to_hash
               end
-              def to_hash; end
 
               module RateType
                 extend MetronomeSDK::Internal::Type::Enum
 
                 TaggedSymbol =
-                  T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType) }
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType
+                    )
+                  end
                 OrSymbol = T.type_alias { T.any(Symbol, String) }
 
                 FLAT =
                   T.let(
                     :FLAT,
-                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
                   )
                 PERCENTAGE =
                   T.let(
                     :PERCENTAGE,
-                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
                   )
                 SUBSCRIPTION =
                   T.let(
                     :SUBSCRIPTION,
-                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
                   )
                 TIERED =
                   T.let(
                     :TIERED,
-                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
                   )
                 CUSTOM =
                   T.let(
                     :CUSTOM,
-                    MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
                   )
 
                 sig do
-                  override
-                    .returns(
-                      T::Array[MetronomeSDK::Models::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol]
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddParams::CommitRate::RateType::TaggedSymbol
+                    ]
+                  )
+                end
+                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.values; 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