Class: PlatformRest::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/platform_rest/client.rb

Overview

Platform API

User API for accessing platform data

Built For Version 1.27.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Client

Returns a new instance of Client.



34
35
36
37
 
# File 'lib/platform_rest/client.rb', line 34

def initialize(options = {})
  self.auth_token = options.fetch(:auth_token, nil)
  self.url        = options.fetch(:url, "https://api.losant.com")
end

Instance Attribute Details

#auth_token ⇒ Object

Returns the value of attribute auth_token.



32
33
34
 
# File 'lib/platform_rest/client.rb', line 32

def auth_token
  @auth_token
end

#url ⇒ Object

Returns the value of attribute url.



32
33
34
 
# File 'lib/platform_rest/client.rb', line 32

def url
  @url
end

Instance Method Details

#application ⇒ Object 



39
40
41
 
# File 'lib/platform_rest/client.rb', line 39

def application
  @application ||= Application.new(self)
end

#application_api_token ⇒ Object 



43
44
45
 
# File 'lib/platform_rest/client.rb', line 43

def application_api_token
  @application_api_token ||= ApplicationApiToken.new(self)
end

#application_api_tokens ⇒ Object 



47
48
49
 
# File 'lib/platform_rest/client.rb', line 47

def application_api_tokens
  @application_api_tokens ||= ApplicationApiTokens.new(self)
end

#application_certificate ⇒ Object 



51
52
53
 
# File 'lib/platform_rest/client.rb', line 51

def application_certificate
  @application_certificate ||= ApplicationCertificate.new(self)
end

#application_certificate_authorities ⇒ Object 



55
56
57
 
# File 'lib/platform_rest/client.rb', line 55

def application_certificate_authorities
  @application_certificate_authorities ||= ApplicationCertificateAuthorities.new(self)
end

#application_certificate_authority ⇒ Object 



59
60
61
 
# File 'lib/platform_rest/client.rb', line 59

def application_certificate_authority
  @application_certificate_authority ||= ApplicationCertificateAuthority.new(self)
end

#application_certificates ⇒ Object 



63
64
65
 
# File 'lib/platform_rest/client.rb', line 63

def application_certificates
  @application_certificates ||= ApplicationCertificates.new(self)
end

#application_dashboard ⇒ Object 



67
68
69
 
# File 'lib/platform_rest/client.rb', line 67

def application_dashboard
  @application_dashboard ||= ApplicationDashboard.new(self)
end

#application_dashboards ⇒ Object 



71
72
73
 
# File 'lib/platform_rest/client.rb', line 71

def application_dashboards
  @application_dashboards ||= ApplicationDashboards.new(self)
end

#application_key ⇒ Object 



75
76
77
 
# File 'lib/platform_rest/client.rb', line 75

def application_key
  @application_key ||= ApplicationKey.new(self)
end

#application_keys ⇒ Object 



79
80
81
 
# File 'lib/platform_rest/client.rb', line 79

def application_keys
  @application_keys ||= ApplicationKeys.new(self)
end

#application_template ⇒ Object 



83
84
85
 
# File 'lib/platform_rest/client.rb', line 83

def application_template
  @application_template ||= ApplicationTemplate.new(self)
end

#application_templates ⇒ Object 



87
88
89
 
# File 'lib/platform_rest/client.rb', line 87

def application_templates
  @application_templates ||= ApplicationTemplates.new(self)
end

#applications ⇒ Object 



91
92
93
 
# File 'lib/platform_rest/client.rb', line 91

def applications
  @applications ||= Applications.new(self)
end

#audit_log ⇒ Object 



95
96
97
 
# File 'lib/platform_rest/client.rb', line 95

def audit_log
  @audit_log ||= AuditLog.new(self)
end

#audit_logs ⇒ Object 



99
100
101
 
# File 'lib/platform_rest/client.rb', line 99

def audit_logs
  @audit_logs ||= AuditLogs.new(self)
end

#auth ⇒ Object 



103
104
105
 
# File 'lib/platform_rest/client.rb', line 103

def auth
  @auth ||= Auth.new(self)
end

#credential ⇒ Object 



107
108
109
 
# File 'lib/platform_rest/client.rb', line 107

def credential
  @credential ||= Credential.new(self)
end

#credentials ⇒ Object 



111
112
113
 
# File 'lib/platform_rest/client.rb', line 111

def credentials
  @credentials ||= Credentials.new(self)
end

#dashboard ⇒ Object 



115
116
117
 
# File 'lib/platform_rest/client.rb', line 115

def dashboard
  @dashboard ||= Dashboard.new(self)
end

#dashboards ⇒ Object 



119
120
121
 
