class TACore::Client

> Client Class methods.

Clients are companies, or groups of users that have access to the same data. When making requests it is important to keep the client api_key

Public Class Methods

all(token) click to toggle source

Get all Clients that belong to this application @param token [String] Client Token after Authentication @return [Array] in JSON format

# File lib/tacore/client.rb, line 8
def self.all(token)
  response = request(:get, '/application',{}, {"token": token})
  return response["clients"]
end
create(token, client = {}) click to toggle source

Allows an application to add a Client @param token [String] Client Token after Authentication @param client [Object] @return [Object] in JSON format - the new client @note The new Client will be owned by the application creating it.

# File lib/tacore/client.rb, line 18
def self.create(token, client = {})
  request(:post, '/client', client, {"token": token})
end
destroy(token, client_id) click to toggle source

Delete a client by id @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create}

# File lib/tacore/client.rb, line 43
def self.destroy(token, client_id)
  request(:delete, '/client/' + client_id.to_s, {"token": token})
end
devices(token, client_id) click to toggle source

Get all devices assigned to this client-id @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create} @return [Object] in JSON format

# File lib/tacore/client.rb, line 51
def self.devices(token, client_id)
  request(:get, '/client/' + client_id.to_s + '/devices',{}, {"token": token})
end
find(token, client_id) click to toggle source

Get details on a specific client by client_id @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create} @return [Object] in JSON format

# File lib/tacore/client.rb, line 26
def self.find(token, client_id)
  request(:get, '/client/' + client_id.to_s, {}, {"token": token})
end
gateways(token, client_id) click to toggle source

Get all gateways assigned to this client-id @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create} @return [Object] in JSON format

# File lib/tacore/client.rb, line 59
def self.gateways(token, client_id)
  request(:get, '/client/' + client_id.to_s + '/gateways',{}, {"token": token})
end
update(token, client_id, client = {}) click to toggle source

Update a client details via api_key @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create} @param client [Object] Client params @return [Object] in JSON format @note The `client` object currently only supports `name`

# File lib/tacore/client.rb, line 36
def self.update(token, client_id, client = {})
  request(:put, '/client/' + client_id.to_s, {"token": token})
end
venues(token, client_id) click to toggle source

Get all Venues created by this client-id @param token [String] Client Token after Authentication @param client_id [String] used from {Client.create} @return [Object] in JSON format

# File lib/tacore/client.rb, line 67
def self.venues(token, client_id)
  request(:get, '/client/' + client_id.to_s + '/venues',{}, {"token": token})
end