Class: NgrokAPI::Models::APIKey

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ APIKey

Returns a new instance of APIKey.



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

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

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def metadata
  @metadata
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def result
  @result
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def token
  @token
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



6
7
8
 
# File 'lib/ngrokapi/models/api_key.rb', line 6

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



26
27
28
 
# File 'lib/ngrokapi/models/api_key.rb', line 26

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

#delete ⇒ Object

Delete an API key by ID

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



38
39
40
41
42
 
# File 'lib/ngrokapi/models/api_key.rb', line 38

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

#to_s ⇒ Object 



30
31
32
 
# File 'lib/ngrokapi/models/api_key.rb', line 30

def to_s
  @result.to_s
end

#update(description: nil, metadata: nil) ⇒ Object

Update attributes of an API key by ID.

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



48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/ngrokapi/models/api_key.rb', line 48

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