Class: MethodRuby::Resources::Teams::Mle::PublicKeys

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

Overview

Team and API key management

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ PublicKeys

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

Parameters:



131
132
133
 
# File 'lib/method_ruby/resources/teams/mle/public_keys.rb', line 131

def initialize(client:)
  @client = client
end

Instance Method Details

#create(jwk:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Teams::Mle::PublicKeyCreateResponse

Some parameter documentations has been truncated, see Models::Teams::Mle::PublicKeyCreateParams for more details.

Registers a new Message-Level Encryption (MLE) public key for the team.

Parameters:

Returns:

See Also:



27
28
29
30
31
32
33
34
35
36
37
38
39
 
# File 'lib/method_ruby/resources/teams/mle/public_keys.rb', line 27

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

#delete(id, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Teams::Mle::PublicKeyDeleteResponse

Some parameter documentations has been truncated, see Models::Teams::Mle::PublicKeyDeleteParams for more details.

Deletes an MLE public key by its identifier. This action is irreversible.

Parameters:

Returns:

See Also:



113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/method_ruby/resources/teams/mle/public_keys.rb', line 113

def delete(id, params)
  parsed, options = MethodRuby::Teams::Mle::PublicKeyDeleteParams.dump_request(params)
  @client.request(
    method: :delete,
    path: ["teams/mle/public_keys/%1$s", id],
    headers: parsed.transform_keys(
      method_version: "method-version",
      idempotency_key: "idempotency-key"
    ),
    model: MethodRuby::Models::Teams::Mle::PublicKeyDeleteResponse,
    security: {secret_key: true},
    options: options
  )
end

#list(method_version:, request_options: {}) ⇒ MethodRuby::Models::Teams::Mle::PublicKeyListResponse

Some parameter documentations has been truncated, see Models::Teams::Mle::PublicKeyListParams for more details.

Returns all Message-Level Encryption (MLE) public keys registered for the team.

Parameters:

Returns:

See Also:



83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/method_ruby/resources/teams/mle/public_keys.rb', line 83

def list(params)
  parsed, options = MethodRuby::Teams::Mle::PublicKeyListParams.dump_request(params)
  @client.request(
    method: :get,
    path: "teams/mle/public_keys",
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Teams::Mle::PublicKeyListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(id, method_version:, request_options: {}) ⇒ MethodRuby::Models::Teams::Mle::PublicKeyRetrieveResponse

Some parameter documentations has been truncated, see Models::Teams::Mle::PublicKeyRetrieveParams for more details.

Returns a single MLE public key by its identifier.

Parameters:

Returns:

See Also:



57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/method_ruby/resources/teams/mle/public_keys.rb', line 57

def retrieve(id, params)
  parsed, options = MethodRuby::Teams::Mle::PublicKeyRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["teams/mle/public_keys/%1$s", id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Teams::Mle::PublicKeyRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end