losant_rest 1.7.2 → 1.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (119) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +7347 -4603
  3. data/docs/application.md +47 -0
  4. data/docs/applicationApiToken.md +3 -0
  5. data/docs/applicationApiTokens.md +2 -0
  6. data/docs/applicationKey.md +3 -0
  7. data/docs/applicationKeys.md +2 -0
  8. data/docs/applications.md +2 -0
  9. data/docs/auditLog.md +1 -0
  10. data/docs/auditLogs.md +1 -0
  11. data/docs/auth.md +4 -0
  12. data/docs/dashboard.md +4 -0
  13. data/docs/dashboards.md +2 -0
  14. data/docs/data.md +2 -0
  15. data/docs/dataTable.md +5 -0
  16. data/docs/dataTableRow.md +3 -0
  17. data/docs/dataTableRows.md +9 -3
  18. data/docs/dataTables.md +2 -0
  19. data/docs/device.md +12 -0
  20. data/docs/deviceRecipe.md +4 -0
  21. data/docs/deviceRecipes.md +2 -0
  22. data/docs/devices.md +4 -0
  23. data/docs/edgeDeployments.md +4 -0
  24. data/docs/event.md +3 -0
  25. data/docs/events.md +4 -0
  26. data/docs/experience.md +52 -8
  27. data/docs/experienceDomain.md +3 -0
  28. data/docs/experienceDomains.md +2 -0
  29. data/docs/experienceEndpoint.md +4 -0
  30. data/docs/experienceEndpoints.md +9 -1
  31. data/docs/experienceGroup.md +3 -0
  32. data/docs/experienceGroups.md +2 -0
  33. data/docs/experienceSlug.md +133 -0
  34. data/docs/experienceSlugs.md +87 -0
  35. data/docs/experienceUser.md +3 -0
  36. data/docs/experienceUsers.md +2 -0
  37. data/docs/experienceVersion.md +133 -0
  38. data/docs/experienceVersions.md +93 -0
  39. data/docs/experienceView.md +4 -0
  40. data/docs/experienceViews.md +3 -0
  41. data/docs/file.md +4 -0
  42. data/docs/files.md +2 -0
  43. data/docs/flow.md +8 -0
  44. data/docs/flowVersion.md +4 -0
  45. data/docs/flowVersions.md +2 -0
  46. data/docs/flows.md +54 -1
  47. data/docs/integration.md +3 -0
  48. data/docs/integrations.md +2 -0
  49. data/docs/me.md +19 -3
  50. data/docs/org.md +10 -0
  51. data/docs/orgInvites.md +2 -0
  52. data/docs/orgs.md +2 -0
  53. data/docs/solution.md +3 -0
  54. data/docs/solutionUser.md +3 -0
  55. data/docs/solutionUsers.md +2 -0
  56. data/docs/solutions.md +2 -0
  57. data/docs/webhook.md +3 -0
  58. data/docs/webhooks.md +2 -0
  59. data/lib/losant_rest/application.rb +47 -0
  60. data/lib/losant_rest/client.rb +18 -2
  61. data/lib/losant_rest/data_table_rows.rb +3 -3
  62. data/lib/losant_rest/experience.rb +62 -11
  63. data/lib/losant_rest/experience_endpoint.rb +2 -0
  64. data/lib/losant_rest/experience_endpoints.rb +11 -1
  65. data/lib/losant_rest/experience_slug.rb +174 -0
  66. data/lib/losant_rest/experience_slugs.rb +124 -0
  67. data/lib/losant_rest/experience_version.rb +174 -0
  68. data/lib/losant_rest/experience_versions.rb +136 -0
  69. data/lib/losant_rest/experience_view.rb +2 -0
  70. data/lib/losant_rest/experience_views.rb +2 -0
  71. data/lib/losant_rest/flows.rb +66 -1
  72. data/lib/losant_rest/version.rb +1 -1
  73. data/lib/losant_rest.rb +4 -0
  74. data/schemas/apiTokens.json +128 -0
  75. data/schemas/application.json +6 -0
  76. data/schemas/applicationApiTokenPost.json +18 -0
  77. data/schemas/applications.json +6 -0
  78. data/schemas/dataTableRowInMultiple.json +20 -0
  79. data/schemas/dataTableRowInsert.json +42 -0
  80. data/schemas/dataTableRowInsertResult.json +54 -0
  81. data/schemas/edgeDeployment.json +119 -0
  82. data/schemas/emailVerificationVerify.json +20 -0
  83. data/schemas/experienceBootstrapOptions.json +25 -0
  84. data/schemas/experienceBootstrapResult.json +16 -0
  85. data/schemas/experienceDomain.json +5 -0
  86. data/schemas/experienceDomainPatch.json +12 -0
  87. data/schemas/experienceDomainPost.json +12 -0
  88. data/schemas/experienceDomains.json +5 -0
  89. data/schemas/experienceSlug.json +37 -0
  90. data/schemas/experienceSlugPatch.json +25 -0
  91. data/schemas/experienceSlugPost.json +28 -0
  92. data/schemas/experienceSlugs.json +57 -0
  93. data/schemas/experienceVersion.json +82 -0
  94. data/schemas/experienceVersionPatch.json +19 -0
  95. data/schemas/experienceVersionPost.json +35 -0
  96. data/schemas/experienceVersions.json +102 -0
  97. data/schemas/file.json +3 -0
  98. data/schemas/files.json +3 -0
  99. data/schemas/flow.json +5 -0
  100. data/schemas/flowPatch.json +1 -0
  101. data/schemas/flowPost.json +2 -0
  102. data/schemas/flowVersion.json +622 -433
  103. data/schemas/flowVersionPost.json +1 -0
  104. data/schemas/flowVersions.json +622 -433
  105. data/schemas/flows.json +6 -0
  106. data/schemas/flowsImportPost.json +3 -0
  107. data/schemas/flowsImportResult.json +628 -434
  108. data/schemas/githubLogin.json +18 -0
  109. data/schemas/me.json +12 -0
  110. data/schemas/mqttPublishBody.json +20 -0
  111. data/schemas/org.json +12 -0
  112. data/schemas/orgs.json +12 -0
  113. data/schemas/passwordResetFinish.json +31 -0
  114. data/schemas/passwordResetInput.json +19 -0
  115. data/schemas/passwordResetResponse.json +18 -0
  116. data/schemas/solutionMe.json +150 -0
  117. data/schemas/userCredentials.json +18 -0
  118. data/schemas/userPost.json +388 -0
  119. metadata +32 -2
data/docs/me.md CHANGED
@@ -42,6 +42,7 @@ all.SolutionUser, all.User, me.*, or me.addRecentItem.
42
42
  | Name | Type | Required | Description | Default | Example |
43
43
  | ---- | ---- | -------- | ----------- | ------- | ------- |
44
44
  | data | [Recent Item](_schemas.md#recent-item) | Y | Object containing recent item info | | [Recent Item Example](_schemas.md#recent-item-example) |
45
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
45
46
 
46
47
  #### Successful Responses
47
48
 
@@ -77,6 +78,7 @@ all.SolutionUser, all.User, me.*, or me.changePassword.
77
78
  | Name | Type | Required | Description | Default | Example |
78
79
  | ---- | ---- | -------- | ----------- | ------- | ------- |
79
80
  | data | [Change Password](_schemas.md#change-password) | Y | Object containing the password change info | | [Change Password Example](_schemas.md#change-password-example) |
81
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
80
82
 
81
83
  #### Successful Responses
82
84
 
@@ -112,6 +114,7 @@ all.SolutionUser, all.User, me.*, or me.delete.
112
114
  | Name | Type | Required | Description | Default | Example |
113
115
  | ---- | ---- | -------- | ----------- | ------- | ------- |
114
116
  | credentials | [User Credentials](_schemas.md#user-credentials) | Y | User authentication credentials | | [User Credentials Example](_schemas.md#user-credentials-example) |
117
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
115
118
 
116
119
  #### Successful Responses
117
120
 
@@ -147,6 +150,7 @@ all.SolutionUser, all.User, me.*, or me.disableTwoFactorAuth.
147
150
  | Name | Type | Required | Description | Default | Example |
148
151
  | ---- | ---- | -------- | ----------- | ------- | ------- |
149
152
  | data | [Disable Two Factor Auth](_schemas.md#disable-two-factor-auth) | Y | Object containing two factor auth properties | | [Disable Two Factor Auth Example](_schemas.md#disable-two-factor-auth-example) |
153
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
150
154
 
151
155
  #### Successful Responses
152
156
 
@@ -179,7 +183,9 @@ all.SolutionUser, all.User, me.*, or me.disconnectGithub.
179
183
 
180
184
  #### Available Parameters
181
185
 
182
- No parameters needed for this call.
186
+ | Name | Type | Required | Description | Default | Example |
187
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
188
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
183
189
 
184
190
  #### Successful Responses
185
191
 
@@ -212,7 +218,9 @@ all.SolutionUser, all.User, me.*, or me.disconnectTwitter.
212
218
 
213
219
  #### Available Parameters
214
220
 
215
- No parameters needed for this call.
221
+ | Name | Type | Required | Description | Default | Example |
222
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
223
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
216
224
 
217
225
  #### Successful Responses
218
226
 
@@ -248,6 +256,7 @@ all.SolutionUser, all.User, me.*, or me.enableTwoFactorAuth.
248
256
  | Name | Type | Required | Description | Default | Example |
249
257
  | ---- | ---- | -------- | ----------- | ------- | ------- |
250
258
  | data | [Enable Two Factor Auth](_schemas.md#enable-two-factor-auth) | Y | Object containing two factor auth properties | | [Enable Two Factor Auth Example](_schemas.md#enable-two-factor-auth-example) |
259
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
251
260
 
252
261
  #### Successful Responses
253
262
 
@@ -284,6 +293,7 @@ all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.fe
284
293
  | ---- | ---- | -------- | ----------- | ------- | ------- |
285
294
  | parentId | string | N | Parent id of the recent list | | 575ec8687ae143cd83dc4a97 |
286
295
  | itemType | undefined | Y | Item type to get the recent list of. Accepted values are: application, device, flow, dashboard, organization | | application |
296
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
287
297
 
288
298
  #### Successful Responses
289
299
 
@@ -320,6 +330,7 @@ all.SolutionUser, all.SolutionUser.read, all.User, all.User.read, me.*, or me.ge
320
330
  | ---- | ---- | -------- | ----------- | ------- | ------- |
321
331
  | includeRecent | undefined | N | Should the user include recent app/dashboard info | | true |
322
332
  | summaryExclude | string | N | List of summary fields to exclude from user summary | | payloadCount |
333
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
323
334
 
324
335
  #### Successful Responses
325
336
 
@@ -354,6 +365,7 @@ all.SolutionUser, all.User, me.*, or me.patch.
354
365
  | Name | Type | Required | Description | Default | Example |
355
366
  | ---- | ---- | -------- | ----------- | ------- | ------- |
356
367
  | user | [Me Patch](_schemas.md#me-patch) | Y | Object containing new user properties | | [Me Patch Example](_schemas.md#me-patch-example) |
368
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
357
369
 
358
370
  #### Successful Responses
359
371
 
@@ -390,6 +402,7 @@ all.SolutionUser, all.User, all.User.read, me.*, or me.payloadCounts.
390
402
  | ---- | ---- | -------- | ----------- | ------- | ------- |
391
403
  | start | string | N | Start of range for payload count query (ms since epoch) | | 0 |
392
404
  | end | string | N | End of range for payload count query (ms since epoch) | | 1465790400000 |
405
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
393
406
 
394
407
  #### Successful Responses
395
408
 
@@ -425,6 +438,7 @@ all.SolutionUser, all.User, me.*, or me.transferResources.
425
438
  | Name | Type | Required | Description | Default | Example |
426
439
  | ---- | ---- | -------- | ----------- | ------- | ------- |
427
440
  | transfer | [Resource Transfer](_schemas.md#resource-transfer) | Y | Object containing properties of the transfer | | [Resource Transfer Example](_schemas.md#resource-transfer-example) |
441
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
428
442
 
429
443
  #### Successful Responses
430
444
 
@@ -457,7 +471,9 @@ all.SolutionUser, all.User, me.*, or me.verifyEmail.
457
471
 
458
472
  #### Available Parameters
459
473
 
460
- No parameters needed for this call.
474
+ | Name | Type | Required | Description | Default | Example |
475
+ | ---- | ---- | -------- | ----------- | ------- | ------- |
476
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
461
477
 
462
478
  #### Successful Responses
463
479
 
data/docs/org.md CHANGED
@@ -39,6 +39,7 @@ all.Organization, all.User, org.*, or org.delete.
39
39
  | Name | Type | Required | Description | Default | Example |
40
40
  | ---- | ---- | -------- | ----------- | ------- | ------- |
41
41
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
42
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
42
43
 
43
44
  #### Successful Responses
44
45
 
@@ -76,6 +77,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
76
77
  | ---- | ---- | -------- | ----------- | ------- | ------- |
77
78
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
78
79
  | summaryExclude | string | N | List of summary fields to exclude from org summary | | payloadCount |
80
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
81
 
80
82
  #### Successful Responses
81
83
 
@@ -115,6 +117,7 @@ all.Organization, all.User, org.*, or org.inviteMember.
115
117
  | ---- | ---- | -------- | ----------- | ------- | ------- |
116
118
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
117
119
  | invite | [Organization Invitation Post](_schemas.md#organization-invitation-post) | Y | Object containing new invite info | | [Organization Invitation Post Example](_schemas.md#organization-invitation-post-example) |
120
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
118
121
 
119
122
  #### Successful Responses
120
123
 
@@ -154,6 +157,7 @@ all.Organization, all.User, org.*, or org.modifyMember.
154
157
  | ---- | ---- | -------- | ----------- | ------- | ------- |
155
158
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
156
159
  | member | [Organization Member Patch](_schemas.md#organization-member-patch) | Y | Object containing new member pair | | [Organization Member Patch Example](_schemas.md#organization-member-patch-example) |
160
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
157
161
 
158
162
  #### Successful Responses
159
163
 
@@ -193,6 +197,7 @@ all.Organization, all.User, org.*, or org.patch.
193
197
  | ---- | ---- | -------- | ----------- | ------- | ------- |
194
198
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
195
199
  | organization | [Organization Patch](_schemas.md#organization-patch) | Y | Object containing new organization properties | | [Organization Patch Example](_schemas.md#organization-patch-example) |
200
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
196
201
 
197
202
  #### Successful Responses
198
203
 
@@ -231,6 +236,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
231
236
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
232
237
  | start | string | N | Start of range for payload count query (ms since epoch) | | 0 |
233
238
  | end | string | N | End of range for payload count query (ms since epoch) | | 1465790400000 |
239
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
234
240
 
235
241
  #### Successful Responses
236
242
 
@@ -267,6 +273,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
267
273
  | Name | Type | Required | Description | Default | Example |
268
274
  | ---- | ---- | -------- | ----------- | ------- | ------- |
269
275
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
276
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
270
277
 
271
278
  #### Successful Responses
272
279
 
@@ -306,6 +313,7 @@ all.Organization, all.User, org.*, or org.removeMember.
306
313
  | ---- | ---- | -------- | ----------- | ------- | ------- |
307
314
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
308
315
  | userId | string | Y | Id of user to remove | | 575ed70c7ae143cd83dc4aa9 |
316
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
309
317
 
310
318
  #### Successful Responses
311
319
 
@@ -345,6 +353,7 @@ all.Organization, all.User, org.*, or org.revokeInvite.
345
353
  | ---- | ---- | -------- | ----------- | ------- | ------- |
346
354
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
347
355
  | inviteId | string | Y | Id of invite to revoke | | 575ed71e7ae143cd83dc4aaa |
356
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
348
357
 
349
358
  #### Successful Responses
350
359
 
@@ -384,6 +393,7 @@ all.Organization, all.User, org.*, or org.transferResources.
384
393
  | ---- | ---- | -------- | ----------- | ------- | ------- |
385
394
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
386
395
  | transfer | [Resource Transfer](_schemas.md#resource-transfer) | Y | Object containing properties of the transfer | | [Resource Transfer Example](_schemas.md#resource-transfer-example) |
396
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
387
397
 
388
398
  #### Successful Responses
389
399
 
data/docs/orgInvites.md CHANGED
@@ -32,6 +32,7 @@ No api access token is required to call this action.
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | token | string | Y | The token associated with the invite | | aTokenString |
34
34
  | email | string | Y | The email associated with the invite | | example@example.com |
35
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
35
36
 
36
37
  #### Successful Responses
37
38
 
@@ -67,6 +68,7 @@ No api access token is required to call this action.
67
68
  | Name | Type | Required | Description | Default | Example |
68
69
  | ---- | ---- | -------- | ----------- | ------- | ------- |
69
70
  | invite | [Organization Invitation Action](_schemas.md#organization-invitation-action) | Y | Invite info and acceptance | | [Organization Invitation Action Example](_schemas.md#organization-invitation-action-example) |
71
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
70
72
 
71
73
  #### Successful Responses
72
74
 
data/docs/orgs.md CHANGED
@@ -37,6 +37,7 @@ all.User, all.User.read, orgs.*, or orgs.get.
37
37
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
38
38
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*org |
39
39
  | summaryExclude | string | N | List of summary fields to exclude from org summaries | | payloadCount |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
42
43
 
@@ -72,6 +73,7 @@ all.User, orgs.*, or orgs.post.
72
73
  | Name | Type | Required | Description | Default | Example |
73
74
  | ---- | ---- | -------- | ----------- | ------- | ------- |
74
75
  | organization | [Organization Post](_schemas.md#organization-post) | Y | New organization information | | [Organization Post Example](_schemas.md#organization-post-example) |
76
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
75
77
 
76
78
  #### Successful Responses
77
79
 
data/docs/solution.md CHANGED
@@ -35,6 +35,7 @@ all.Organization, all.User, solution.*, or solution.delete.
35
35
  | ---- | ---- | -------- | ----------- | ------- | ------- |
36
36
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
37
37
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
38
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
38
39
 
39
40
  #### Successful Responses
40
41
 
@@ -74,6 +75,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solution.*, or
74
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
75
76
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
76
77
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
78
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
77
79
 
78
80
  #### Successful Responses
79
81
 
@@ -115,6 +117,7 @@ all.Organization, all.User, solution.*, or solution.patch.
115
117
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
116
118
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
117
119
  | solution | [Solution Patch](_schemas.md#solution-patch) | Y | Object containing new properties of the solution | | [Solution Patch Example](_schemas.md#solution-patch-example) |
120
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
118
121
 
119
122
  #### Successful Responses
120
123
 
data/docs/solutionUser.md CHANGED
@@ -37,6 +37,7 @@ all.Organization, all.User, solutionUser.*, or solutionUser.delete.
37
37
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
38
38
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
39
39
  | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
42
43
 
@@ -78,6 +79,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solutionUser.*
78
79
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
79
80
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
80
81
  | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
82
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
81
83
 
82
84
  #### Successful Responses
83
85
 
@@ -121,6 +123,7 @@ all.Organization, all.User, solutionUser.*, or solutionUser.patch.
121
123
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
122
124
  | solutionUserId | string | Y | ID associated with the solution user | | 566116085df4b701000258e3 |
123
125
  | solutionUser | [Solution User Patch](_schemas.md#solution-user-patch) | Y | Object containing new properties of the solution user | | [Solution User Patch Example](_schemas.md#solution-user-patch-example) |
126
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
124
127
 
125
128
  #### Successful Responses
126
129
 
@@ -40,6 +40,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solutionUsers.
40
40
  | perPage | string | N | How many items to return per page | 1000 | 10 |
41
41
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, firstName, lastName | | email |
42
42
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | email*address |
43
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
43
44
 
44
45
  #### Successful Responses
45
46
 
@@ -80,6 +81,7 @@ all.Organization, all.User, solutionUsers.*, or solutionUsers.post.
80
81
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
81
82
  | solutionId | string | Y | ID associated with the solution | | 57955788124b37010084c053 |
82
83
  | solutionUser | [Solution User Post](_schemas.md#solution-user-post) | Y | New solution user information | | [Solution User Post Example](_schemas.md#solution-user-post-example) |
84
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
85
 
84
86
  #### Successful Responses
85
87
 
data/docs/solutions.md CHANGED
@@ -37,6 +37,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, solutions.*, o
37
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*solution |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
42
43
 
@@ -75,6 +76,7 @@ all.Organization, all.User, solutions.*, or solutions.post.
75
76
  | ---- | ---- | -------- | ----------- | ------- | ------- |
76
77
  | orgId | string | Y | ID associated with the organization | | 575ed6e87ae143cd83dc4aa8 |
77
78
  | solution | [Solution Post](_schemas.md#solution-post) | Y | New solution information | | [Solution Post Example](_schemas.md#solution-post-example) |
79
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
78
80
 
79
81
  #### Successful Responses
80
82
 
data/docs/webhook.md CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, webhook.*, or webhook.delete.
35
35
  | ---- | ---- | -------- | ----------- | ------- | ------- |
36
36
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
37
37
  | webhookId | string | Y | ID associated with the webhook | | 575ed78e7ae143cd83dc4aab |
38
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
38
39
 
39
40
  #### Successful Responses
40
41
 
@@ -74,6 +75,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
74
75
  | ---- | ---- | -------- | ----------- | ------- | ------- |
75
76
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
76
77
  | webhookId | string | Y | ID associated with the webhook | | 575ed78e7ae143cd83dc4aab |
78
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
77
79
 
78
80
  #### Successful Responses
79
81
 
@@ -115,6 +117,7 @@ all.Application, all.Organization, all.User, webhook.*, or webhook.patch.
115
117
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
116
118
  | webhookId | string | Y | ID associated with the webhook | | 575ed78e7ae143cd83dc4aab |
117
119
  | webhook | [Webhook Patch](_schemas.md#webhook-patch) | Y | Object containing new properties of the webhook | | [Webhook Patch Example](_schemas.md#webhook-patch-example) |
120
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
118
121
 
119
122
  #### Successful Responses
120
123
 
data/docs/webhooks.md CHANGED
@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
37
37
  | perPage | string | N | How many items to return per page | 1000 | 10 |
38
38
  | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*webhook |
40
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
40
41
 
41
42
  #### Successful Responses
42
43
 
@@ -76,6 +77,7 @@ all.Application, all.Organization, all.User, webhooks.*, or webhooks.post.
76
77
  | ---- | ---- | -------- | ----------- | ------- | ------- |
77
78
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
78
79
  | webhook | [Webhook Post](_schemas.md#webhook-post) | Y | New webhook information | | [Webhook Post Example](_schemas.md#webhook-post-example) |
80
+ | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
79
81
 
80
82
  #### Successful Responses
81
83
 
@@ -208,6 +208,53 @@ module LosantRest
208
208
  body: body)
209
209
  end
210
210
 
211
+ # Publishes the given message to the given MQTT topic
212
+ #
213
+ # Authentication:
214
+ # The client must be configured with a valid api
215
+ # access token to call this action. The token
216
+ # must include at least one of the following scopes:
217
+ # all.Application, all.Organization, all.User, application.*, or application.mqttPublishMessage.
218
+ #
219
+ # Parameters:
220
+ # * {string} applicationId - ID of the associated application
221
+ # * {hash} payload - Object containing topic and message (https://api.losant.com/#/definitions/mqttPublishBody)
222
+ # * {string} losantdomain - Domain scope of request (rarely needed)
223
+ # * {boolean} _actions - Return resource actions in response
224
+ # * {boolean} _links - Return resource link in response
225
+ # * {boolean} _embedded - Return embedded resources in response
226
+ #
227
+ # Responses:
228
+ # * 200 - Message successfully published (https://api.losant.com/#/definitions/success)
229
+ #
230
+ # Errors:
231
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
232
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
233
+ def mqtt_publish_message(params = {})
234
+ params = Utils.symbolize_hash_keys(params)
235
+ query_params = { _actions: false, _links: true, _embedded: true }
236
+ headers = {}
237
+ body = nil
238
+
239
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
240
+ raise ArgumentError.new("payload is required") unless params.has_key?(:payload)
241
+
242
+ body = params[:payload] if params.has_key?(:payload)
243
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
244
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
245
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
246
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
247
+
248
+ path = "/applications/#{params[:applicationId]}/mqttPublishMessage"
249
+
250
+ @client.request(
251
+ method: :post,
252
+ path: path,
253
+ query: query_params,
254
+ headers: headers,
255
+ body: body)
256
+ end
257
+
211
258
  # Updates information about an application
212
259
  #
213
260
  # Authentication:
@@ -27,7 +27,7 @@ module LosantRest
27
27
  #
28
28
  # User API for accessing Losant data
29
29
  #
30
- # Built For Version 1.12.2
30
+ # Built For Version 1.13.0
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -156,6 +156,14 @@ module LosantRest
156
156
  @experience_groups ||= ExperienceGroups.new(self)
157
157
  end
158
158
 
159
+ def experience_slug
160
+ @experience_slug ||= ExperienceSlug.new(self)
161
+ end
162
+
163
+ def experience_slugs
164
+ @experience_slugs ||= ExperienceSlugs.new(self)
165
+ end
166
+
159
167
  def experience_user
160
168
  @experience_user ||= ExperienceUser.new(self)
161
169
  end
@@ -164,6 +172,14 @@ module LosantRest
164
172
  @experience_users ||= ExperienceUsers.new(self)
165
173
  end
166
174
 
175
+ def experience_version
176
+ @experience_version ||= ExperienceVersion.new(self)
177
+ end
178
+
179
+ def experience_versions
180
+ @experience_versions ||= ExperienceVersions.new(self)
181
+ end
182
+
167
183
  def experience_view
168
184
  @experience_view ||= ExperienceView.new(self)
169
185
  end
@@ -250,7 +266,7 @@ module LosantRest
250
266
 
251
267
  headers["Accept"] = "application/json"
252
268
  headers["Content-Type"] = "application/json"
253
- headers["Accept-Version"] = "^1.12.2"
269
+ headers["Accept-Version"] = "^1.13.0"
254
270
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
255
271
  path = self.url + options.fetch(:path, "")
256
272
 
@@ -181,7 +181,7 @@ module LosantRest
181
181
  body: body)
182
182
  end
183
183
 
184
- # Inserts a new row into a data table
184
+ # Inserts a new row(s) into a data table
185
185
  #
186
186
  # Authentication:
187
187
  # The client must be configured with a valid api
@@ -192,14 +192,14 @@ module LosantRest
192
192
  # Parameters:
193
193
  # * {string} applicationId - ID associated with the application
194
194
  # * {string} dataTableId - ID associated with the data table
195
- # * {hash} dataTableRow - The row to insert (https://api.losant.com/#/definitions/dataTableRowInsertUpdate)
195
+ # * {hash} dataTableRow - The row(s) to insert (https://api.losant.com/#/definitions/dataTableRowInsert)
196
196
  # * {string} losantdomain - Domain scope of request (rarely needed)
197
197
  # * {boolean} _actions - Return resource actions in response
198
198
  # * {boolean} _links - Return resource link in response
199
199
  # * {boolean} _embedded - Return embedded resources in response
200
200
  #
201
201
  # Responses:
202
- # * 201 - Successfully created data table row (https://api.losant.com/#/definitions/dataTableRow)
202
+ # * 201 - Successfully created data table row, or bulk insert count (https://api.losant.com/#/definitions/dataTableRowInsertResult)
203
203
  #
204
204
  # Errors:
205
205
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -29,7 +29,54 @@ module LosantRest
29
29
  @client = client
30
30
  end
31
31
 
32
- # Deletes multiple parts of an experience including users, domains, endpoints, groups, views, and workflows
32
+ # Bootstraps the experience for this application with standard endpoints and views
33
+ #
34
+ # Authentication:
35
+ # The client must be configured with a valid api
36
+ # access token to call this action. The token
37
+ # must include at least one of the following scopes:
38
+ # all.Application, all.Organization, all.User, experience.*, or experience.bootstrap.
39
+ #
40
+ # Parameters:
41
+ # * {string} applicationId - ID associated with the application
42
+ # * {hash} options - Bootstrap options (https://api.losant.com/#/definitions/experienceBootstrapOptions)
43
+ # * {string} losantdomain - Domain scope of request (rarely needed)
44
+ # * {boolean} _actions - Return resource actions in response
45
+ # * {boolean} _links - Return resource link in response
46
+ # * {boolean} _embedded - Return embedded resources in response
47
+ #
48
+ # Responses:
49
+ # * 200 - If bootstrap was successful (https://api.losant.com/#/definitions/experienceBootstrapResult)
50
+ #
51
+ # Errors:
52
+ # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
53
+ # * 404 - Error if application was not found (https://api.losant.com/#/definitions/error)
54
+ def bootstrap(params = {})
55
+ params = Utils.symbolize_hash_keys(params)
56
+ query_params = { _actions: false, _links: true, _embedded: true }
57
+ headers = {}
58
+ body = nil
59
+
60
+ raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
61
+ raise ArgumentError.new("options is required") unless params.has_key?(:options)
62
+
63
+ body = params[:options] if params.has_key?(:options)
64
+ headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
65
+ query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
66
+ query_params[:_links] = params[:_links] if params.has_key?(:_links)
67
+ query_params[:_embedded] = params[:_embedded] if params.has_key?(:_embedded)
68
+
69
+ path = "/applications/#{params[:applicationId]}/experience/bootstrap"
70
+
71
+ @client.request(
72
+ method: :patch,
73
+ path: path,
74
+ query: query_params,
75
+ headers: headers,
76
+ body: body)
77
+ end
78
+
79
+ # Deletes multiple parts of an experience including users, groups, slugs, domains, versions, endpoints, views, and workflows
33
80
  #
34
81
  # Authentication:
35
82
  # The client must be configured with a valid api
@@ -39,19 +86,21 @@ module LosantRest
39
86
  #
40
87
  # Parameters:
41
88
  # * {string} applicationId - ID associated with the application
42
- # * {string} keepUser - Experience Users will automatically be deleted unless this is set.
43
- # * {string} keepDomains - Experience Domains will automatically be deleted unless this is set.
44
- # * {string} keepEndpoints - Experience Endpoints will automatically be deleted unless this is set.
45
- # * {string} keepGroups - Experience Groups will automatically be deleted unless this is set.
46
- # * {string} keepViews - Experience Views will automatically be deleted unless this is set.
47
- # * {string} removeWorkflows - If set will delete any workflows under this application with an Endpoint Trigger Node.
89
+ # * {string} keepUsers - If this is set, Experience Users will not be removed.
90
+ # * {string} keepGroups - If this is set, Experience Groups will not be removed.
91
+ # * {string} keepSlugs - If this is set, Experience Slugs will not be removed.
92
+ # * {string} keepDomains - If this is set, Experience Domains will not be removed.
93
+ # * {string} removeVersions - If this is set, all Experience Versions and their contents will be removed (except for develop).
94
+ # * {string} keepViews - If this is set, Experience Views (in the develop version) will not be removed.
95
+ # * {string} keepEndpoints - If this is set, Experience Endpoints (in the develop version) will not be removed.
96
+ # * {string} removeWorkflows - If this is set, all Experience Workflows (in the develop version) will ve removed.
48
97
  # * {string} losantdomain - Domain scope of request (rarely needed)
49
98
  # * {boolean} _actions - Return resource actions in response
50
99
  # * {boolean} _links - Return resource link in response
51
100
  # * {boolean} _embedded - Return embedded resources in response
52
101
  #
53
102
  # Responses:
54
- # * 200 - If everything marked as true was successfully deleted (https://api.losant.com/#/definitions/success)
103
+ # * 200 - If deletion was successful (https://api.losant.com/#/definitions/success)
55
104
  #
56
105
  # Errors:
57
106
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -64,11 +113,13 @@ module LosantRest
64
113
 
65
114
  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
66
115
 
67
- query_params[:keepUser] = params[:keepUser] if params.has_key?(:keepUser)
68
- query_params[:keepDomains] = params[:keepDomains] if params.has_key?(:keepDomains)
69
- query_params[:keepEndpoints] = params[:keepEndpoints] if params.has_key?(:keepEndpoints)
116
+ query_params[:keepUsers] = params[:keepUsers] if params.has_key?(:keepUsers)
70
117
  query_params[:keepGroups] = params[:keepGroups] if params.has_key?(:keepGroups)
118
+ query_params[:keepSlugs] = params[:keepSlugs] if params.has_key?(:keepSlugs)
119
+ query_params[:keepDomains] = params[:keepDomains] if params.has_key?(:keepDomains)
120
+ query_params[:removeVersions] = params[:removeVersions] if params.has_key?(:removeVersions)
71
121
  query_params[:keepViews] = params[:keepViews] if params.has_key?(:keepViews)
122
+ query_params[:keepEndpoints] = params[:keepEndpoints] if params.has_key?(:keepEndpoints)
72
123
  query_params[:removeWorkflows] = params[:removeWorkflows] if params.has_key?(:removeWorkflows)
73
124
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
74
125
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
@@ -86,6 +86,7 @@ module LosantRest
86
86
  # Parameters:
87
87
  # * {string} applicationId - ID associated with the application
88
88
  # * {string} experienceEndpointId - ID associated with the experience endpoint
89
+ # * {string} version - Version of this experience endpoint to return
89
90
  # * {string} losantdomain - Domain scope of request (rarely needed)
90
91
  # * {boolean} _actions - Return resource actions in response
91
92
  # * {boolean} _links - Return resource link in response
@@ -106,6 +107,7 @@ module LosantRest
106
107
  raise ArgumentError.new("applicationId is required") unless params.has_key?(:applicationId)
107
108
  raise ArgumentError.new("experienceEndpointId is required") unless params.has_key?(:experienceEndpointId)
108
109
 
110
+ query_params[:version] = params[:version] if params.has_key?(:version)
109
111
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
110
112
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
111
113
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -45,6 +45,7 @@ module LosantRest
45
45
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
46
46
  # * {string} experienceGroupId - Filter endpoints to those only in the specified group
47
47
  # * {string} requestCountDuration - If set, a count of recent requests is included on each endpoint for the duration requested (milliseconds)
48
+ # * {string} version - Return the experience endpoints belonging to this version
48
49
  # * {string} losantdomain - Domain scope of request (rarely needed)
49
50
  # * {boolean} _actions - Return resource actions in response
50
51
  # * {boolean} _links - Return resource link in response
@@ -70,6 +71,7 @@ module LosantRest
70
71
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
71
72
  query_params[:experienceGroupId] = params[:experienceGroupId] if params.has_key?(:experienceGroupId)
72
73
  query_params[:requestCountDuration] = params[:requestCountDuration] if params.has_key?(:requestCountDuration)
74
+ query_params[:version] = params[:version] if params.has_key?(:version)
73
75
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
74
76
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
75
77
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -142,9 +144,13 @@ module LosantRest
142
144
  #
143
145
  # Parameters:
144
146
  # * {string} applicationId - ID associated with the application
145
- # * {string} statGrouping - Field to group the statistics by. Accepted values are: statusCode, endpointId
147
+ # * {string} statGrouping - Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain
146
148
  # * {string} duration - Duration in milliseconds
147
149
  # * {string} resolution - Resolution in milliseconds
150
+ # * {string} versionFilter - Filters the stats to a particular experience version
151
+ # * {string} domainFilter - Filters the stats to a particular experience domain or slug
152
+ # * {string} statusCodeFilter - Filters the stats to a particular status code
153
+ # * {string} endpointIdFilter - Filters the stats to a particular endpoint
148
154
  # * {string} losantdomain - Domain scope of request (rarely needed)
149
155
  # * {boolean} _actions - Return resource actions in response
150
156
  # * {boolean} _links - Return resource link in response
@@ -167,6 +173,10 @@ module LosantRest
167
173
  query_params[:statGrouping] = params[:statGrouping] if params.has_key?(:statGrouping)
168
174
  query_params[:duration] = params[:duration] if params.has_key?(:duration)
169
175
  query_params[:resolution] = params[:resolution] if params.has_key?(:resolution)
176
+ query_params[:versionFilter] = params[:versionFilter] if params.has_key?(:versionFilter)
177
+ query_params[:domainFilter] = params[:domainFilter] if params.has_key?(:domainFilter)
178
+ query_params[:statusCodeFilter] = params[:statusCodeFilter] if params.has_key?(:statusCodeFilter)
179
+ query_params[:endpointIdFilter] = params[:endpointIdFilter] if params.has_key?(:endpointIdFilter)
170
180
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
171
181
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
172
182
  query_params[:_links] = params[:_links] if params.has_key?(:_links)