# File 'lib/platform_rest/client.rb', line 119

def dashboards
  @dashboards ||= Dashboards.new(self)
end

#data ⇒ Object 



123
124
125
 
# File 'lib/platform_rest/client.rb', line 123

def data
  @data ||= Data.new(self)
end

#data_table ⇒ Object 



127
128
129
 
# File 'lib/platform_rest/client.rb', line 127

def data_table
  @data_table ||= DataTable.new(self)
end

#data_table_row ⇒ Object 



131
132
133
 
# File 'lib/platform_rest/client.rb', line 131

def data_table_row
  @data_table_row ||= DataTableRow.new(self)
end

#data_table_rows ⇒ Object 



135
136
137
 
# File 'lib/platform_rest/client.rb', line 135

def data_table_rows
  @data_table_rows ||= DataTableRows.new(self)
end

#data_tables ⇒ Object 



139
140
141
 
# File 'lib/platform_rest/client.rb', line 139

def data_tables
  @data_tables ||= DataTables.new(self)
end

#device ⇒ Object 



143
144
145
 
# File 'lib/platform_rest/client.rb', line 143

def device
  @device ||= Device.new(self)
end

#device_recipe ⇒ Object 



147
148
149
 
# File 'lib/platform_rest/client.rb', line 147

def device_recipe
  @device_recipe ||= DeviceRecipe.new(self)
end

#device_recipes ⇒ Object 



151
152
153
 
# File 'lib/platform_rest/client.rb', line 151

def device_recipes
  @device_recipes ||= DeviceRecipes.new(self)
end

#devices ⇒ Object 



155
156
157
 
# File 'lib/platform_rest/client.rb', line 155

def devices
  @devices ||= Devices.new(self)
end

#edge_deployment ⇒ Object 



159
160
161
 
# File 'lib/platform_rest/client.rb', line 159

def edge_deployment
  @edge_deployment ||= EdgeDeployment.new(self)
end

#edge_deployments ⇒ Object 



163
164
165
 
# File 'lib/platform_rest/client.rb', line 163

def edge_deployments
  @edge_deployments ||= EdgeDeployments.new(self)
end

#embedded_deployment ⇒ Object 



167
168
169
 
# File 'lib/platform_rest/client.rb', line 167

def embedded_deployment
  @embedded_deployment ||= EmbeddedDeployment.new(self)
end

#embedded_deployments ⇒ Object 



171
172
173
 
# File 'lib/platform_rest/client.rb', line 171

def embedded_deployments
  @embedded_deployments ||= EmbeddedDeployments.new(self)
end

#event ⇒ Object 



175
176
177
 
# File 'lib/platform_rest/client.rb', line 175

def event
  @event ||= Event.new(self)
end

#events ⇒ Object 



179
180
181
 
# File 'lib/platform_rest/client.rb', line 179

def events
  @events ||= Events.new(self)
end

#experience ⇒ Object 



183
184
185
 
# File 'lib/platform_rest/client.rb', line 183

def experience
  @experience ||= Experience.new(self)
end

#experience_domain ⇒ Object 



187
188
189
 
# File 'lib/platform_rest/client.rb', line 187

def experience_domain
  @experience_domain ||= ExperienceDomain.new(self)
end

#experience_domains ⇒ Object 



191
192
193
 
# File 'lib/platform_rest/client.rb', line 191

def experience_domains
  @experience_domains ||= ExperienceDomains.new(self)
end

#experience_endpoint ⇒ Object 



195
196
197
 
# File 'lib/platform_rest/client.rb', line 195

def experience_endpoint
  @experience_endpoint ||= ExperienceEndpoint.new(self)
end

#experience_endpoints ⇒ Object 



199
200
201
 
# File 'lib/platform_rest/client.rb', line 199

def experience_endpoints
  @experience_endpoints ||= ExperienceEndpoints.new(self)
end

#experience_group ⇒ Object 



203
204
205
 
# File 'lib/platform_rest/client.rb', line 203

def experience_group
  @experience_group ||= ExperienceGroup.new(self)
end

#experience_groups ⇒ Object 



207
208
209
 
# File 'lib/platform_rest/client.rb', line 207

def experience_groups
  @experience_groups ||= ExperienceGroups.new(self)
end

#experience_slug ⇒ Object 



211
212
213
 
# File 'lib/platform_rest/client.rb', line 211

def experience_slug
  @experience_slug ||= ExperienceSlug.new(self)
end

#experience_slugs ⇒ Object 



215
216
217
 
# File 'lib/platform_rest/client.rb', line 215

def experience_slugs
  @experience_slugs ||= ExperienceSlugs.new(self)
end

#experience_user ⇒ Object 



219
220
221
 
