Class: LosantRest::InstanceOrg
- Inherits:
-
Object
- Object
- LosantRest::InstanceOrg
- Defined in:
- lib/losant_rest/instance_org.rb
Overview
Class containing all the actions for the Instance Org Resource
Instance Method Summary collapse
-
#delete(params = {}) ⇒ Object
Deletes an organization.
-
#device_counts(params = {}) ⇒ Object
Returns device counts by day for the time range specified for this organization.
-
#get(params = {}) ⇒ Object
Retrieves information on an organization.
-
#initialize(client) ⇒ InstanceOrg
constructor
A new instance of InstanceOrg.
-
#notebook_minute_counts(params = {}) ⇒ Object
Returns notebook execution usage by day for the time range specified for this organization.
-
#patch(params = {}) ⇒ Object
Updates information about an organization.
Constructor Details
#initialize(client) ⇒ InstanceOrg
Returns a new instance of InstanceOrg.
30 31 32 |
# File 'lib/losant_rest/instance_org.rb', line 30 def initialize(client) @client = client end |
Instance Method Details
#delete(params = {}) ⇒ Object
Deletes an organization
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrg.*, or instanceOrg.delete.
Parameters:
-
string instanceId - ID associated with the instance
-
string orgId - ID associated with the organization
-
string losantdomain - Domain scope of request (rarely needed)
-
boolean _actions - Return resource actions in response
-
boolean _links - Return resource link in response
-
boolean _embedded - Return embedded resources in response
Responses:
-
200 - If organization was successfully deleted (api.losant.com/#/definitions/success)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/losant_rest/instance_org.rb', line 56 def delete(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}" @client.request( method: :delete, path: path, query: query_params, headers: headers, body: body) end |
#device_counts(params = {}) ⇒ Object
Returns device counts by day for the time range specified for this organization
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.deviceCounts.
Parameters:
-
string instanceId - ID associated with the instance
-
string orgId - ID associated with the organization
-
string start - Start of range for device count query (ms since epoch)
-
string end - End of range for device count query (ms since epoch)
-
string losantdomain - Domain scope of request (rarely needed)
-
boolean _actions - Return resource actions in response
-
boolean _links - Return resource link in response
-
boolean _embedded - Return embedded resources in response
Responses:
-
200 - Device counts by day (api.losant.com/#/definitions/deviceCounts)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if instance or organization was not found (api.losant.com/#/definitions/error)
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
# File 'lib/losant_rest/instance_org.rb', line 104 def device_counts(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) query_params[:start] = params[:start] if params.has_key?(:start) query_params[:end] = params[:end] if params.has_key?(:end) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/deviceCounts" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end |
#get(params = {}) ⇒ Object
Retrieves information on an organization
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.get.
Parameters:
-
string instanceId - ID associated with the instance
-
string orgId - ID associated with the organization
-
string summaryInclude - Comma-separated list of summary fields to include in org summary
-
string losantdomain - Domain scope of request (rarely needed)
-
boolean _actions - Return resource actions in response
-
boolean _links - Return resource link in response
-
boolean _embedded - Return embedded resources in response
Responses:
-
200 - A single organization (api.losant.com/#/definitions/instanceOrg)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 |
# File 'lib/losant_rest/instance_org.rb', line 153 def get(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end |
#notebook_minute_counts(params = {}) ⇒ Object
Returns notebook execution usage by day for the time range specified for this organization
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.Instance.read, all.User, all.User.read, instanceOrg.*, or instanceOrg.notebookMinuteCounts.
Parameters:
-
string instanceId - ID associated with the instance
-
string orgId - ID associated with the organization
-
string start - Start of range for notebook execution query (ms since epoch)
-
string end - End of range for notebook execution query (ms since epoch)
-
string losantdomain - Domain scope of request (rarely needed)
-
boolean _actions - Return resource actions in response
-
boolean _links - Return resource link in response
-
boolean _embedded - Return embedded resources in response
Responses:
-
200 - Notebook usage information (api.losant.com/#/definitions/notebookMinuteCounts)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/losant_rest/instance_org.rb', line 202 def notebook_minute_counts(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) query_params[:start] = params[:start] if params.has_key?(:start) query_params[:end] = params[:end] if params.has_key?(:end) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}/notebookMinuteCounts" @client.request( method: :get, path: path, query: query_params, headers: headers, body: body) end |
#patch(params = {}) ⇒ Object
Updates information about an organization
Authentication: The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Instance, all.User, instanceOrg.*, or instanceOrg.patch.
Parameters:
-
string instanceId - ID associated with the instance
-
string orgId - ID associated with the organization
-
string summaryInclude - Comma-separated list of summary fields to include in org summary
-
hash organization - Object containing new organization properties (api.losant.com/#/definitions/instanceOrgPatch)
-
string losantdomain - Domain scope of request (rarely needed)
-
boolean _actions - Return resource actions in response
-
boolean _links - Return resource link in response
-
boolean _embedded - Return embedded resources in response
Responses:
-
200 - Updated organization information (api.losant.com/#/definitions/instanceOrg)
Errors:
-
400 - Error if malformed request (api.losant.com/#/definitions/error)
-
404 - Error if organization was not found (api.losant.com/#/definitions/error)
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 |
# File 'lib/losant_rest/instance_org.rb', line 252 def patch(params = {}) params = Utils.symbolize_hash_keys(params) query_params = { _actions: false, _links: true, _embedded: true } headers = {} body = nil raise ArgumentError.new("instanceId is required") unless params.has_key?(:instanceId) raise ArgumentError.new("orgId is required") unless params.has_key?(:orgId) raise ArgumentError.new("organization is required") unless params.has_key?(:organization) query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude) body = params[:organization] if params.has_key?(:organization) headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain) query_params[:_actions] = params[:_actions] if params.has_key?(:_actions) query_params[:_links] = params[:_links] if params.has_key?(:_links) query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded) path = "/instances/#{params[:instanceId]}/orgs/#{params[:orgId]}" @client.request( method: :patch, path: path, query: query_params, headers: headers, body: body) end |