Class: MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb

Defined Under Namespace

Classes: EndingBalance, StartingBalance

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(effective_at: , excluding_pending: , including_pending: ) ⇒ Object

Some parameter documentations has been truncated, see EndingBalance for more details.

the effective balances at the end of the specified time window

Parameters:

  • effective_at (Time) (defaults to: ) —

    the ending_before request parameter (if supplied) or the current billing period’

  • excluding_pending (Float) (defaults to: ) —

    the ending balance, including the balance of all grants that have not expired be

  • including_pending (Float) (defaults to: ) —

    the excluding_pending balance plus any pending invoice deductions and expiration



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 23

class Ledger < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute credit_type
  #
  #   @return [MetronomeSDK::Models::CreditTypeData]
  required :credit_type, -> { MetronomeSDK::CreditTypeData }

  # @!attribute ending_balance
  #   the effective balances at the end of the specified time window
  #
  #   @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance]
  required :ending_balance,
           -> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance }

  # @!attribute entries
  #
  #   @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
  required :entries, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

  # @!attribute pending_entries
  #
  #   @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
  required :pending_entries,
           -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

  # @!attribute starting_balance
  #
  #   @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance]
  required :starting_balance,
           -> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance }

  # @!method initialize(credit_type:, ending_balance:, entries:, pending_entries:, starting_balance:)
  #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
  #
  #   @param ending_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance] the effective balances at the end of the specified time window
  #
  #   @param entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
  #
  #   @param pending_entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
  #
  #   @param starting_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance]

  # @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger#ending_balance
  class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute effective_at
    #   the ending_before request parameter (if supplied) or the current billing
    #   period's end date
    #
    #   @return [Time]
    required :effective_at, Time

    # @!attribute excluding_pending
    #   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
    #
    #   @return [Float]
    required :excluding_pending, Float

    # @!attribute including_pending
    #   the excluding_pending balance plus any pending invoice deductions and
    #   expirations that will happen by the effective_at date
    #
    #   @return [Float]
    required :including_pending, Float

    # @!method initialize(effective_at:, excluding_pending:, including_pending:)
    #   Some parameter documentations has been truncated, see
    #   {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance}
    #   for more details.
    #
    #   the effective balances at the end of the specified time window
    #
    #   @param effective_at [Time] the ending_before request parameter (if supplied) or the current billing period'
    #
    #   @param excluding_pending [Float] the ending balance, including the balance of all grants that have not expired be
    #
    #   @param including_pending [Float] the excluding_pending balance plus any pending invoice deductions and expiration
  end

  # @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger#starting_balance
  class StartingBalance < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute effective_at
    #   the starting_on request parameter (if supplied) or the first credit grant's
    #   effective_at date
    #
    #   @return [Time]
    required :effective_at, Time

    # @!attribute excluding_pending
    #   the starting balance, including all posted grants, deductions, and expirations
    #   that happened at or before the effective_at timestamp
    #
    #   @return [Float]
    required :excluding_pending, Float

    # @!attribute including_pending
    #   the excluding_pending balance plus any pending activity that has not been posted
    #   at the time of the query
    #
    #   @return [Float]
    required :including_pending, Float

    # @!method initialize(effective_at:, excluding_pending:, including_pending:)
    #   Some parameter documentations has been truncated, see
    #   {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance}
    #   for more details.
    #
    #   @param effective_at [Time] the starting_on request parameter (if supplied) or the first credit grant's effe
    #
    #   @param excluding_pending [Float] the starting balance, including all posted grants, deductions, and expirations t
    #
    #   @param including_pending [Float] the excluding_pending balance plus any pending activity that has not been posted
  end
end

Instance Attribute Details

#credit_type ⇒ MetronomeSDK::Models::CreditTypeData

Returns:



27
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 27

required :credit_type, -> { MetronomeSDK::CreditTypeData }

#ending_balance ⇒ MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance

the effective balances at the end of the specified time window

Returns:



33
34
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 33

required :ending_balance,
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::EndingBalance }

#entries ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>

Returns:



39
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 39

required :entries, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

#pending_entries ⇒ Array<MetronomeSDK::Models::V1::CreditLedgerEntry>

Returns:



44
45
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 44

required :pending_entries,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CreditLedgerEntry] }

#starting_balance ⇒ MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance

Returns:



50
51
 
# File 'lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb', line 50

required :starting_balance,
-> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Ledger::StartingBalance }