# File 'lib/platform_rest/client.rb', line 219

def experience_user
  @experience_user ||= ExperienceUser.new(self)
end

#experience_users ⇒ Object 



223
224
225
 
# File 'lib/platform_rest/client.rb', line 223

def experience_users
  @experience_users ||= ExperienceUsers.new(self)
end

#experience_version ⇒ Object 



227
228
229
 
# File 'lib/platform_rest/client.rb', line 227

def experience_version
  @experience_version ||= ExperienceVersion.new(self)
end

#experience_versions ⇒ Object 



231
232
233
 
# File 'lib/platform_rest/client.rb', line 231

def experience_versions
  @experience_versions ||= ExperienceVersions.new(self)
end

#experience_view ⇒ Object 



235
236
237
 
# File 'lib/platform_rest/client.rb', line 235

def experience_view
  @experience_view ||= ExperienceView.new(self)
end

#experience_views ⇒ Object 



239
240
241
 
# File 'lib/platform_rest/client.rb', line 239

def experience_views
  @experience_views ||= ExperienceViews.new(self)
end

#file ⇒ Object 



243
244
245
 
# File 'lib/platform_rest/client.rb', line 243

def file
  @file ||= File.new(self)
end

#files ⇒ Object 



247
248
249
 
# File 'lib/platform_rest/client.rb', line 247

def files
  @files ||= Files.new(self)
end

#flow ⇒ Object 



251
252
253
 
# File 'lib/platform_rest/client.rb', line 251

def flow
  @flow ||= Flow.new(self)
end

#flow_version ⇒ Object 



255
256
257
 
# File 'lib/platform_rest/client.rb', line 255

def flow_version
  @flow_version ||= FlowVersion.new(self)
end

#flow_versions ⇒ Object 



259
260
261
 
# File 'lib/platform_rest/client.rb', line 259

def flow_versions
  @flow_versions ||= FlowVersions.new(self)
end

#flows ⇒ Object 



263
264
265
 
# File 'lib/platform_rest/client.rb', line 263

def flows
  @flows ||= Flows.new(self)
end

#instance ⇒ Object 



267
268
269
 
# File 'lib/platform_rest/client.rb', line 267

def instance
  @instance ||= Instance.new(self)
end

#instance_api_token ⇒ Object 



271
272
273
 
# File 'lib/platform_rest/client.rb', line 271

def instance_api_token
  @instance_api_token ||= InstanceApiToken.new(self)
end

#instance_api_tokens ⇒ Object 



275
276
277
 
# File 'lib/platform_rest/client.rb', line 275

def instance_api_tokens
  @instance_api_tokens ||= InstanceApiTokens.new(self)
end

#instance_audit_log ⇒ Object 



279
280
281
 
# File 'lib/platform_rest/client.rb', line 279

def instance_audit_log
  @instance_audit_log ||= InstanceAuditLog.new(self)
end

#instance_audit_logs ⇒ Object 



283
284
285
 
# File 'lib/platform_rest/client.rb', line 283

def instance_audit_logs
  @instance_audit_logs ||= InstanceAuditLogs.new(self)
end

#instance_custom_node ⇒ Object 



287
288
289
 
# File 'lib/platform_rest/client.rb', line 287

def instance_custom_node
  @instance_custom_node ||= InstanceCustomNode.new(self)
end

#instance_custom_nodes ⇒ Object 



291
292
293
 
# File 'lib/platform_rest/client.rb', line 291

def instance_custom_nodes
  @instance_custom_nodes ||= InstanceCustomNodes.new(self)
end

#instance_member ⇒ Object 



295
296
297
 
# File 'lib/platform_rest/client.rb', line 295

def instance_member
  @instance_member ||= InstanceMember.new(self)
end

#instance_members ⇒ Object 



299
300
301
 
# File 'lib/platform_rest/client.rb', line 299

def instance_members
  @instance_members ||= InstanceMembers.new(self)
end

#instance_notification_rule ⇒ Object 



303
304
305
 
# File 'lib/platform_rest/client.rb', line 303

def instance_notification_rule
  @instance_notification_rule ||= InstanceNotificationRule.new(self)
end

#instance_notification_rules ⇒ Object 



307
308
309
 
# File 'lib/platform_rest/client.rb', line 307

def instance_notification_rules
  @instance_notification_rules ||= InstanceNotificationRules.new(self)
end

#instance_org ⇒ Object 



311
312
313
 
# File 'lib/platform_rest/client.rb', line 311

def instance_org
  @instance_org ||= InstanceOrg.new(self)
end

#instance_org_invite ⇒ Object 



315
316
317
 
# File 'lib/platform_rest/client.rb', line 315

