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

data/rbi/metronome_sdk/models/v1/credit_grant_edit_response.rbi

@@ -4,17 +4,62 @@ module MetronomeSDK
   module Models
     module V1
       class CreditGrantEditResponse < MetronomeSDK::Internal::Type::BaseModel
-        sig { returns(MetronomeSDK::Models::ID) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CreditGrantEditResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(MetronomeSDK::Models::V1::CreditGrantEditResponse::Data) }
         attr_reader :data
 
-        sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V1::CreditGrantEditResponse::Data::OrHash
+          ).void
+        end
         attr_writer :data
 
-        sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
-        def self.new(data:); end
+        sig do
+          params(
+            data:
+              MetronomeSDK::Models::V1::CreditGrantEditResponse::Data::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(data:)
+        end
+
+        sig do
+          override.returns(
+            { data: MetronomeSDK::Models::V1::CreditGrantEditResponse::Data }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::CreditGrantEditResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(id:)
+          end
 
-        sig { override.returns({data: MetronomeSDK::Models::ID}) }
-        def to_hash; end
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/credit_grant_list_entries_params.rbi

@@ -7,6 +7,14 @@ module MetronomeSDK
         extend MetronomeSDK::Internal::Type::RequestParameters::Converter
         include MetronomeSDK::Internal::Type::RequestParameters
 
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::CreditGrantListEntriesParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
         # Cursor that indicates where the next page of results should start.
         sig { returns(T.nilable(String)) }
         attr_reader :next_page
@@ -55,9 +63,8 @@ module MetronomeSDK
             customer_ids: T::Array[String],
             ending_before: Time,
             starting_on: Time,
-            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(
           # Cursor that indicates where the next page of results should start.
@@ -77,21 +84,23 @@ module MetronomeSDK
           # returned.
           starting_on: nil,
           request_options: {}
-        ); end
+        )
+        end
+
         sig do
-          override
-            .returns(
-              {
-                next_page: String,
-                credit_type_ids: T::Array[String],
-                customer_ids: T::Array[String],
-                ending_before: Time,
-                starting_on: Time,
-                request_options: MetronomeSDK::RequestOptions
-              }
-            )
+          override.returns(
+            {
+              next_page: String,
+              credit_type_ids: T::Array[String],
+              customer_ids: T::Array[String],
+              ending_before: Time,
+              starting_on: Time,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
       end
     end
   end

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

@@ -4,7 +4,21 @@ module MetronomeSDK
   module Models
     module V1
       class CreditGrantListEntriesResponse < MetronomeSDK::Internal::Type::BaseModel
-        sig { returns(T::Array[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data]) }
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T::Array[
+              MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data
+            ]
+          )
+        end
         attr_accessor :data
 
         sig { returns(T.nilable(String)) }
@@ -12,110 +26,167 @@ module MetronomeSDK
 
         sig do
           params(
-            data: T::Array[T.any(MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data, MetronomeSDK::Internal::AnyHash)],
+            data:
+              T::Array[
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::OrHash
+              ],
             next_page: T.nilable(String)
-          )
-            .returns(T.attached_class)
+          ).returns(T.attached_class)
+        end
+        def self.new(data:, next_page:)
         end
-        def self.new(data:, next_page:); end
 
         sig do
-          override
-            .returns(
-              {data: T::Array[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data], next_page: T.nilable(String)}
-            )
+          override.returns(
+            {
+              data:
+                T::Array[
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data
+                ],
+              next_page: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
         end
-        def to_hash; end
 
         class Data < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
           sig { returns(String) }
           attr_accessor :customer_id
 
-          sig { returns(T::Array[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger]) }
+          sig do
+            returns(
+              T::Array[
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger
+              ]
+            )
+          end
           attr_accessor :ledgers
 
           sig do
             params(
               customer_id: String,
-              ledgers: T::Array[
-                T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              ]
-            )
-              .returns(T.attached_class)
+              ledgers:
+                T::Array[
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::OrHash
+                ]
+            ).returns(T.attached_class)
+          end
+          def self.new(customer_id:, ledgers:)
           end
-          def self.new(customer_id:, ledgers:); end
 
           sig do
-            override
-              .returns(
-                {
-                  customer_id: String,
-                  ledgers: T::Array[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger]
-                }
-              )
+            override.returns(
+              {
+                customer_id: String,
+                ledgers:
+                  T::Array[
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger
+                  ]
+              }
+            )
+          end
+          def to_hash
           end
-          def to_hash; end
 
           class Ledger < MetronomeSDK::Internal::Type::BaseModel
-            sig { returns(MetronomeSDK::Models::CreditTypeData) }
+            OrHash =
+              T.type_alias do
+                T.any(
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType
+              )
+            end
             attr_reader :credit_type
 
-            sig { params(credit_type: T.any(MetronomeSDK::Models::CreditTypeData, MetronomeSDK::Internal::AnyHash)).void }
+            sig do
+              params(
+                credit_type:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType::OrHash
+              ).void
+            end
             attr_writer :credit_type
 
             # the effective balances at the end of the specified time window
-            sig { returns(MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance) }
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance
+              )
+            end
             attr_reader :ending_balance
 
             sig do
               params(
-                ending_balance: T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              )
-                .void
+                ending_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance::OrHash
+              ).void
             end
             attr_writer :ending_balance
 
