Class: Dodopayments::Models::UsageEventListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::UsageEventListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/usage_event_list_params.rb

Overview

See Also:

• Resources::UsageEvents#list

Instance Attribute Summary

• #customer_id ⇒ String^?

  Filter events by customer ID.

• #end_ ⇒ Time^?

  Filter events created before this timestamp.

• #event_name ⇒ String^?

  Filter events by event name.

• #meter_id ⇒ String^?

  Filter events by meter ID.

• #page_number ⇒ Integer^?

  Page number (0-based, default: 0).

• #page_size ⇒ Integer^?

  Number of events to return per page (default: 10).

• #start ⇒ Time^?

  Filter events created after this timestamp.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(customer_id: nil, end_: nil, event_name: nil, meter_id: nil, page_number: nil, page_size: nil, start: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see UsageEventListParams 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: nil, end_: nil, event_name: nil, meter_id: nil, page_number: nil, page_size: nil, start: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::UsageEventListParams for more details.

Parameters:

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

  Filter events by customer ID

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

  Filter events created before this timestamp

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

  Filter events by event name. If both event_name and meter_id are provided, they

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

  Filter events by meter ID. When provided, only events that match the meter’s eve

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

  Page number (0-based, default: 0)

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

  Number of events to return per page (default: 10)

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

  Filter events created after this timestamp

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

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 54

Instance Attribute Details

#customer_id ⇒ String^?

Filter events by customer ID

Returns:

• (String, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 14

optional :customer_id, String

#end_ ⇒ Time^?

Filter events created before this timestamp

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 20

optional :end_, Time

#event_name ⇒ String^?

Filter events by event name. If both event_name and meter_id are provided, they must match the meter’s configured event_name

Returns:

• (String, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 27

optional :event_name, String

#meter_id ⇒ String^?

Filter events by meter ID. When provided, only events that match the meter’s event_name and filter criteria will be returned

Returns:

• (String, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 34

optional :meter_id, String

#page_number ⇒ Integer^?

Page number (0-based, default: 0)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 40

optional :page_number, Integer

#page_size ⇒ Integer^?

Number of events to return per page (default: 10)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 46

optional :page_size, Integer

#start ⇒ Time^?

Filter events created after this timestamp

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/usage_event_list_params.rb', line 52

optional :start, Time