Class: Bandwidth::EndPoint

Inherits:
Object
  • Object
show all
Includes:
ApiItem
Defined in:
lib/bandwidth/endpoint.rb

Overview

Endpoint of domain

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ApiItem

#[], #[]=, #initialize, #to_data

Instance Attribute Details

#domain_idObject

Returns the value of attribute domain_id



5
6
7
# File 'lib/bandwidth/endpoint.rb', line 5

def domain_id
  @domain_id
end

Instance Method Details

#create_auth_token(expires = 86400) ⇒ Object

Create auth token.

Examples:

token = endpoint.create_auth_token()


20
21
22
# File 'lib/bandwidth/endpoint.rb', line 20

def create_auth_token(expires = 86400)
  @client.make_request(:post, @client.concat_user_path("#{DOMAIN_PATH}/#{domain_id}/endpoints/#{id}/tokens"), {expires: expires})[0]
end

#deleteObject Also known as: destroy

Remove an endpoint from domain.

Examples:

endpoint.delete()


10
11
12
# File 'lib/bandwidth/endpoint.rb', line 10

def delete()
  @client.make_request(:delete, @client.concat_user_path("#{DOMAIN_PATH}/#{domain_id}/endpoints/#{id}"))[0]
end

#delete_auth_token(token) ⇒ Object

Delete auth token.

Examples:

endpoint.delete_auth_token('token')


27
28
29
# File 'lib/bandwidth/endpoint.rb', line 27

def delete_auth_token(token)
  @client.make_request(:delete, @client.concat_user_path("#{DOMAIN_PATH}/#{domain_id}/endpoints/#{id}/tokens/#{token}"))[0]
end