Class: Telnyx::Resources::Rooms::Sessions

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/rooms/sessions.rb,
lib/telnyx/resources/rooms/sessions/actions.rb,
sig/telnyx/resources/rooms/sessions.rbs,
sig/telnyx/resources/rooms/sessions/actions.rbs

Defined Under Namespace

Classes: Actions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Sessions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Sessions.

Parameters:



147
148
149
150
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 147

def initialize(client:)
  @client = client
  @actions = Telnyx::Resources::Rooms::Sessions::Actions.new(client: client)
end

Instance Attribute Details

#actions ⇒ Telnyx::Resources::Rooms::Sessions::Actions (readonly)

Rooms Sessions operations.

Returns:



9
10
11
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 9

def actions
  @actions
end

Instance Method Details

#list_0(filter: nil, include_participants: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::RoomSession>

Some parameter documentations has been truncated, see Models::Rooms::SessionList0Params for more details.

Returns a paginated list of room sessions across the account. Filter sessions by room, creation, update, or end date and active status, and use include_participants to include participant records.

Parameters:

  • filter (Telnyx::Models::Rooms::SessionList0Params::Filter) —

    Consolidated filter parameter (deepObject style). Originally: filter[date_create

  • include_participants (Boolean) —

    To decide if room participants should be included in the response.

  • page_number (Integer)
  • page_size (Integer)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 60

def list_0(params = {})
  parsed, options = Telnyx::Rooms::SessionList0Params.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "room_sessions",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::RoomSession,
    options: options
  )
end

#list_1(room_id, filter: nil, include_participants: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::RoomSession>

Some parameter documentations has been truncated, see Models::Rooms::SessionList1Params for more details.

Returns a paginated list of sessions for the specified room. Filter sessions by creation, update, or end date and active status, and use include_participants to include participant records.

Parameters:

  • room_id (String) —

    The unique identifier of a room.

  • filter (Telnyx::Models::Rooms::SessionList1Params::Filter) —

    Consolidated filter parameter (deepObject style). Originally: filter[date_create

  • include_participants (Boolean) —

    To decide if room participants should be included in the response.

  • page_number (Integer)
  • page_size (Integer)
  • request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 97

def list_1(room_id, params = {})
  parsed, options = Telnyx::Rooms::SessionList1Params.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["rooms/%1$s/sessions", room_id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::RoomSession,
    options: options
  )
end

#retrieve(room_session_id, include_participants: nil, request_options: {}) ⇒ Telnyx::Models::Rooms::SessionRetrieveResponse

Returns the room session identified by room_session_id, including its room, active status, and lifecycle timestamps. Use include_participants to include its participant records.

Parameters:

  • room_session_id (String) —

    The unique identifier of a room session.

  • include_participants (Boolean) —

    To decide if room participants should be included in the response.

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

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 26

def retrieve(room_session_id, params = {})
  parsed, options = Telnyx::Rooms::SessionRetrieveParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["room_sessions/%1$s", room_session_id],
    query: query,
    model: Telnyx::Models::Rooms::SessionRetrieveResponse,
    options: options
  )
end

#retrieve_participants(room_session_id, filter: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::RoomParticipant>

Some parameter documentations has been truncated, see Models::Rooms::SessionRetrieveParticipantsParams for more details.

Returns a paginated list of participants for the specified room session. Filter participants by join, update, or leave date and by participant context.

Parameters:

Returns:

See Also:



131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/telnyx/resources/rooms/sessions.rb', line 131

def retrieve_participants(room_session_id, params = {})
  parsed, options = Telnyx::Rooms::SessionRetrieveParticipantsParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["room_sessions/%1$s/participants", room_session_id],
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::RoomParticipant,
    options: options
  )
end