Class: NgrokAPI::Models::ApiKey

Inherits:
Object
  • Object
show all
Defined in:
lib/ngrokapi/models/api_key.rb

Overview

A resource representing data from the api_keys API

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ ApiKey

Returns a new instance of ApiKey.



17
18
19
20
21
22
23
24
25
26
 
# File 'lib/ngrokapi/models/api_key.rb', line 17

def initialize(client:, result:)
  @client = client
  @result = result
  @created_at = @result['created_at']
  @id = @result['id']
  @description = @result['description']
  @metadata = @result['metadata']
  @token = @result['token']
  @uri = @result['uri']
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def metadata
  @metadata
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def result
  @result
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def token
  @token
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



8
9
10
 
# File 'lib/ngrokapi/models/api_key.rb', line 8

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



28
29
30
 
# File 'lib/ngrokapi/models/api_key.rb', line 28

def ==(other)
  @result == other.result
end

#delete ⇒ nil

Delete this API key.

ngrok.com/docs/api#api-api-keys-delete

Returns:

  • (nil) —

    result from delete request



42
43
44
 
# File 'lib/ngrokapi/models/api_key.rb', line 42

def delete
  @client.delete(id: @id)
end

#to_s ⇒ Object 



32
33
34
 
# File 'lib/ngrokapi/models/api_key.rb', line 32

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil) ⇒ NgrokAPI::Models::ApiKey

Update the attributes of this API key.

ngrok.com/docs/api#api-api-keys-update

Parameters:

  • description (string) (defaults to: nil) —

    human-readable description of what uses the API key to authenticate. optional, max 255 bytes.

  • metadata (string) (defaults to: nil) —

    arbitrary user-defined data of this API key. optional, max 4096 bytes

Returns:



56
57
58
59
60
 
# File 'lib/ngrokapi/models/api_key.rb', line 56

def update(description: nil, metadata: nil)
  @description = description if description
  @metadata = metadata if metadata
  @client.update(id: @id, description: description, metadata: metadata)
end