Class: Infrawrench::InvitationsByTokenNamespace

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

Overview

client.invitations.by_token

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ InvitationsByTokenNamespace

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

Parameters:



2788
2789
2790
 
# File 'lib/infrawrench/client.rb', line 2788

def initialize(transport)
  @transport = transport
end

Instance Method Details

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

Get invitation details by token

GET /api/invitations/by-token/token

Raises on 404: Not found

Parameters:

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

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

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

Returns:

  • (Hash) —

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

Raises:



2802
2803
2804
2805
2806
2807
2808
2809
 
# File 'lib/infrawrench/client.rb', line 2802

def get(token:, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/invitations/by-token/{token}",
    path_params: { "token" => token },
    request_options: request_options
  )
end