Class: NgrokAPI::Models::Credential

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:, result:) ⇒ Credential

Returns a new instance of Credential.



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

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

Instance Attribute Details

#acl ⇒ Object (readonly)

Returns the value of attribute acl.



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

def acl
  @acl
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



6
7
8
 
# File 'lib/ngrokapi/models/credential.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/credential.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/credential.rb', line 6

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



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

def metadata
  @metadata
end

#result ⇒ Object (readonly)

Returns the value of attribute result.



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

def result
  @result
end

#token ⇒ Object (readonly)

Returns the value of attribute token.



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

def token
  @token
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



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

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

#delete ⇒ Object

Delete a tunnel authtoken credential by ID

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



40
41
42
43
44
 
# File 'lib/ngrokapi/models/credential.rb', line 40

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

#to_s ⇒ Object 



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

def to_s
  @result.to_s
end

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

Update attributes of an tunnel authtoken credential by ID

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



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

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