Class: Telnyx::Models::RoomUpdateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/room_update_params.rb

Overview

See Also:

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(room_id:, enable_recording: nil, max_participants: nil, unique_name: nil, webhook_event_failover_url: nil, webhook_event_url: nil, webhook_timeout_secs: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::RoomUpdateParams for more details.

Parameters:

  • room_id (String)
  • enable_recording (Boolean) (defaults to: nil) —

    Enable or disable recording for that room.

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

    The maximum amount of participants allowed in a room. If new participants try to

  • unique_name (String) (defaults to: nil) —

    The unique (within the Telnyx account scope) name of the room.

  • webhook_event_failover_url (String) (defaults to: nil) —

    The failover URL where webhooks related to this room will be sent if sending to

  • webhook_event_url (String) (defaults to: nil) —

    The URL where webhooks related to this room will be sent. Must include a scheme,

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

    Specifies how many seconds to wait before timing out a webhook.

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



# File 'lib/telnyx/models/room_update_params.rb', line 54

Instance Attribute Details

#enable_recording ⇒ Boolean?

Enable or disable recording for that room.

Returns:

  • (Boolean, nil) 


19
 
# File 'lib/telnyx/models/room_update_params.rb', line 19

optional :enable_recording, Telnyx::Internal::Type::Boolean

#max_participants ⇒ Integer?

The maximum amount of participants allowed in a room. If new participants try to join after that limit is reached, their request will be rejected.

Returns:

  • (Integer, nil) 


26
 
# File 'lib/telnyx/models/room_update_params.rb', line 26

optional :max_participants, Integer

#room_id ⇒ String

Returns:

  • (String) 


13
 
# File 'lib/telnyx/models/room_update_params.rb', line 13

required :room_id, String

#unique_name ⇒ String?

The unique (within the Telnyx account scope) name of the room.

Returns:

  • (String, nil) 


32
 
# File 'lib/telnyx/models/room_update_params.rb', line 32

optional :unique_name, String

#webhook_event_failover_url ⇒ String?

The failover URL where webhooks related to this room will be sent if sending to the primary URL fails. Must include a scheme, such as ‘https’.

Returns:

  • (String, nil) 


39
 
# File 'lib/telnyx/models/room_update_params.rb', line 39

optional :webhook_event_failover_url, String

#webhook_event_url ⇒ String?

The URL where webhooks related to this room will be sent. Must include a scheme, such as ‘https’.

Returns:

  • (String, nil) 


46
 
# File 'lib/telnyx/models/room_update_params.rb', line 46

optional :webhook_event_url, String

#webhook_timeout_secs ⇒ Integer?

Specifies how many seconds to wait before timing out a webhook.

Returns:

  • (Integer, nil) 


52
 
# File 'lib/telnyx/models/room_update_params.rb', line 52

optional :webhook_timeout_secs, Integer