Class: Telnyx::Models::RoomCompositionListParams::Filter

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

Defined Under Namespace

Modules: Status Classes: DateCreatedAt

Instance Attribute 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(eq: nil, gte: nil, lte: nil) ⇒ Object

Parameters:

  • eq (Date) (defaults to: nil) —

    ISO 8601 date for filtering room compositions created on that date.

  • gte (Date) (defaults to: nil) —

    ISO 8601 date for filtering room compositions created on or after that date.

  • lte (Date) (defaults to: nil) —

    ISO 8601 date for filtering room compositions created on or before that date.



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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/telnyx/models/room_composition_list_params.rb', line 40

class Filter < Telnyx::Internal::Type::BaseModel
  # @!attribute date_created_at
  #
  #   @return [Telnyx::Models::RoomCompositionListParams::Filter::DateCreatedAt, nil]
  optional :date_created_at, -> { Telnyx::RoomCompositionListParams::Filter::DateCreatedAt }

  # @!attribute session_id
  #   The session_id for filtering room compositions.
  #
  #   @return [String, nil]
  optional :session_id, String

  # @!attribute status
  #   The status for filtering room compositions.
  #
  #   @return [Symbol, Telnyx::Models::RoomCompositionListParams::Filter::Status, nil]
  optional :status, enum: -> { Telnyx::RoomCompositionListParams::Filter::Status }

  # @!method initialize(date_created_at: nil, session_id: nil, status: nil)
  #   Consolidated filter parameter (deepObject style). Originally:
  #   filter[date_created_at][eq], filter[date_created_at][gte],
  #   filter[date_created_at][lte], filter[session_id], filter[status]
  #
  #   @param date_created_at [Telnyx::Models::RoomCompositionListParams::Filter::DateCreatedAt]
  #
  #   @param session_id [String] The session_id for filtering room compositions.
  #
  #   @param status [Symbol, Telnyx::Models::RoomCompositionListParams::Filter::Status] The status for filtering room compositions.

  # @see Telnyx::Models::RoomCompositionListParams::Filter#date_created_at
  class DateCreatedAt < Telnyx::Internal::Type::BaseModel
    # @!attribute eq
    #   ISO 8601 date for filtering room compositions created on that date.
    #
    #   @return [Date, nil]
    optional :eq, Date

    # @!attribute gte
    #   ISO 8601 date for filtering room compositions created on or after that date.
    #
    #   @return [Date, nil]
    optional :gte, Date

    # @!attribute lte
    #   ISO 8601 date for filtering room compositions created on or before that date.
    #
    #   @return [Date, nil]
    optional :lte, Date

    # @!method initialize(eq: nil, gte: nil, lte: nil)
    #   @param eq [Date] ISO 8601 date for filtering room compositions created on that date.
    #
    #   @param gte [Date] ISO 8601 date for filtering room compositions created on or after that date.
    #
    #   @param lte [Date] ISO 8601 date for filtering room compositions created on or before that date.
  end

  # The status for filtering room compositions.
  #
  # @see Telnyx::Models::RoomCompositionListParams::Filter#status
  module Status
    extend Telnyx::Internal::Type::Enum

    COMPLETED = :completed
    PROCESSING = :processing
    ENQUEUED = :enqueued

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

Instance Attribute Details

#date_created_at ⇒ Telnyx::Models::RoomCompositionListParams::Filter::DateCreatedAt?

Returns:



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

optional :date_created_at, -> { Telnyx::RoomCompositionListParams::Filter::DateCreatedAt }

#session_id ⇒ String?

The session_id for filtering room compositions.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :session_id, String

#status ⇒ Symbol, ...

The status for filtering room compositions.

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {