Class: Notiflows::Models::DeliveryListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/notiflows/models/delivery_list_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(after: nil, before: nil, channel_id: nil, created_after: nil, created_before: nil, limit: nil, status: nil, topic: nil, request_options: {}) ⇒ Object

Parameters:

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

    Cursor for fetching the next page

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

    Cursor for fetching the previous page

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

    Filter by channel ID (UUID)

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

    Filter by created after (ISO 8601 datetime)

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

    Filter by created before (ISO 8601 datetime)

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

    Number of items per page (default: 25, max: 1000)

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

    Filter by status (pending, sent, failed)

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

    Filter by topic name

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



# File 'lib/notiflows/models/delivery_list_params.rb', line 58

Instance Attribute Details

#after ⇒ String?

Cursor for fetching the next page

Returns:

  • (String, nil) 


14
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 14

optional :after, String

#before ⇒ String?

Cursor for fetching the previous page

Returns:

  • (String, nil) 


20
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 20

optional :before, String

#channel_id ⇒ String?

Filter by channel ID (UUID)

Returns:

  • (String, nil) 


26
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 26

optional :channel_id, String

#created_after ⇒ String?

Filter by created after (ISO 8601 datetime)

Returns:

  • (String, nil) 


32
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 32

optional :created_after, String

#created_before ⇒ String?

Filter by created before (ISO 8601 datetime)

Returns:

  • (String, nil) 


38
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 38

optional :created_before, String

#limit ⇒ Integer?

Number of items per page (default: 25, max: 1000)

Returns:

  • (Integer, nil) 


44
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 44

optional :limit, Integer

#status ⇒ String?

Filter by status (pending, sent, failed)

Returns:

  • (String, nil) 


50
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 50

optional :status, String

#topic ⇒ String?

Filter by topic name

Returns:

  • (String, nil) 


56
 
# File 'lib/notiflows/models/delivery_list_params.rb', line 56

optional :topic, String