-            sig { returns(T::Array[MetronomeSDK::Models::V1::CreditLedgerEntry]) }
+            sig do
+              returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry
+                ]
+              )
+            end
             attr_accessor :entries
 
-            sig { returns(T::Array[MetronomeSDK::Models::V1::CreditLedgerEntry]) }
+            sig do
+              returns(
+                T::Array[
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry
+                ]
+              )
+            end
             attr_accessor :pending_entries
 
-            sig { returns(MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance) }
+            sig do
+              returns(
+                MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance
+              )
+            end
             attr_reader :starting_balance
 
             sig do
               params(
-                starting_balance: T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              )
-                .void
+                starting_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance::OrHash
+              ).void
             end
             attr_writer :starting_balance
 
             sig do
               params(
-                credit_type: T.any(MetronomeSDK::Models::CreditTypeData, MetronomeSDK::Internal::AnyHash),
-                ending_balance: T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
-                  MetronomeSDK::Internal::AnyHash
-                ),
-                entries: T::Array[T.any(MetronomeSDK::Models::V1::CreditLedgerEntry, MetronomeSDK::Internal::AnyHash)],
-                pending_entries: T::Array[T.any(MetronomeSDK::Models::V1::CreditLedgerEntry, MetronomeSDK::Internal::AnyHash)],
-                starting_balance: T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              )
-                .returns(T.attached_class)
+                credit_type:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType::OrHash,
+                ending_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance::OrHash,
+                entries:
+                  T::Array[
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry::OrHash
+                  ],
+                pending_entries:
+                  T::Array[
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry::OrHash
+                  ],
+                starting_balance:
+                  MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance::OrHash
+              ).returns(T.attached_class)
             end
             def self.new(
               credit_type:,
@@ -124,22 +195,65 @@ module MetronomeSDK
               entries:,
               pending_entries:,
               starting_balance:
-            ); end
+            )
+            end
+
             sig do
-              override
-                .returns(
-                  {
-                    credit_type: MetronomeSDK::Models::CreditTypeData,
-                    ending_balance: MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
-                    entries: T::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
-                    pending_entries: T::Array[MetronomeSDK::Models::V1::CreditLedgerEntry],
-                    starting_balance: MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance
-                  }
-                )
+              override.returns(
+                {
+                  credit_type:
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType,
+                  ending_balance:
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance,
+                  entries:
+                    T::Array[
+                      MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry
+                    ],
+                  pending_entries:
+                    T::Array[
+                      MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry
+                    ],
+                  starting_balance:
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class CreditType < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :id
+
+              sig { returns(String) }
+              attr_accessor :name
+
+              sig { params(id: String, name: String).returns(T.attached_class) }
+              def self.new(id:, name:)
+              end
+
+              sig { override.returns({ id: String, name: String }) }
+              def to_hash
+              end
             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) }
@@ -175,14 +289,197 @@ module MetronomeSDK
                 # the excluding_pending balance plus any pending invoice deductions and
                 # expirations that will happen by the effective_at date
                 including_pending:
-              ); end
+              )
+              end
+
               sig do
