Class: MethodRuby::Resources::Teams::DefaultEncryptionKey

Inherits:

Object

• Object
• MethodRuby::Resources::Teams::DefaultEncryptionKey

Defined in:

lib/method_ruby/resources/teams/default_encryption_key.rb

Overview

Team and API key management

Instance Method Summary

• #create(key:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Teams::DefaultEncryptionKeyCreateResponse

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

• #initialize(client:) ⇒ DefaultEncryptionKey constructor private

  A new instance of DefaultEncryptionKey.

Constructor Details

#initialize(client:) ⇒ DefaultEncryptionKey

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

Parameters:

• client (MethodRuby::Client)

# File 'lib/method_ruby/resources/teams/default_encryption_key.rb', line 44

def initialize(client:)
  @client = client
end

Instance Method Details

#create(key:, method_version:, idempotency_key: nil, request_options: {}) ⇒ MethodRuby::Models::Teams::DefaultEncryptionKeyCreateResponse

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

Sets the default encryption key for the team. Used for encrypting sensitive data in API responses.

Parameters:

• key (String) —

  Body param: The encryption key value.

• method_version (Symbol, MethodRuby::Models::Teams::DefaultEncryptionKeyCreateParams::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:

• (MethodRuby::Models::Teams::DefaultEncryptionKeyCreateResponse)

See Also:

• Models::Teams::DefaultEncryptionKeyCreateParams

# File 'lib/method_ruby/resources/teams/default_encryption_key.rb', line 27

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