class NgrokAPI::Models::Credential

Attributes

acl[R]
attrs[R]
client[R]
created_at[R]
description[R]
id[R]
metadata[R]
token[R]
uri[R]

Public Class Methods

new(client: nil, attrs: {}) click to toggle source
# File lib/ngrokapi/models/credential.rb, line 16
def initialize(client: nil, attrs: {})
  @client = client
  @attrs = attrs
  @id = @attrs['id']
  @uri = @attrs['uri']
  @created_at = @attrs['created_at']
  @description = @attrs['description']
  @metadata = @attrs['metadata']
  @token = @attrs['token']
  @acl = @attrs['acl']
end

Public Instance Methods

==(other) click to toggle source
# File lib/ngrokapi/models/credential.rb, line 28
def ==(other)
  @attrs == other.attrs
end
delete() click to toggle source

Delete a tunnel authtoken credential by ID

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

# File lib/ngrokapi/models/credential.rb, line 44
def delete
  @client.delete(
    id: @id
  )
end
to_h() click to toggle source
# File lib/ngrokapi/models/credential.rb, line 36
def to_h
  @attrs.to_h
end
to_s() click to toggle source
# File lib/ngrokapi/models/credential.rb, line 32
def to_s
  @attrs.to_s
end
update( description: nil, metadata: nil, acl: nil ) click to toggle source

Update attributes of an tunnel authtoken credential by ID

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

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