Class: Stigg::Models::V1::Credits::ConsumptionConsumeParams

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

Overview

See Also:

  • Stigg::Resources::V1::Credits::Consumption#consume

Defined Under Namespace

Modules: Dimension

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 ⇒ Object 



53
 
# File 'sig/stigg/models/v1/credits/consumption_consume_params.rbs', line 53

def initialize: (

Instance Attribute Details

#amount ⇒ Float

The amount of credits to consume

Parameters:

  • value (Float)

Returns:

  • (Float) 


16
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 16

required :amount, Float

#created_at ⇒ Time?

Optional timestamp the consumption is attributed to

Parameters:

  • (Time)

Returns:

  • (Time, nil) 


40
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 40

optional :created_at, Time, api_name: :createdAt

#currency_id ⇒ String

The credit currency to consume from (required)

Parameters:

  • value (String)

Returns:

  • (String) 


22
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 22

required :currency_id, String, api_name: :currencyId

#customer_id ⇒ String

The customer to consume credits from (required)

Parameters:

  • value (String)

Returns:

  • (String) 


28
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 28

required :customer_id, String, api_name: :customerId

#dimensions ⇒ Hash{Symbol=>String, Float, Boolean}?

Optional dimensions describing the consumption

Returns:

  • (Hash{Symbol=>String, Float, Boolean}, nil) 


46
47
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 46

optional :dimensions,
-> { Stigg::Internal::Type::HashOf[union: Stigg::V1::Credits::ConsumptionConsumeParams::Dimension] }

#idempotency_key ⇒ String

A unique key used to deduplicate the consumption (required)

Parameters:

  • value (String)

Returns:

  • (String) 


34
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 34

required :idempotency_key, String, api_name: :idempotencyKey

#resource_id ⇒ String?

Optional resource the consumption is attributed to

Parameters:

  • (String)

Returns:

  • (String, nil) 


53
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 53

optional :resource_id, String, api_name: :resourceId

#x_account_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


58
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 58

optional :x_account_id, String

#x_environment_id ⇒ String?

Parameters:

  • (String)

Returns:

  • (String, nil) 


63
 
# File 'lib/stigg/models/v1/credits/consumption_consume_params.rb', line 63

optional :x_environment_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


66
 
# File 'sig/stigg/models/v1/credits/consumption_consume_params.rbs', line 66

def to_hash: -> {