Class: Courier::Models::Automations::RunListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/automations/run_list_params.rb,
sig/courier/models/automations/run_list_params.rbs

Overview

See Also:

  • Courier::Resources::Automations::Runs#list

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

Some parameter documentations has been truncated, see Courier::Models::Automations::RunListParams for more details.

Parameters:

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

    A cursor token for pagination. Use the next_cursor from the previous response

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

    An inclusive upper bound on created_at, in the same format as start_date.

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

    The number of runs to return per page, between 1 and 50. Defaults to 20. V

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

    An inclusive lower bound on created_at, as an ISO 8601 date or timestamp (e.g.

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

    A comma-separated list of run statuses to filter on, e.g. PROCESSED,ERROR.

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

    A comma-separated list of Automation Template ids to filter on.

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



# File 'lib/courier/models/automations/run_list_params.rb', line 51

Instance Attribute Details

#cursor ⇒ String?

A cursor token for pagination. Use the next_cursor from the previous response to fetch the next page of results. Treat it as opaque.

Parameters:

  • (String)

Returns:

  • (String, nil) 


16
 
# File 'lib/courier/models/automations/run_list_params.rb', line 16

optional :cursor, String

#end_date ⇒ String?

An inclusive upper bound on created_at, in the same format as start_date.

Parameters:

  • (String)

Returns:

  • (String, nil) 


22
 
# File 'lib/courier/models/automations/run_list_params.rb', line 22

optional :end_date, String

#limit ⇒ String?

The number of runs to return per page, between 1 and 50. Defaults to 20. Values outside the range are clamped, and a non-numeric value falls back to 20.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/courier/models/automations/run_list_params.rb', line 30

optional :limit, String

#start_date ⇒ String?

An inclusive lower bound on created_at, as an ISO 8601 date or timestamp (e.g. 2026-08-18 or 2026-08-18T20:06:36.259Z). Any other format returns 400.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/courier/models/automations/run_list_params.rb', line 37

optional :start_date, String

#status ⇒ String?

A comma-separated list of run statuses to filter on, e.g. PROCESSED,ERROR.

Parameters:

  • (String)

Returns:

  • (String, nil) 


43
 
# File 'lib/courier/models/automations/run_list_params.rb', line 43

optional :status, String

#template_id ⇒ String?

A comma-separated list of Automation Template ids to filter on.

Parameters:

  • (String)

Returns:

  • (String, nil) 


49
 
# File 'lib/courier/models/automations/run_list_params.rb', line 49

optional :template_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


53
 
# File 'sig/courier/models/automations/run_list_params.rbs', line 53

def to_hash: -> {