Class: MethodRuby::Resources::Teams

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/teams.rb,
lib/method_ruby/resources/teams/mle.rb,
lib/method_ruby/resources/teams/mle/public_keys.rb,
lib/method_ruby/resources/teams/default_encryption_key.rb

Overview

Team and API key management

Defined Under Namespace

Classes: DefaultEncryptionKey, Mle

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Teams

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

Parameters:



76
77
78
79
80
 
# File 'lib/method_ruby/resources/teams.rb', line 76

def initialize(client:)
  @client = client
  @default_encryption_key = MethodRuby::Resources::Teams::DefaultEncryptionKey.new(client: client)
  @mle = MethodRuby::Resources::Teams::Mle.new(client: client)
end

Instance Attribute Details

#default_encryption_key ⇒ MethodRuby::Resources::Teams::DefaultEncryptionKey (readonly)

Team and API key management

Returns:



9
10
11
 
# File 'lib/method_ruby/resources/teams.rb', line 9

def default_encryption_key
  @default_encryption_key
end

#mle ⇒ MethodRuby::Resources::Teams::Mle (readonly)

Public key discovery endpoints for Message-Level Encryption.

Returns:



13
14
15
 
# File 'lib/method_ruby/resources/teams.rb', line 13

def mle
  @mle
end

Instance Method Details

#create(name:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::TeamCreateResponse

Some parameter documentations has been truncated, see Models::TeamCreateParams for more details.

Creates a new child team under the current team.

Parameters:

  • name (String) —

    Body param: Display name for the new child team.

  • method_version (Symbol, MethodRuby::Models::TeamCreateParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • idempotency_key (String) —

    Header param: Idempotency key for safely retrying a write request. Reuse the sam

  • request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/method_ruby/resources/teams.rb', line 33

def create(params)
  parsed, options = MethodRuby::TeamCreateParams.dump_request(params)
  header_params = {method_version: "method-version", idempotency_key: "idempotency-key"}
  @client.request(
    method: :post,
    path: "teams",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: MethodRuby::Models::TeamCreateResponse,
    security: {secret_key: true},
    options: options
  )
end

#list(method_version:, request_options: {}) ⇒ MethodRuby::Models::TeamListResponse

Some parameter documentations has been truncated, see Models::TeamListParams for more details.

Returns the team associated with the current API key.

Parameters:

Returns:

See Also:



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/method_ruby/resources/teams.rb', line 61

def list(params)
  parsed, options = MethodRuby::TeamListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "teams",
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::TeamListResponse,
    security: {secret_key: true},
    options: options
  )
end