Class: Infrawrench::SharedConsolesParticipantsNamespace

Inherits:
Object
  • Object
show all
Defined in:
lib/infrawrench/client.rb,
sig/infrawrench/sdk.rbs

Overview

client.shared_consoles.participants

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SharedConsolesParticipantsNamespace

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 SharedConsolesParticipantsNamespace.

Parameters:



12873
12874
12875
 
# File 'lib/infrawrench/client.rb', line 12873

def initialize(transport)
  @transport = transport
end

Instance Method Details

#delete(console_id:, participant_id:, org_id: nil, request_options: nil) ⇒ Hash

Remove somebody from a shared console

Their socket is closed immediately on the replica holding the pty, and within one two-second sweep on any other. They are marked removed rather than left, so they cannot resume without a fresh invite. The sharer cannot be removed — revoke the share.

DELETE /api/org/orgId/shared-consoles/consoleId/participants/participantId

Raises on 403: Forbidden

Raises on 404: Not found

Raises on 409: Conflict

Parameters:

  • org_id (String, nil) (defaults to: nil) —

    Organization id. Defaults to the org_id the client was constructed with.

  • console_id (String)
  • participant_id (String)
  • request_options (Hash, nil) (defaults to: nil) —

    Per-call :headers, :timeout and :open_timeout.

  • console_id: (String)
  • participant_id: (String)
  • org_id: (String, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

    Parsed JSON, shaped as SharedConsoleState — see sig/infrawrench/sdk.rbs.

Raises:



12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
 
# File 'lib/infrawrench/client.rb', line 12901

def delete(console_id:, participant_id:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "DELETE",
    path: "/api/org/{orgId}/shared-consoles/{consoleId}/participants/{participantId}",
    path_params: {
      "orgId" => org_id,
      "consoleId" => console_id,
      "participantId" => participant_id
    },
    request_options: request_options
  )
end