metronome-sdk 0.3.0 → 1.0.0

data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_response.rbi

@@ -12,299 +12,248 @@ module MetronomeSDK
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :customer_id
+
         sig do
           returns(
             T::Array[
-              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data
+              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger
             ]
           )
         end
-        attr_accessor :data
-
-        sig { returns(T.nilable(String)) }
-        attr_accessor :next_page
+        attr_accessor :ledgers
 
         sig do
           params(
-            data:
+            customer_id: String,
+            ledgers:
               T::Array[
-                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::OrHash
-              ],
-            next_page: T.nilable(String)
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::OrHash
+              ]
           ).returns(T.attached_class)
         end
-        def self.new(data:, next_page:)
+        def self.new(customer_id:, ledgers:)
         end
 
         sig do
           override.returns(
             {
-              data:
+              customer_id: String,
+              ledgers:
                 T::Array[
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data
-                ],
-              next_page: T.nilable(String)
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger
+                ]
             }
           )
         end
         def to_hash
         end
 
-        class Data < MetronomeSDK::Internal::Type::BaseModel
+        class Ledger < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
               T.any(
-                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data,
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger,
                 MetronomeSDK::Internal::AnyHash
               )
             end
 
-          sig { returns(String) }
-          attr_accessor :customer_id
+          sig { returns(MetronomeSDK::CreditTypeData) }
+          attr_reader :credit_type
 
+          sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
+          attr_writer :credit_type
+
+          # the effective balances at the end of the specified time window
           sig do
             returns(
-              T::Array[
-                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger
-              ]
+              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance
             )
           end
-          attr_accessor :ledgers
+          attr_reader :ending_balance
 
           sig do
             params(
-              customer_id: String,
-              ledgers:
-                T::Array[
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::OrHash
-                ]
+              ending_balance:
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance::OrHash
+            ).void
+          end
+          attr_writer :ending_balance
+
+          sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
+          attr_accessor :entries
+
+          sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
+          attr_accessor :pending_entries
+
+          sig do
+            returns(
+              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance
+            )
+          end
+          attr_reader :starting_balance
+
+          sig do
+            params(
+              starting_balance:
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance::OrHash
+            ).void
+          end
+          attr_writer :starting_balance
+
+          sig do
+            params(
+              credit_type: MetronomeSDK::CreditTypeData::OrHash,
+              ending_balance:
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance::OrHash,
+              entries: T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
+              pending_entries:
+                T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
+              starting_balance:
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(customer_id:, ledgers:)
+          def self.new(
+            credit_type:,
+            # the effective balances at the end of the specified time window
+            ending_balance:,
+            entries:,
+            pending_entries:,
+            starting_balance:
+          )
           end
 
           sig do
             override.returns(
               {
-                customer_id: String,
-                ledgers:
-                  T::Array[
-                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger
-                  ]
+                credit_type: MetronomeSDK::CreditTypeData,
+                ending_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance,
+                entries: T::Array[MetronomeSDK::V1::CreditLedgerEntry],
+                pending_entries: T::Array[MetronomeSDK::V1::CreditLedgerEntry],
+                starting_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance
               }
             )
           end
           def to_hash
           end
 
-          class Ledger < MetronomeSDK::Internal::Type::BaseModel
+          class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
             OrHash =
               T.type_alias do
                 T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger,
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance,
                   MetronomeSDK::Internal::AnyHash
                 )
               end
 
-            sig { returns(MetronomeSDK::CreditTypeData) }
-            attr_reader :credit_type
+            # the ending_before request parameter (if supplied) or the current billing
+            # period's end date
+            sig { returns(Time) }
+            attr_accessor :effective_at
 
-            sig do
-              params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void
-            end
-            attr_writer :credit_type
+            # the ending balance, including the balance of all grants that have not expired
+            # before the effective_at date and deductions that happened before the
+            # effective_at date
+            sig { returns(Float) }
+            attr_accessor :excluding_pending
 
-            # the effective balances at the end of the specified time window
-            sig do
-              returns(
-                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance
-              )
-            end
-            attr_reader :ending_balance
-
-            sig do
-              params(
-                ending_balance:
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance::OrHash
-              ).void
-            end
-            attr_writer :ending_balance
-
-            sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
-            attr_accessor :entries
-
-            sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
-            attr_accessor :pending_entries
-
-            sig do
-              returns(
-                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance
-              )
-            end
-            attr_reader :starting_balance
-
-            sig do
-              params(
-                starting_balance:
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance::OrHash
-              ).void
-            end
-            attr_writer :starting_balance
+            # the excluding_pending balance plus any pending invoice deductions and
+            # expirations that will happen by the effective_at date
+            sig { returns(Float) }
+            attr_accessor :including_pending
 
