Class: Stigg::Models::V1::Events::CreditGetUsageParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Stigg::Models::V1::Events::CreditGetUsageParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/stigg/models/v1/events/credit_get_usage_params.rb

Overview

See Also:

• Resources::V1::Events::Credits#get_usage

Defined Under Namespace

Modules: TimeRange

Instance Attribute Summary

• #currency_id ⇒ String^?

  Filter by currency ID.

• #customer_id ⇒ String

  Filter by customer ID (required).

• #resource_id ⇒ String^?

  Filter by resource ID.

• #time_range ⇒ Symbol, ...

  Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(customer_id:, currency_id: nil, resource_id: nil, time_range: nil, request_options: {}) ⇒ Object constructor

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

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(customer_id:, currency_id: nil, resource_id: nil, time_range: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Stigg::Models::V1::Events::CreditGetUsageParams for more details.

Parameters:

• customer_id (String) —

  Filter by customer ID (required)

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

  Filter by currency ID

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

  Filter by resource ID

• time_range (Symbol, Stigg::Models::V1::Events::CreditGetUsageParams::TimeRange) (defaults to: nil) —

  Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults

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

# File 'lib/stigg/models/v1/events/credit_get_usage_params.rb', line 37

Instance Attribute Details

#currency_id ⇒ String^?

Filter by currency ID

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/events/credit_get_usage_params.rb', line 22

optional :currency_id, String

#customer_id ⇒ String

Filter by customer ID (required)

Returns:

• (String)

# File 'lib/stigg/models/v1/events/credit_get_usage_params.rb', line 16

required :customer_id, String

#resource_id ⇒ String^?

Filter by resource ID

Returns:

• (String, nil)

# File 'lib/stigg/models/v1/events/credit_get_usage_params.rb', line 28

optional :resource_id, String

#time_range ⇒ Symbol, ...

Time range for usage data (LAST_DAY, LAST_WEEK, LAST_MONTH, LAST_YEAR). Defaults to LAST_MONTH

Returns:

• (Symbol, Stigg::Models::V1::Events::CreditGetUsageParams::TimeRange, nil)

# File 'lib/stigg/models/v1/events/credit_get_usage_params.rb', line 35

optional :time_range, enum: -> { Stigg::V1::Events::CreditGetUsageParams::TimeRange }