Class: Courier::Models::Providers::CatalogListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/courier/models/providers/catalog_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(channel: nil, keys: nil, name: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Courier::Models::Providers::CatalogListParams for more details.

Parameters:

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

    Exact match (case-insensitive) against the provider channel taxonomy (e.g. ‘emai

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

    Comma-separated provider keys to filter by (e.g. ‘sendgrid,twilio`).

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

    Case-insensitive substring match against the provider display name.

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



# File 'lib/courier/models/providers/catalog_list_params.rb', line 30

Instance Attribute Details

#channel ⇒ String?

Exact match (case-insensitive) against the provider channel taxonomy (e.g. ‘email`, `sms`, `push`).

Returns:

  • (String, nil) 


16
 
# File 'lib/courier/models/providers/catalog_list_params.rb', line 16

optional :channel, String

#keys ⇒ String?

Comma-separated provider keys to filter by (e.g. ‘sendgrid,twilio`).

Returns:

  • (String, nil) 


22
 
# File 'lib/courier/models/providers/catalog_list_params.rb', line 22

optional :keys, String

#name ⇒ String?

Case-insensitive substring match against the provider display name.

Returns:

  • (String, nil) 


28
 
# File 'lib/courier/models/providers/catalog_list_params.rb', line 28

optional :name, String