Class: Infrawrench::InvitationsNamespace

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

Overview

client.invitations

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ InvitationsNamespace

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

Parameters:



1870
1871
1872
1873
 
# File 'lib/infrawrench/client.rb', line 1870

def initialize(transport)
  @transport = transport
  @by_token = InvitationsByTokenNamespace.new(@transport)
end

Instance Attribute Details

#by_token ⇒ InvitationsByTokenNamespace (readonly)

Returns client.invitations.by_token.

Returns:



1866
1867
1868
 
# File 'lib/infrawrench/client.rb', line 1866

def by_token
  @by_token
end

Instance Method Details

#accept(body:, request_options: nil) ⇒ Hash

Accept an invitation

POST /api/invitations/accept

Raises on 400: Bad request

Raises on 403: Forbidden

Parameters:

  • body (Hash) —

    Request body, shaped as AcceptInvitationRequest.

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

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

  • body: (accept_invitation_request)
  • request_options: (Hash[Symbol, untyped], nil) (defaults to: nil)

Returns:

  • (Hash) —

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

Raises:



1888
1889
1890
1891
1892
1893
1894
1895
 
# File 'lib/infrawrench/client.rb', line 1888

def accept(body:, request_options: nil)
  @transport.request(
    http_method: "POST",
    path: "/api/invitations/accept",
    body: body,
    request_options: request_options
  )
end