Class: Nexmo::Secrets

Inherits:

Namespace

• Object
• Namespace
• Nexmo::Secrets

Defined in:

lib/nexmo/secrets.rb

Defined Under Namespace

Classes: ListResponse

Instance Method Summary

• #create(params) ⇒ Response

  Create API Secret.

• #get(secret_id) ⇒ Response

  Retrieve one API Secret.

• #list ⇒ ListResponse

  Retrieve API Secrets.

• #revoke(secret_id) ⇒ Response

  Revoke an API Secret.

Instance Method Details

#create(params) ⇒ Response

Create API Secret.

Examples:

response = client.secrets.create(secret: 'T0ps3cr3t')

Parameters:

• params (Hash)

Options Hash (params):

• :secret (required, String) —

  The new secret must follow these rules:

  • minimum 8 characters

  • maximum 25 characters

  • minimum 1 lower case character

  • minimum 1 upper case character

  • minimum 1 digit

Returns:

• (Response)

See Also:

• https://developer.nexmo.com/api/account#createAPISecret

# File 'lib/nexmo/secrets.rb', line 29

def create(params)
  request('/accounts/' + account_id + '/secrets', params: params, type: Post)
end

#get(secret_id) ⇒ Response

Retrieve one API Secret.

Examples:

response = client.secrets.get(secret_id)

Parameters:

• secret_id (String)

Returns:

• (Response)

See Also:

• https://developer.nexmo.com/api/account#retrieveAPISecret

# File 'lib/nexmo/secrets.rb', line 60

def get(secret_id)
  request('/accounts/' + account_id + '/secrets/' + secret_id)
end

#list ⇒ ListResponse

Retrieve API Secrets.

Examples:

response = client.secrets.list
response.each do |item|
  puts "#{item.created_at} #{item.id}"
end

Returns:

• (ListResponse)

See Also:

• https://developer.nexmo.com/api/account#retrieveAPISecrets

# File 'lib/nexmo/secrets.rb', line 45

def list
  request('/accounts/' + account_id + '/secrets', response_class: ListResponse)
end

#revoke(secret_id) ⇒ Response

Revoke an API Secret.

Examples:

response = client.secrets.revoke(secret_id)

Parameters:

• secret_id (String)

Returns:

• (Response)

See Also:

• https://developer.nexmo.com/api/account#revokeAPISecret

# File 'lib/nexmo/secrets.rb', line 75

def revoke(secret_id)
  request('/accounts/' + account_id + '/secrets/' + secret_id, type: Delete)
end