Class: Infrawrench::SharedConsolesInvitesNamespace

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

Overview

client.shared_consoles.invites

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ SharedConsolesInvitesNamespace

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

Parameters:



13032
13033
13034
 
# File 'lib/infrawrench/client.rb', line 13032

def initialize(transport)
  @transport = transport
end

Instance Method Details

#create(console_id:, org_id: nil, body: nil, request_options: nil) ⇒ Hash

Mint a replacement invite

An invite is spent by the first person it admits, so inviting a second guest means minting a second link. Replaces any outstanding one. Sharer or org:settings:write.

POST /api/org/orgId/shared-consoles/consoleId/invites

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)
  • body (Hash, nil) (defaults to: nil) —

    Request body, shaped as Hash.

  • request_options (Hash, nil) (defaults to: nil) —

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

  • console_id: (String)
  • org_id: (String, nil) (defaults to: nil)
  • body: ({ ?"inviteTtlMinutes" => Integer }, nil) (defaults to: nil)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



13058
13059
13060
13061
13062
13063
13064
13065
13066
 
# File 'lib/infrawrench/client.rb', line 13058

def create(console_id:, org_id: nil, body: nil, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/org/{orgId}/shared-consoles/{consoleId}/invites",
    path_params: { "orgId" => org_id, "consoleId" => console_id },
    body: body,
    request_options: request_options
  )
end

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

Withdraw the outstanding invite

Kills the link without touching the session or anyone already on it.

DELETE /api/org/orgId/shared-consoles/consoleId/invites

Raises on 403: Forbidden

Raises on 404: Not found

Parameters:

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

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

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

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

  • console_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:



13085
13086
13087
13088
13089
13090
13091
13092
 
# File 'lib/infrawrench/client.rb', line 13085

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

#get(token:, org_id: nil, request_options: nil) ⇒ Hash

Preview what an invite link points at

What the join screen shows before anyone commits: which host, whose session, and whether you may join it. Reachable with a valid token by a signed-in member who already holds resources:execute — the token says which session, never whether. Returns nothing from the session itself.

Requires permission: resources:execute.

GET /api/org/orgId/shared-consoles/invites/token

Raises on 404: Not found

Parameters:

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

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



13114
13115
13116
13117
13118
13119
13120
13121
 
# File 'lib/infrawrench/client.rb', line 13114

def get(token:, org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/shared-consoles/invites/{token}",
    path_params: { "orgId" => org_id, "token" => token },
    request_options: request_options
  )
end