Class: Telnyx::Models::OtaUpdateListParams::Filter

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/ota_update_list_params.rb,
sig/telnyx/models/ota_update_list_params.rbs

Defined Under Namespace

Modules: Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(sim_card_id: nil, status: nil, type: nil) ⇒ Object

Consolidated filter parameter for OTA updates (deepObject style). Originally: filter, filter, filter

Parameters:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/telnyx/models/ota_update_list_params.rb', line 39

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute sim_card_id
  #   The SIM card identification UUID.
  #
  #   @return [String, nil]
  optional :sim_card_id, String

  # @!attribute status
  #   Filter by a specific status of the resource's lifecycle.
  #
  #   @return [Symbol, Telnyx::Models::OtaUpdateListParams::Filter::Status, nil]
  optional :status, enum: -> { Telnyx::OtaUpdateListParams::Filter::Status }

  # @!attribute type
  #   Filter by type.
  #
  #   @return [Symbol, Telnyx::Models::OtaUpdateListParams::Filter::Type, nil]
  optional :type, enum: -> { Telnyx::OtaUpdateListParams::Filter::Type }

  # @!method initialize(sim_card_id: nil, status: nil, type: nil)
  #   Consolidated filter parameter for OTA updates (deepObject style). Originally:
  #   filter[status], filter[sim_card_id], filter[type]
  #
  #   @param sim_card_id [String] The SIM card identification UUID.
  #
  #   @param status [Symbol, Telnyx::Models::OtaUpdateListParams::Filter::Status] Filter by a specific status of the resource's lifecycle.
  #
  #   @param type [Symbol, Telnyx::Models::OtaUpdateListParams::Filter::Type] Filter by type.

  # Filter by a specific status of the resource's lifecycle.
  #
  # @see Telnyx::Models::OtaUpdateListParams::Filter#status
  module Status
    extend Telnyx::Internal::Type::Enum

    IN_PROGRESS = :"in-progress"
    COMPLETED = :completed
    FAILED = :failed

    # @!method self.values
    #   @return [Array<Symbol>]
  end

  # Filter by type.
  #
  # @see Telnyx::Models::OtaUpdateListParams::Filter#type
  module Type
    extend Telnyx::Internal::Type::Enum

    SIM_CARD_NETWORK_PREFERENCES = :sim_card_network_preferences

    # @!method self.values
    #   @return [Array<Symbol>]
  end
end

Instance Attribute Details

#sim_card_id ⇒ String?

The SIM card identification UUID.

Parameters:

  • (String)

Returns:

  • (String, nil) 


44
 
# File 'lib/telnyx/models/ota_update_list_params.rb', line 44

optional :sim_card_id, String

#status ⇒ Symbol, ...

Filter by a specific status of the resource's lifecycle.

Returns:



50
 
# File 'lib/telnyx/models/ota_update_list_params.rb', line 50

optional :status, enum: -> { Telnyx::OtaUpdateListParams::Filter::Status }

#type ⇒ Symbol, ...

Filter by type.

Returns:



56
 
# File 'lib/telnyx/models/ota_update_list_params.rb', line 56

optional :type, enum: -> { Telnyx::OtaUpdateListParams::Filter::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/ota_update_list_params.rb', line 78

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


73
 
# File 'sig/telnyx/models/ota_update_list_params.rbs', line 73

def to_hash: -> {