def instance_org_invite
  @instance_org_invite ||= InstanceOrgInvite.new(self)
end

#instance_org_invites ⇒ Object 



319
320
321
 
# File 'lib/platform_rest/client.rb', line 319

def instance_org_invites
  @instance_org_invites ||= InstanceOrgInvites.new(self)
end

#instance_org_member ⇒ Object 



323
324
325
 
# File 'lib/platform_rest/client.rb', line 323

def instance_org_member
  @instance_org_member ||= InstanceOrgMember.new(self)
end

#instance_org_members ⇒ Object 



327
328
329
 
# File 'lib/platform_rest/client.rb', line 327

def instance_org_members
  @instance_org_members ||= InstanceOrgMembers.new(self)
end

#instance_orgs ⇒ Object 



331
332
333
 
# File 'lib/platform_rest/client.rb', line 331

def instance_orgs
  @instance_orgs ||= InstanceOrgs.new(self)
end

#instance_sandbox ⇒ Object 



335
336
337
 
# File 'lib/platform_rest/client.rb', line 335

def instance_sandbox
  @instance_sandbox ||= InstanceSandbox.new(self)
end

#instance_sandboxes ⇒ Object 



339
340
341
 
# File 'lib/platform_rest/client.rb', line 339

def instance_sandboxes
  @instance_sandboxes ||= InstanceSandboxes.new(self)
end

#instances ⇒ Object 



343
344
345
 
# File 'lib/platform_rest/client.rb', line 343

def instances
  @instances ||= Instances.new(self)
end

#integration ⇒ Object 



347
348
349
 
# File 'lib/platform_rest/client.rb', line 347

def integration
  @integration ||= Integration.new(self)
end

#integrations ⇒ Object 



351
352
353
 
# File 'lib/platform_rest/client.rb', line 351

def integrations
  @integrations ||= Integrations.new(self)
end

#me ⇒ Object 



355
356
357
 
# File 'lib/platform_rest/client.rb', line 355

def me
  @me ||= Me.new(self)
end

#notebook ⇒ Object 



359
360
361
 
# File 'lib/platform_rest/client.rb', line 359

def notebook
  @notebook ||= Notebook.new(self)
end

#notebooks ⇒ Object 



363
364
365
 
# File 'lib/platform_rest/client.rb', line 363

def notebooks
  @notebooks ||= Notebooks.new(self)
end

#org ⇒ Object 



367
368
369
 
# File 'lib/platform_rest/client.rb', line 367

def org
  @org ||= Org.new(self)
end

#org_invites ⇒ Object 



371
372
373
 
# File 'lib/platform_rest/client.rb', line 371

def org_invites
  @org_invites ||= OrgInvites.new(self)
end

#orgs ⇒ Object 



375
376
377
 
# File 'lib/platform_rest/client.rb', line 375

def orgs
  @orgs ||= Orgs.new(self)
end

#request(options = {}) ⇒ Object 



403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/platform_rest/client.rb', line 403

def request(options = {})
  headers = options.fetch(:headers, {})
  method  = options.fetch(:method, :get)

  headers["Accept"]         = "application/json"
  headers["Content-Type"]   = "application/json"
  headers["Accept-Version"] = "^1.27.0"
  headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
  path = self.url + options.fetch(:path, "")

  response = HTTParty.send(method, path,
    query: Utils.fix_query_arrays(options[:query]),
    body: options[:body] && options[:body].to_json(),
    headers: headers)

  result = response.parsed_response
  if response.code >= 400
    raise ResponseError.new(response.code, result)
  end

  result
end

#resource_job ⇒ Object 



379
380
381
 
# File 'lib/platform_rest/client.rb', line 379

def resource_job
  @resource_job ||= ResourceJob.new(self)
end

#resource_jobs ⇒ Object 



383
384
385
 
# File 'lib/platform_rest/client.rb', line 383

def resource_jobs
  @resource_jobs ||= ResourceJobs.new(self)
end

#user_api_token ⇒ Object 



387
388
389
 
# File 'lib/platform_rest/client.rb', line 387

def user_api_token
  @user_api_token ||= UserApiToken.new(self)
end

#user_api_tokens ⇒ Object 



391
392
393
 
# File 'lib/platform_rest/client.rb', line 391

def user_api_tokens
  @user_api_tokens ||= UserApiTokens.new(self)
end

#webhook ⇒ Object 



395
396
397
 
# File 'lib/platform_rest/client.rb', line 395

def webhook
  @webhook ||= Webhook.new(self)
end

#webhooks ⇒ Object 



399
400
401
 
# File 'lib/platform_rest/client.rb', line 399

def webhooks
  @webhooks ||= Webhooks.new(self)
end