Class: MetronomeSDK::Models::V1::ContractListSeatBalancesParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb,
sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs

Overview

See Also:

  • MetronomeSDK::Resources::V1::Contracts#list_seat_balances

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::MetronomeSDK

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(contract_id:, customer_id:, covering_date: nil, cursor: nil, effective_before: nil, include_credits_and_commits: nil, include_ledgers: nil, limit: nil, seat_ids: nil, skip_missing_seat_ids: nil, starting_at: nil, subscription_ids: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see MetronomeSDK::Models::V1::ContractListSeatBalancesParams for more details.

Parameters:

  • contract_id (String) —

    The contract ID to retrieve seat balances for

  • customer_id (String) —

    The customer ID to retrieve seat balances for

  • covering_date (Time) (defaults to: nil) —

    Include only commits or credits with access that cover this specific date (canno

  • cursor (String) (defaults to: nil) —

    Page token from a previous response to retrieve the next page

  • effective_before (Time) (defaults to: nil) —

    Include only commits or credits with access effective on or before this date (ca

  • include_credits_and_commits (Boolean) (defaults to: nil) —

    Include credits and commits in the response

  • include_ledgers (Boolean) (defaults to: nil) —

    Include ledger entries for each commit and commit. include_credits_and_commits

  • limit (Integer) (defaults to: nil) —

    Maximum number of seats to return. Range: 1-100. Default: 25.

  • seat_ids (Array<String>) (defaults to: nil) —

    Optional filter to only include specific seats.

  • skip_missing_seat_ids (Boolean) (defaults to: nil) —

    When true, any seat_ids not found in contract subscriptions will be silently omi

  • starting_at (Time) (defaults to: nil) —

    Include only commits or credits with access effective on or after this date (can

  • subscription_ids (Array<String>) (defaults to: nil) —

    Optional filter to only include seats from specific subscriptions. If subscripti

  • request_options (MetronomeSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 96

Instance Attribute Details

#contract_id ⇒ String

The contract ID to retrieve seat balances for

Parameters:

  • value (String)

Returns:

  • (String) 


15
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 15

required :contract_id, String

#covering_date ⇒ Time?

Include only commits or credits with access that cover this specific date (cannot be used with starting_at or ending_before).

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


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

optional :covering_date, Time

#cursor ⇒ String?

Page token from a previous response to retrieve the next page

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :cursor, String

#customer_id ⇒ String

The customer ID to retrieve seat balances for

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 21

required :customer_id, String

#effective_before ⇒ Time?

Include only commits or credits with access effective on or before this date (cannot be used with covering_date).

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


41
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 41

optional :effective_before, Time

#include_credits_and_commits ⇒ Boolean?

Include credits and commits in the response

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


47
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 47

optional :include_credits_and_commits, MetronomeSDK::Internal::Type::Boolean

#include_ledgers ⇒ Boolean?

Include ledger entries for each commit and commit. include_credits_and_commits must be set to true for include_ledgers=true to apply.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


54
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 54

optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean

#limit ⇒ Integer?

Maximum number of seats to return. Range: 1-100. Default: 25. When include_credits_and_commits = true, if the total commits/credits across all seats exceeds 100, a limit of 100 applies to the total credits and commits. Seats are included greedily to maximize the number of seats returned. Example: if seat 1 has 98 commits and seat 2 has 10 commits, both seats will be returned (total: 108 commits). Each returned seat includes all of its associated credits and commits.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


66
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 66

optional :limit, Integer

#seat_ids ⇒ Array<String>?

Optional filter to only include specific seats.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


72
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 72

optional :seat_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

#skip_missing_seat_ids ⇒ Boolean?

When true, any seat_ids not found in contract subscriptions will be silently omitted from the response instead of returning a 400 error.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


79
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 79

optional :skip_missing_seat_ids, MetronomeSDK::Internal::Type::Boolean

#starting_at ⇒ Time?

Include only commits or credits with access effective on or after this date (cannot be used with covering_date).

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


86
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 86

optional :starting_at, Time

#subscription_ids ⇒ Array<String>?

Optional filter to only include seats from specific subscriptions. If subscriptions ids are not mapped to SEAT_BASED subscriptions, error will be returned.

Parameters:

  • (::Array[String])

Returns:

  • (Array<String>, nil) 


94
 
# File 'lib/metronome_sdk/models/v1/contract_list_seat_balances_params.rb', line 94

optional :subscription_ids, MetronomeSDK::Internal::Type::ArrayOf[String]

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


85
 
# File 'sig/metronome_sdk/models/v1/contract_list_seat_balances_params.rbs', line 85

def to_hash: -> {