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

data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class ContractRetrieveSubscriptionQuantityHistoryParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::ContractRetrieveSubscriptionQuantityHistoryParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :contract_id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :subscription_id
+
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            subscription_id: String,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          contract_id:,
+          customer_id:,
+          subscription_id:,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              contract_id: String,
+              customer_id: String,
+              subscription_id: String,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contract_retrieve_subscription_quantity_history_response.rbi

@@ -0,0 +1,212 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class ContractRetrieveSubscriptionQuantityHistoryResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            {
+              data:
+                MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :fiat_credit_type_id
+
+          sig { params(fiat_credit_type_id: String).void }
+          attr_writer :fiat_credit_type_id
+
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History
+                ]
+              )
+            )
+          end
+          attr_reader :history
+
+          sig do
+            params(
+              history:
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::OrHash
+                ]
+            ).void
+          end
+          attr_writer :history
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :subscription_id
+
+          sig { params(subscription_id: String).void }
+          attr_writer :subscription_id
+
+          sig do
+            params(
+              fiat_credit_type_id: String,
+              history:
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::OrHash
+                ],
+              subscription_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            fiat_credit_type_id: nil,
+            history: nil,
+            subscription_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                fiat_credit_type_id: String,
+                history:
+                  T::Array[
+                    MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History
+                  ],
+                subscription_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class History < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::Data
+                ]
+              )
+            end
+            attr_accessor :data
+
+            sig { returns(Time) }
+            attr_accessor :starting_at
+
+            sig do
+              params(
+                data:
+                  T::Array[
+                    MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::Data::OrHash
+                  ],
+                starting_at: Time
+              ).returns(T.attached_class)
+            end
+            def self.new(data:, starting_at:)
+            end
+
+            sig do
+              override.returns(
+                {
+                  data:
+                    T::Array[
+                      MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::Data
+                    ],
+                  starting_at: Time
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Data < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::ContractRetrieveSubscriptionQuantityHistoryResponse::Data::History::Data,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(Float) }
+              attr_accessor :quantity
+
+              sig { returns(Float) }
+              attr_accessor :total
+
+              sig { returns(Float) }
+              attr_accessor :unit_price
+
+              sig do
+                params(
+                  quantity: Float,
+                  total: Float,
+                  unit_price: Float
+                ).returns(T.attached_class)
+              end
+              def self.new(quantity:, total:, unit_price:)
+              end
+
+              sig do
+                override.returns(
+                  { quantity: Float, total: Float, unit_price: Float }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/contracts/product_list_params.rbi

@@ -30,7 +30,7 @@ module MetronomeSDK
           sig { params(next_page: String).void }
           attr_writer :next_page
 
-          # Filter options for the product list
+          # Filter options for the product list. If not provided, defaults to not archived.
           sig do
             returns(
               T.nilable(
@@ -62,7 +62,7 @@ module MetronomeSDK
             limit: nil,
             # Cursor that indicates where the next page of results should start.
             next_page: nil,
-            # Filter options for the product list
+            # Filter options for the product list. If not provided, defaults to not archived.
             archive_filter: nil,
             request_options: {}
           )
@@ -82,7 +82,7 @@ module MetronomeSDK
           def to_hash
           end
 
-          # Filter options for the product list
+          # Filter options for the product list. If not provided, defaults to not archived.
           module ArchiveFilter
             extend MetronomeSDK::Internal::Type::Enum
 

data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_params.rbi

@@ -130,6 +130,25 @@ module MetronomeSDK
                 )
               end
 
+            # Subscription rates matching the billing frequency will be included in the
+            # response.
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::OrSymbol
+                )
+              )
+            end
+            attr_reader :billing_frequency
+
+            sig do
+              params(
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::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])) }
@@ -157,12 +176,17 @@ module MetronomeSDK
 
             sig do
               params(
+                billing_frequency:
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::OrSymbol,
                 partial_pricing_group_values: T::Hash[Symbol, String],
                 pricing_group_values: T::Hash[Symbol, String],
                 product_id: String
               ).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,
