Class: NgrokAPI::Models::BotUser

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client: nil, attrs: {}) ⇒ BotUser

Returns a new instance of BotUser.



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/ngrokapi/models/bot_user.rb', line 18

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

Instance Attribute Details

#active ⇒ Object (readonly)

Returns the value of attribute active.



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

def active
  @active
end

#attrs ⇒ Object (readonly)

Returns the value of attribute attrs.



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

def attrs
  @attrs
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



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

def created_at
  @created_at
end

#id ⇒ Object (readonly)

Returns the value of attribute id.



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

def id
  @id
end

#name ⇒ Object (readonly)

Returns the value of attribute name.



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

def name
  @name
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



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

def uri
  @uri
end

Instance Method Details

#==(other) ⇒ Object 



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

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

#delete ⇒ Object

Delete a bot user by ID

https://ngrok.com/docs/api#api-bot-users-delete



46
47
48
49
50
 
# File 'lib/ngrokapi/models/bot_user.rb', line 46

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

#to_h ⇒ Object 



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

def to_h
  @attrs.to_h
end

#to_s ⇒ Object 



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

def to_s
  @attrs.to_s
end

#update(name: nil, active: nil) ⇒ Object

Update attributes of a bot user by ID.

https://ngrok.com/docs/api#api-bot-users-update



56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/ngrokapi/models/bot_user.rb', line 56

def update(
  name: nil,
  active: nil
)
  @name = name if name
  @active = active if active
  @client.update(
    id: @id,
    name: name,
    active: active
  )
end