Class: Trycourier::Models::ListListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Trycourier::Models::ListListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/trycourier/models/list_list_params.rb

Overview

See Also:

• Resources::Lists#list

Instance Attribute Summary

• #cursor ⇒ String^?

  A unique identifier that allows for fetching the next page of lists.

• #pattern ⇒ String^?

  “A pattern used to filter the list items returned.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(cursor: nil, pattern: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ListListParams 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(cursor: nil, pattern: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Trycourier::Models::ListListParams for more details.

Parameters:

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

  A unique identifier that allows for fetching the next page of lists.

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

  “A pattern used to filter the list items returned. Pattern types supported: exac

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

# File 'lib/trycourier/models/list_list_params.rb', line 25

Instance Attribute Details

#cursor ⇒ String^?

A unique identifier that allows for fetching the next page of lists.

Returns:

• (String, nil)

# File 'lib/trycourier/models/list_list_params.rb', line 14

optional :cursor, String, nil?: true

#pattern ⇒ String^?

“A pattern used to filter the list items returned. Pattern types supported: exact match on ‘list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match.”

Returns:

• (String, nil)

# File 'lib/trycourier/models/list_list_params.rb', line 23

optional :pattern, String, nil?: true