Class: Orb::Models::AlertListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Orb::Models::AlertListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/orb/models/alert_list_params.rb

Overview

See Also:

• Resources::Alerts#list

Instance Attribute Summary

• #created_at_gt ⇒ Time^?
• #created_at_gte ⇒ Time^?
• #created_at_lt ⇒ Time^?
• #created_at_lte ⇒ Time^?
• #cursor ⇒ String^?

  Cursor for pagination.

• #customer_id ⇒ String^?

  Fetch alerts scoped to this customer_id.

• #external_customer_id ⇒ String^?

  Fetch alerts scoped to this external_customer_id.

• #limit ⇒ Integer^?

  The number of items to fetch.

• #subscription_id ⇒ String^?

  Fetch alerts scoped to this subscription_id.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AlertListParams 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(created_at_gt: nil, created_at_gte: nil, created_at_lt: nil, created_at_lte: nil, cursor: nil, customer_id: nil, external_customer_id: nil, limit: nil, subscription_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::AlertListParams for more details.

Parameters:

• created_at_gt (Time, nil) (defaults to: nil)
• created_at_gte (Time, nil) (defaults to: nil)
• created_at_lt (Time, nil) (defaults to: nil)
• created_at_lte (Time, nil) (defaults to: nil)
• cursor (String, nil) (defaults to: nil) —

  Cursor for pagination. This can be populated by the ‘next_cursor` value returned

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

  Fetch alerts scoped to this customer_id

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

  Fetch alerts scoped to this external_customer_id

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

  The number of items to fetch. Defaults to 20.

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

  Fetch alerts scoped to this subscription_id

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

# File 'lib/orb/models/alert_list_params.rb', line 61

Instance Attribute Details

#created_at_gt ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/orb/models/alert_list_params.rb', line 13

optional :created_at_gt, Time, nil?: true

#created_at_gte ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/orb/models/alert_list_params.rb', line 18

optional :created_at_gte, Time, nil?: true

#created_at_lt ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/orb/models/alert_list_params.rb', line 23

optional :created_at_lt, Time, nil?: true

#created_at_lte ⇒ Time^?

Returns:

• (Time, nil)

# File 'lib/orb/models/alert_list_params.rb', line 28

optional :created_at_lte, Time, nil?: true

#cursor ⇒ String^?

Cursor for pagination. This can be populated by the ‘next_cursor` value returned from the initial request.

Returns:

• (String, nil)

# File 'lib/orb/models/alert_list_params.rb', line 35

optional :cursor, String, nil?: true

#customer_id ⇒ String^?

Fetch alerts scoped to this customer_id

Returns:

• (String, nil)

# File 'lib/orb/models/alert_list_params.rb', line 41

optional :customer_id, String, nil?: true

#external_customer_id ⇒ String^?

Fetch alerts scoped to this external_customer_id

Returns:

• (String, nil)

# File 'lib/orb/models/alert_list_params.rb', line 47

optional :external_customer_id, String, nil?: true

#limit ⇒ Integer^?

The number of items to fetch. Defaults to 20.

Returns:

• (Integer, nil)

# File 'lib/orb/models/alert_list_params.rb', line 53

optional :limit, Integer

#subscription_id ⇒ String^?

Fetch alerts scoped to this subscription_id

Returns:

• (String, nil)

# File 'lib/orb/models/alert_list_params.rb', line 59

optional :subscription_id, String, nil?: true