Class: Orb::Models::Licenses::UsageGetUsageParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/licenses/usage_get_usage_params.rb,
sig/orb/models/licenses/usage_get_usage_params.rbs

Overview

See Also:

  • Orb::Resources::Licenses::Usage#get_usage

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(license_id:, cursor: nil, end_date: nil, group_by: nil, limit: nil, start_date: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::Licenses::UsageGetUsageParams for more details.

Parameters:

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

    Pagination cursor from a previous request.

  • end_date (Date, nil) (defaults to: nil) —

    End date for the usage period (YYYY-MM-DD). Defaults to end of current billing p

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

    How to group the results. Valid values: 'license', 'day'. Can be combined (e.g.,

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

    Maximum number of rows in the response data (default 20, max 100).

  • start_date (Date, nil) (defaults to: nil) —

    Start date for the usage period (YYYY-MM-DD). Defaults to start of current billi

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



# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 49

Instance Attribute Details

#cursor ⇒ String?

Pagination cursor from a previous request.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


20
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 20

optional :cursor, String, nil?: true

#end_date ⇒ Date?

End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


27
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 27

optional :end_date, Date, nil?: true

#group_by ⇒ String?

How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day').

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


34
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 34

optional :group_by, String, nil?: true

#license_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


14
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 14

required :license_id, String

#limit ⇒ Integer?

Maximum number of rows in the response data (default 20, max 100).

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


40
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 40

optional :limit, Integer

#start_date ⇒ Date?

Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period.

Parameters:

  • value (Date, nil)

Returns:

  • (Date, nil) 


47
 
# File 'lib/orb/models/licenses/usage_get_usage_params.rb', line 47

optional :start_date, Date, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/orb/models/licenses/usage_get_usage_params.rbs', line 43

def to_hash: -> {