+            # the effective balances at the end of the specified time window
             sig do
               params(
-                credit_type: MetronomeSDK::CreditTypeData::OrHash,
-                ending_balance:
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance::OrHash,
-                entries: T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
-                pending_entries:
-                  T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
-                starting_balance:
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance::OrHash
+                effective_at: Time,
+                excluding_pending: Float,
+                including_pending: Float
               ).returns(T.attached_class)
             end
             def self.new(
-              credit_type:,
-              # the effective balances at the end of the specified time window
-              ending_balance:,
-              entries:,
-              pending_entries:,
-              starting_balance:
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  credit_type: MetronomeSDK::CreditTypeData,
-                  ending_balance:
-                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
-                  entries: T::Array[MetronomeSDK::V1::CreditLedgerEntry],
-                  pending_entries:
-                    T::Array[MetronomeSDK::V1::CreditLedgerEntry],
-                  starting_balance:
-                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance
-                }
-              )
-            end
-            def to_hash
-            end
-
-            class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                end
-
               # the ending_before request parameter (if supplied) or the current billing
               # period's end date
-              sig { returns(Time) }
-              attr_accessor :effective_at
-
+              effective_at:,
               # the ending balance, including the balance of all grants that have not expired
               # before the effective_at date and deductions that happened before the
               # effective_at date
-              sig { returns(Float) }
-              attr_accessor :excluding_pending
-
+              excluding_pending:,
               # the excluding_pending balance plus any pending invoice deductions and
               # expirations that will happen by the effective_at date
-              sig { returns(Float) }
-              attr_accessor :including_pending
+              including_pending:
+            )
+            end
 
-              # the effective balances at the end of the specified time window
-              sig do
-                params(
+            sig do
+              override.returns(
+                {
                   effective_at: Time,
                   excluding_pending: Float,
                   including_pending: Float
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # the ending_before request parameter (if supplied) or the current billing
-                # period's end date
-                effective_at:,
-                # the ending balance, including the balance of all grants that have not expired
-                # before the effective_at date and deductions that happened before the
-                # effective_at date
-                excluding_pending:,
-                # the excluding_pending balance plus any pending invoice deductions and
-                # expirations that will happen by the effective_at date
-                including_pending:
+                }
               )
-              end
+            end
+            def to_hash
+            end
+          end
 
-              sig do
-                override.returns(
-                  {
-                    effective_at: Time,
-                    excluding_pending: Float,
-                    including_pending: Float
-                  }
+          class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance,
+                  MetronomeSDK::Internal::AnyHash
                 )
               end
-              def to_hash
-              end
-            end
 
-            class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance,
-                    MetronomeSDK::Internal::AnyHash
-                  )
-                end
+            # the starting_on request parameter (if supplied) or the first credit grant's
+            # effective_at date
+            sig { returns(Time) }
+            attr_accessor :effective_at
+
+            # the starting balance, including all posted grants, deductions, and expirations
+            # that happened at or before the effective_at timestamp
+            sig { returns(Float) }
+            attr_accessor :excluding_pending
+
+            # the excluding_pending balance plus any pending activity that has not been posted
+            # at the time of the query
+            sig { returns(Float) }
+            attr_accessor :including_pending
 
+            sig do
+              params(
+                effective_at: Time,
+                excluding_pending: Float,
+                including_pending: Float
+              ).returns(T.attached_class)
+            end
+            def self.new(
               # the starting_on request parameter (if supplied) or the first credit grant's
               # effective_at date
-              sig { returns(Time) }
-              attr_accessor :effective_at
-
+              effective_at:,
               # the starting balance, including all posted grants, deductions, and expirations
               # that happened at or before the effective_at timestamp
-              sig { returns(Float) }
-              attr_accessor :excluding_pending
-
+              excluding_pending:,
               # the excluding_pending balance plus any pending activity that has not been posted
               # at the time of the query
-              sig { returns(Float) }
-              attr_accessor :including_pending
+              including_pending:
+            )
+            end
 
-              sig do
-                params(
+            sig do
+              override.returns(
+                {
                   effective_at: Time,
                   excluding_pending: Float,
                   including_pending: Float
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # the starting_on request parameter (if supplied) or the first credit grant's
-                # effective_at date
-                effective_at:,
-                # the starting balance, including all posted grants, deductions, and expirations
-                # that happened at or before the effective_at timestamp
-                excluding_pending:,
-                # the excluding_pending balance plus any pending activity that has not been posted
-                # at the time of the query
-                including_pending:
+                }
               )
-              end
-
-              sig do
-                override.returns(
-                  {
-                    effective_at: Time,
-                    excluding_pending: Float,
-                    including_pending: Float
-                  }
-                )
-              end
-              def to_hash
-              end
+            end
+            def to_hash
             end
           end
         end

data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi

@@ -32,6 +32,7 @@ module MetronomeSDK
         end
         attr_writer :balance
 
+        # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :custom_fields
 
@@ -162,6 +163,7 @@ module MetronomeSDK
           # billing period. Expiration deductions will be included only if the grant expires
           # before the end of the current billing period.
           balance:,
+          # Custom fields to be added eg. { "key1": "value1", "key2": "value2" }
           custom_fields:,
           # the Metronome ID of the customer
           customer_id:,