Class: Stigg::Models::V1::UsageHistoryParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/stigg/models/v1/usage_history_params.rb

Overview

See Also:

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(customer_id:, feature_id:, start_date:, end_date: nil, group_by: nil, resource_id: nil, request_options: {}) ⇒ Object

Parameters:

  • customer_id (String)
  • feature_id (String)
  • start_date (Time) —

    The start date of the range

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

    The end date of the range

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

    Criteria by which to group the usage history

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

    Resource id

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



# File 'lib/stigg/models/v1/usage_history_params.rb', line 45

Instance Attribute Details

#customer_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/stigg/models/v1/usage_history_params.rb', line 14

required :customer_id, String

#end_date ⇒ Time?

The end date of the range

Returns:

  • (Time, nil) 


31
 
# File 'lib/stigg/models/v1/usage_history_params.rb', line 31

optional :end_date, Time

#feature_id ⇒ String

Returns:

  • (String) 


19
 
# File 'lib/stigg/models/v1/usage_history_params.rb', line 19

required :feature_id, String

#group_by ⇒ String?

Criteria by which to group the usage history

Returns:

  • (String, nil) 


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

optional :group_by, String

#resource_id ⇒ String?

Resource id

Returns:

  • (String, nil) 


43
 
# File 'lib/stigg/models/v1/usage_history_params.rb', line 43

optional :resource_id, String, nil?: true

#start_date ⇒ Time

The start date of the range

Returns:

  • (Time) 


25
 
# File 'lib/stigg/models/v1/usage_history_params.rb', line 25

required :start_date, Time