Class: MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data

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

Defined Under Namespace

Classes: Balance, Commit, Credit

Instance Attribute Summary collapse

Class Method 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(balance:, credit_type_id:, starting_balance:) ⇒ Object

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

Parameters:

  • balance (Float) —

    The total balance across all commits and credits for this seat, of this credit t

  • credit_type_id (String)
  • starting_balance (Float) —

    The total initial balances of all commits and credits for this seat, of this cre



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb', line 23

class Data < MetronomeSDK::Internal::Type::BaseModel
  # @!attribute balances
  #
  #   @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance>]
  required :balances,
           -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance] }

  # @!attribute seat_id
  #   The unique identifier for the seat
  #
  #   @return [String]
  required :seat_id, String

  # @!attribute commits
  #   Array of commits applicable to this seat with their balances
  #
  #   @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit>, nil]
  optional :commits,
           -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit] },
           nil?: true

  # @!attribute credits
  #   Array of credits applicable to this seat with their balances
  #
  #   @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit>, nil]
  optional :credits,
           -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit] }

  # @!method initialize(balances:, seat_id:, commits: nil, credits: nil)
  #   @param balances [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance>]
  #
  #   @param seat_id [String] The unique identifier for the seat
  #
  #   @param commits [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit>, nil] Array of commits applicable to this seat with their balances
  #
  #   @param credits [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit>] Array of credits applicable to this seat with their balances

  class Balance < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute balance
    #   The total balance across all commits and credits for this seat, of this credit
    #   type.
    #
    #   @return [Float]
    required :balance, Float

    # @!attribute credit_type_id
    #
    #   @return [String]
    required :credit_type_id, String

    # @!attribute starting_balance
    #   The total initial balances of all commits and credits for this seat, of this
    #   credit type.
    #
    #   @return [Float]
    required :starting_balance, Float

    # @!method initialize(balance:, credit_type_id:, starting_balance:)
    #   Some parameter documentations has been truncated, see
    #   {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance} for
    #   more details.
    #
    #   @param balance [Float] The total balance across all commits and credits for this seat, of this credit t
    #
    #   @param credit_type_id [String]
    #
    #   @param starting_balance [Float] The total initial balances of all commits and credits for this seat, of this cre
  end

  class Commit < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute id
    #   The commit or credit ID
    #
    #   @return [String]
    required :id, String

    # @!attribute balance
    #   The current balance for this commit for this specific seat
    #
    #   @return [Float]
    required :balance, Float

    # @!attribute start_date
    #   The datetime when the commit becomes active
    #
    #   @return [Time]
    required :start_date, Time

    # @!attribute end_date
    #   The datetime when the commit expires
    #
    #   @return [Time, nil]
    optional :end_date, Time, nil?: true

    # @!attribute ledger_entries
    #   Transaction history for this commit for this seat (only included if
    #   include_ledgers=true)
    #
    #   @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry>, nil]
    optional :ledger_entries,
             -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry] }

    # @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
    #   Some parameter documentations has been truncated, see
    #   {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit} for
    #   more details.
    #
    #   @param id [String] The commit or credit ID
    #
    #   @param balance [Float] The current balance for this commit for this specific seat
    #
    #   @param start_date [Time] The datetime when the commit becomes active
    #
    #   @param end_date [Time, nil] The datetime when the commit expires
    #
    #   @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry>] Transaction history for this commit for this seat (only included if include_ledg

    class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #   Amount of the ledger entry
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute timestamp
      #   The datetime when the ledger is created
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #   Commit ledger type
      #
      #   @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type }

      # @!method initialize(amount:, timestamp:, type:)
      #   @param amount [Float] Amount of the ledger entry
      #
      #   @param timestamp [Time] The datetime when the ledger is created
      #
      #   @param type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry::Type] Commit ledger type

      # Commit ledger type
      #
      # @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit::LedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        PREPAID_COMMIT_SEGMENT_START = :PREPAID_COMMIT_SEGMENT_START
        PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION = :PREPAID_COMMIT_AUTOMATED_INVOICE_DEDUCTION
        PREPAID_COMMIT_ROLLOVER = :PREPAID_COMMIT_ROLLOVER
        PREPAID_COMMIT_EXPIRATION = :PREPAID_COMMIT_EXPIRATION
        PREPAID_COMMIT_CANCELED = :PREPAID_COMMIT_CANCELED
        PREPAID_COMMIT_CREDITED = :PREPAID_COMMIT_CREDITED
        PREPAID_COMMIT_MANUAL = :PREPAID_COMMIT_MANUAL
        PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT = :PREPAID_COMMIT_SEAT_BASED_ADJUSTMENT

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end
  end

  class Credit < MetronomeSDK::Internal::Type::BaseModel
    # @!attribute id
    #   The credit ID
    #
    #   @return [String]
    required :id, String

    # @!attribute balance
    #   The current balance for this credit for this specific seat
    #
    #   @return [Float]
    required :balance, Float

    # @!attribute start_date
    #   The datetime when the credit becomes active
    #
    #   @return [Time]
    required :start_date, Time

    # @!attribute end_date
    #   The datetime when the credit expires
    #
    #   @return [Time, nil]
    optional :end_date, Time, nil?: true

    # @!attribute ledger_entries
    #   Transaction history for this credit for this seat (only included if
    #   include_ledgers=true)
    #
    #   @return [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry>, nil]
    optional :ledger_entries,
             -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry] }

    # @!method initialize(id:, balance:, start_date:, end_date: nil, ledger_entries: nil)
    #   Some parameter documentations has been truncated, see
    #   {MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit} for
    #   more details.
    #
    #   @param id [String] The credit ID
    #
    #   @param balance [Float] The current balance for this credit for this specific seat
    #
    #   @param start_date [Time] The datetime when the credit becomes active
    #
    #   @param end_date [Time, nil] The datetime when the credit expires
    #
    #   @param ledger_entries [Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry>] Transaction history for this credit for this seat (only included if include_ledg

    class LedgerEntry < MetronomeSDK::Internal::Type::BaseModel
      # @!attribute amount
      #   Amount of the ledger entry
      #
      #   @return [Float]
      required :amount, Float

      # @!attribute timestamp
      #   The datetime when the ledger is created
      #
      #   @return [Time]
      required :timestamp, Time

      # @!attribute type
      #   Credit ledger type
      #
      #   @return [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type]
      required :type,
               enum: -> { MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type }

      # @!method initialize(amount:, timestamp:, type:)
      #   @param amount [Float] Amount of the ledger entry
      #
      #   @param timestamp [Time] The datetime when the ledger is created
      #
      #   @param type [Symbol, MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry::Type] Credit ledger type

      # Credit ledger type
      #
      # @see MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit::LedgerEntry#type
      module Type
        extend MetronomeSDK::Internal::Type::Enum

        CREDIT_SEGMENT_START = :CREDIT_SEGMENT_START
        CREDIT_AUTOMATED_INVOICE_DEDUCTION = :CREDIT_AUTOMATED_INVOICE_DEDUCTION
        CREDIT_EXPIRATION = :CREDIT_EXPIRATION
        CREDIT_CANCELED = :CREDIT_CANCELED
        CREDIT_CREDITED = :CREDIT_CREDITED
        CREDIT_MANUAL = :CREDIT_MANUAL
        CREDIT_SEAT_BASED_ADJUSTMENT = :CREDIT_SEAT_BASED_ADJUSTMENT
        CREDIT_ROLLOVER = :CREDIT_ROLLOVER

        # @!method self.values
        #   @return [Array<Symbol>]
      end
    end
  end
end

Instance Attribute Details

#balances ⇒ Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance>

Returns:



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

required :balances,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Balance] }

#commits ⇒ Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit>?

Array of commits applicable to this seat with their balances

Returns:



40
41
42
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb', line 40

optional :commits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Commit] },
nil?: true

#credits ⇒ Array<MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit>?

Array of credits applicable to this seat with their balances

Returns:



48
49
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb', line 48

optional :credits,
-> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListSeatBalancesResponse::Data::Credit] }

#seat_id ⇒ String

The unique identifier for the seat

Returns:

  • (String) 


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

required :seat_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_response.rb', line 182