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: nil, attrs: {}) ⇒ APIKey

Returns a new instance of APIKey.



20
21
22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/ngrokapi/models/api_key.rb', line 20

def initialize(client: nil, attrs: {})
  @client = client
  @attrs = attrs
  @id = @attrs['id']
  unless @attrs['uri'].nil?
    @uri = URI(@attrs['uri'])
  end
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @created_at = @attrs['created_at']
  @token = @attrs['token']
  @owner_id = @attrs['owner_id']
end

Instance Attribute Details

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def attrs
  @attrs
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def client
  @client
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def metadata
  @metadata
end

#owner_id ⇒ Object (readonly)

Returns the value of attribute owner_id.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def owner_id
  @owner_id
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def token
  @token
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



10
11
12
 
# File 'lib/ngrokapi/models/api_key.rb', line 10

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



34
35
36
 
# File 'lib/ngrokapi/models/api_key.rb', line 34

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

#delete ⇒ Object

Delete an API key by ID

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



50
51
52
53
54
 
# File 'lib/ngrokapi/models/api_key.rb', line 50

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

#to_h ⇒ Object 



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

def to_h
  @attrs.to_h
end

#to_s ⇒ Object 



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

def to_s
  @attrs.to_s
end

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

Update attributes of an API key by ID.

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



60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/ngrokapi/models/api_key.rb', line 60

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