-                override.returns({effective_at: Time, excluding_pending: Float, including_pending: Float})
+                override.returns(
+                  {
+                    effective_at: Time,
+                    excluding_pending: Float,
+                    including_pending: Float
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            class Entry < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # an amount representing the change to the customer's credit balance
+              sig { returns(Float) }
+              attr_accessor :amount
+
+              sig { returns(String) }
+              attr_accessor :created_by
+
+              # the credit grant this entry is related to
+              sig { returns(String) }
+              attr_accessor :credit_grant_id
+
+              sig { returns(Time) }
+              attr_accessor :effective_at
+
+              sig { returns(String) }
+              attr_accessor :reason
+
+              # the running balance for this credit type at the time of the ledger entry,
+              # including all preceding charges
+              sig { returns(Float) }
+              attr_accessor :running_balance
+
+              # if this entry is a deduction, the Metronome ID of the invoice where the credit
+              # deduction was consumed; if this entry is a grant, the Metronome ID of the
+              # invoice where the grant's paid_amount was charged
+              sig { returns(T.nilable(String)) }
+              attr_accessor :invoice_id
+
+              sig do
+                params(
+                  amount: Float,
+                  created_by: String,
+                  credit_grant_id: String,
+                  effective_at: Time,
+                  reason: String,
+                  running_balance: Float,
+                  invoice_id: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # an amount representing the change to the customer's credit balance
+                amount:,
+                created_by:,
+                # the credit grant this entry is related to
+                credit_grant_id:,
+                effective_at:,
+                reason:,
+                # the running balance for this credit type at the time of the ledger entry,
+                # including all preceding charges
+                running_balance:,
+                # if this entry is a deduction, the Metronome ID of the invoice where the credit
+                # deduction was consumed; if this entry is a grant, the Metronome ID of the
+                # invoice where the grant's paid_amount was charged
+                invoice_id: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    amount: Float,
+                    created_by: String,
+                    credit_grant_id: String,
+                    effective_at: Time,
+                    reason: String,
+                    running_balance: Float,
+                    invoice_id: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+
+            class PendingEntry < MetronomeSDK::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                end
+
+              # an amount representing the change to the customer's credit balance
+              sig { returns(Float) }
+              attr_accessor :amount
+
+              sig { returns(String) }
+              attr_accessor :created_by
+
+              # the credit grant this entry is related to
+              sig { returns(String) }
+              attr_accessor :credit_grant_id
+
+              sig { returns(Time) }
+              attr_accessor :effective_at
+
+              sig { returns(String) }
+              attr_accessor :reason
+
+              # the running balance for this credit type at the time of the ledger entry,
+              # including all preceding charges
+              sig { returns(Float) }
+              attr_accessor :running_balance
+
+              # if this entry is a deduction, the Metronome ID of the invoice where the credit
+              # deduction was consumed; if this entry is a grant, the Metronome ID of the
+              # invoice where the grant's paid_amount was charged
+              sig { returns(T.nilable(String)) }
+              attr_accessor :invoice_id
+
+              sig do
+                params(
+                  amount: Float,
+                  created_by: String,
+                  credit_grant_id: String,
+                  effective_at: Time,
+                  reason: String,
+                  running_balance: Float,
+                  invoice_id: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # an amount representing the change to the customer's credit balance
+                amount:,
+                created_by:,
+                # the credit grant this entry is related to
+                credit_grant_id:,
+                effective_at:,
+                reason:,
+                # the running balance for this credit type at the time of the ledger entry,
+                # including all preceding charges
+                running_balance:,
+                # if this entry is a deduction, the Metronome ID of the invoice where the credit
+                # deduction was consumed; if this entry is a grant, the Metronome ID of the
+                # invoice where the grant's paid_amount was charged
+                invoice_id: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    amount: Float,
+                    created_by: String,
+                    credit_grant_id: String,
+                    effective_at: Time,
+                    reason: String,
+                    running_balance: Float,
+                    invoice_id: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
               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) }
@@ -215,11 +512,20 @@ module MetronomeSDK
                 # the excluding_pending balance plus any pending activity that has not been posted
                 # at the time of the query
                 including_pending:
-              ); end
+              )
+              end
+
               sig do
-                override.returns({effective_at: Time, excluding_pending: Float, including_pending: Float})
+                override.returns(
+                  {
+                    effective_at: Time,
+                    excluding_pending: Float,
+                    including_pending: Float
+                  }
+                )
+              end
+              def to_hash
               end
-              def to_hash; end
             end
           end
         end