Class: Stigg::Models::V1::CreditListLedgerResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/stigg/models/v1/credit_list_ledger_response.rb

Overview

See Also:

Defined Under Namespace

Modules: EventType

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(amount:, credit_currency_id:, credit_grant_id:, customer_id:, event_id:, event_type:, feature_id:, resource_id:, timestamp:) ⇒ Object

A credit ledger event representing a change to credit balance

Parameters:

  • amount (Float) —

    The credit amount for this event

  • credit_currency_id (String) —

    The credit currency ID

  • credit_grant_id (String) —

    The credit grant ID associated with this event

  • customer_id (String) —

    The customer ID this event belongs to

  • event_id (String, nil) —

    The unique event identifier

  • event_type (Symbol, Stigg::Models::V1::CreditListLedgerResponse::EventType) —

    The type of credit event

  • feature_id (String, nil) —

    The feature ID associated with this event

  • resource_id (String, nil) —

    The resource ID this event is scoped to

  • timestamp (Time) —

    The timestamp when the event occurred




# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 64

Instance Attribute Details

#amount ⇒ Float

The credit amount for this event

Returns:

  • (Float) 


12
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 12

required :amount, Float

#credit_currency_id ⇒ String

The credit currency ID

Returns:

  • (String) 


18
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 18

required :credit_currency_id, String, api_name: :creditCurrencyId

#credit_grant_id ⇒ String

The credit grant ID associated with this event

Returns:

  • (String) 


24
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 24

required :credit_grant_id, String, api_name: :creditGrantId

#customer_id ⇒ String

The customer ID this event belongs to

Returns:

  • (String) 


30
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 30

required :customer_id, String, api_name: :customerId

#event_id ⇒ String?

The unique event identifier

Returns:

  • (String, nil) 


36
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 36

required :event_id, String, api_name: :eventId, nil?: true

#event_type ⇒ Symbol, Stigg::Models::V1::CreditListLedgerResponse::EventType

The type of credit event

Returns:



42
43
44
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 42

required :event_type,
enum: -> { Stigg::Models::V1::CreditListLedgerResponse::EventType },
api_name: :eventType

#feature_id ⇒ String?

The feature ID associated with this event

Returns:

  • (String, nil) 


50
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 50

required :feature_id, String, api_name: :featureId, nil?: true

#resource_id ⇒ String?

The resource ID this event is scoped to

Returns:

  • (String, nil) 


56
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 56

required :resource_id, String, api_name: :resourceId, nil?: true

#timestamp ⇒ Time

The timestamp when the event occurred

Returns:

  • (Time) 


62
 
# File 'lib/stigg/models/v1/credit_list_ledger_response.rb', line 62

required :timestamp, Time