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.



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

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

Instance Attribute Details

#attrsObject (readonly)

Returns the value of attribute attrs.



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

def attrs
  @attrs
end

#clientObject (readonly)

Returns the value of attribute client.



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

def client
  @client
end

#created_atObject (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

#descriptionObject (readonly)

Returns the value of attribute description.



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

def description
  @description
end

#idObject (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metadataObject (readonly)

Returns the value of attribute metadata.



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

def 
  @metadata
end

#tokenObject (readonly)

Returns the value of attribute token.



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

def token
  @token
end

#uriObject (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)
  @attrs == other.attrs
end

#deleteObject

Delete an API key by ID

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



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

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

#to_hObject



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

def to_h
  @attrs.to_h
end

#to_sObject



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

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



52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/ngrokapi/models/api_key.rb', line 52

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