@@ -177,6 +201,8 @@ module MetronomeSDK
             sig do
               override.returns(
                 {
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::OrSymbol,
                   partial_pricing_group_values: T::Hash[Symbol, String],
                   pricing_group_values: T::Hash[Symbol, String],
                   product_id: String
@@ -185,6 +211,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::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTHLY =
+                T.let(
+                  :MONTHLY,
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :QUARTERLY,
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :ANNUAL,
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::TaggedSymbol
+                )
+              WEEKLY =
+                T.let(
+                  :WEEKLY,
+                  MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::V1::Contracts::RateCardRetrieveRateScheduleParams::Selector::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
           end
         end
       end

data/rbi/metronome_sdk/models/v1/contracts/rate_card_retrieve_rate_schedule_response.rbi

@@ -84,6 +84,23 @@ module MetronomeSDK
             sig { returns(Time) }
             attr_accessor :starting_at
 
+            sig do
+              returns(
+                T.nilable(
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                )
+              )
+            end
+            attr_reader :billing_frequency
+
+            sig do
+              params(
+                billing_frequency:
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::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
@@ -124,6 +141,8 @@ module MetronomeSDK
                 product_tags: T::Array[String],
                 rate: MetronomeSDK::Rate::OrHash,
                 starting_at: Time,
+                billing_frequency:
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::OrSymbol,
                 commit_rate:
                   MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate::OrHash,
                 ending_before: Time,
@@ -138,6 +157,7 @@ module MetronomeSDK
               product_tags:,
               rate:,
               starting_at:,
+              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,
@@ -156,6 +176,8 @@ module MetronomeSDK
                   product_tags: T::Array[String],
                   rate: MetronomeSDK::Rate,
                   starting_at: Time,
+                  billing_frequency:
+                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol,
                   commit_rate:
                     MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::CommitRate,
                   ending_before: Time,
@@ -166,6 +188,50 @@ module MetronomeSDK
             def to_hash
             end
 
+            module BillingFrequency
+              extend MetronomeSDK::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONTHLY =
+                T.let(
+                  :MONTHLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                )
+              QUARTERLY =
+                T.let(
+                  :QUARTERLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                )
+              ANNUAL =
+                T.let(
+                  :ANNUAL,
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                )
+              WEEKLY =
+                T.let(
+                  :WEEKLY,
+                  MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    MetronomeSDK::Models::V1::Contracts::RateCardRetrieveRateScheduleResponse::Data::BillingFrequency::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
             class CommitRate < MetronomeSDK::Internal::Type::BaseModel
               OrHash =
                 T.type_alias do

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

@@ -84,6 +84,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::RateAddManyParams::Rate::BillingFrequency::OrSymbol
+                  )
+                )
+              end
+              attr_reader :billing_frequency
+
+              sig do
+                params(
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::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
@@ -182,6 +201,8 @@ module MetronomeSDK
                   rate_type:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType::OrSymbol,
                   starting_at: Time,
+                  billing_frequency:
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::OrSymbol,
                   commit_rate:
                     MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate::OrHash,
                   credit_type_id: String,
@@ -202,6 +223,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,
@@ -243,6 +267,8 @@ module MetronomeSDK
                     rate_type:
                       MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::RateType::OrSymbol,
                     starting_at: Time,
+                    billing_frequency:
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::OrSymbol,
                     commit_rate:
                       MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::CommitRate,
                     credit_type_id: String,
@@ -309,6 +335,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::RateAddManyParams::Rate::BillingFrequency
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                MONTHLY =
+                  T.let(
+                    :MONTHLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::TaggedSymbol
+                  )
+                QUARTERLY =
+                  T.let(
+                    :QUARTERLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::TaggedSymbol
+                  )
+                ANNUAL =
+                  T.let(
+                    :ANNUAL,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::TaggedSymbol
+                  )
+                WEEKLY =
+                  T.let(
+                    :WEEKLY,
+                    MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      MetronomeSDK::V1::Contracts::RateCards::RateAddManyParams::Rate::BillingFrequency::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+
               class CommitRate < MetronomeSDK::Internal::Type::BaseModel
                 OrHash =
                   T.type_alias do