Class: Straddle::Models::CapabilityRequestListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Straddle::Models::CapabilityRequestListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/straddle/models/capability_request_list_params.rb,
sig/straddle/models/capability_request_list_params.rbs

Overview

See Also:

• Straddle::Resources::CapabilityRequests#list

Defined Under Namespace

Modules: Category, SortOrder, Status, Type

Instance Attribute Summary

• #account_id ⇒ String
• #category ⇒ Symbol, ...

  Capability category to return.

• #correlation_id ⇒ String^?

  Optional client-generated identifier for tracing a series of related requests.

• #page_number ⇒ Integer^?

  Page number.

• #page_size ⇒ Integer^?

  Number of results per page.

• #request_id ⇒ String^?

  Optional client-generated identifier for tracing one request.

• #sort_by ⇒ String^?

  Field used to sort results.

• #sort_order ⇒ Symbol, ...

  Sort direction.

• #status ⇒ Symbol, ...

  Capability request status to return.

• #type ⇒ Symbol, ...

  Capability type to return.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/straddle/models/capability_request_list_params.rbs', line 68

def initialize: (

Instance Attribute Details

#account_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/capability_request_list_params.rb', line 13

required :account_id, String

#category ⇒ Symbol, ...

Capability category to return.

Returns:

• (Symbol, Straddle::Models::CapabilityRequestListParams::Category, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 19

optional :category, enum: -> { Straddle::CapabilityRequestListParams::Category }

#correlation_id ⇒ String^?

Optional client-generated identifier for tracing a series of related requests.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 61

optional :correlation_id, String

#page_number ⇒ Integer^?

Page number. Defaults to 1.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 25

optional :page_number, Integer

#page_size ⇒ Integer^?

Number of results per page. Defaults to 100. Maximum 1000.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 31

optional :page_size, Integer

#request_id ⇒ String^?

Optional client-generated identifier for tracing one request.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 67

optional :request_id, String

#sort_by ⇒ String^?

Field used to sort results. Defaults to id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 37

optional :sort_by, String

#sort_order ⇒ Symbol, ...

Sort direction. Defaults to asc.

Returns:

• (Symbol, Straddle::Models::CapabilityRequestListParams::SortOrder, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 43

optional :sort_order, enum: -> { Straddle::CapabilityRequestListParams::SortOrder }

#status ⇒ Symbol, ...

Capability request status to return.

Returns:

• (Symbol, Straddle::Models::CapabilityRequestListParams::Status, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 49

optional :status, enum: -> { Straddle::CapabilityRequestListParams::Status }

#type ⇒ Symbol, ...

Capability type to return.

Returns:

• (Symbol, Straddle::Models::CapabilityRequestListParams::Type, nil)

# File 'lib/straddle/models/capability_request_list_params.rb', line 55

optional :type, enum: -> { Straddle::CapabilityRequestListParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/straddle/models/capability_request_list_params.rb', line 99

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/straddle/models/capability_request_list_params.rbs', line 82

def to_hash: -> {