Class: Infrawrench::TeamNamespace

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

Overview

client.team

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(transport) ⇒ TeamNamespace

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

Parameters:



5224
5225
5226
5227
5228
5229
 
# File 'lib/infrawrench/client.rb', line 5224

def initialize(transport)
  @transport = transport
  @invitations = TeamInvitationsNamespace.new(@transport)
  @members = TeamMembersNamespace.new(@transport)
  @roles = TeamRolesNamespace.new(@transport)
end

Instance Attribute Details

#invitations ⇒ TeamInvitationsNamespace (readonly)

Returns client.team.invitations.

Returns:



5216
5217
5218
 
# File 'lib/infrawrench/client.rb', line 5216

def invitations
  @invitations
end

#members ⇒ TeamMembersNamespace (readonly)

Returns client.team.members.

Returns:



5218
5219
5220
 
# File 'lib/infrawrench/client.rb', line 5218

def members
  @members
end

#roles ⇒ TeamRolesNamespace (readonly)

Returns client.team.roles.

Returns:



5220
5221
5222
 
# File 'lib/infrawrench/client.rb', line 5220

def roles
  @roles
end

Instance Method Details

#me(org_id: nil, request_options: nil) ⇒ Hash

Current user's effective permissions and role

GET /api/org/orgId/team/me

Parameters:

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

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



5240
5241
5242
5243
5244
5245
5246
5247
 
# File 'lib/infrawrench/client.rb', line 5240

def me(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/team/me",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end

#permissions(org_id: nil, request_options: nil) ⇒ Hash

List all permission strings the server recognises

Requires permission: team:read.

GET /api/org/orgId/team/permissions

Parameters:

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

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

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

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

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

Returns:

  • (Hash) —

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

Raises:



5260
5261
5262
5263
5264
5265
5266
5267
 
# File 'lib/infrawrench/client.rb', line 5260

def permissions(org_id: nil, request_options: nil)
  @transport.request(
    http_method: "GET",
    path: "/api/org/{orgId}/team/permissions",
    path_params: { "orgId" => org_id },
    request_options: request_options
  )
end