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

Returns a new instance of Credential.



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

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

Instance Attribute Details

#acl ⇒ Object (readonly)

Returns the value of attribute acl.



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

def acl
  @acl
end

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



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

def attrs
  @attrs
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def description
  @description
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#metadata ⇒ Object (readonly)

Returns the value of attribute metadata.



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

def token
  @token
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



36
37
38
 
# File 'lib/ngrokapi/models/credential.rb', line 36

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

#delete ⇒ Object

Delete a tunnel authtoken credential by ID

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



52
53
54
55
56
 
# File 'lib/ngrokapi/models/credential.rb', line 52

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

#to_h ⇒ Object 



44
45
46
 
# File 'lib/ngrokapi/models/credential.rb', line 44

def to_h
  @attrs.to_h
end

#to_s ⇒ Object 



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

def to_s
  @attrs.to_s
end

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

Update attributes of an tunnel authtoken credential by ID

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ngrokapi/models/credential.rb', line 62

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