losant_rest 2.1.0 → 2.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. checksums.yaml +4 -4
  2. data/docs/_schemas.md +139101 -66992
  3. data/docs/application.md +6 -6
  4. data/docs/applicationCertificates.md +3 -2
  5. data/docs/applicationDashboard.md +1 -1
  6. data/docs/applications.md +1 -1
  7. data/docs/auth.md +1 -1
  8. data/docs/dashboard.md +1 -1
  9. data/docs/dashboards.md +1 -0
  10. data/docs/dataTableRow.md +1 -1
  11. data/docs/dataTableRows.md +3 -3
  12. data/docs/device.md +1 -1
  13. data/docs/edgeDeployments.md +3 -3
  14. data/docs/embeddedDeployments.md +3 -3
  15. data/docs/experience.md +1 -1
  16. data/docs/file.md +4 -4
  17. data/docs/files.md +1 -1
  18. data/docs/flowVersions.md +1 -1
  19. data/docs/instanceApiTokens.md +1 -1
  20. data/docs/instanceMember.md +1 -1
  21. data/docs/instanceOrg.md +1 -1
  22. data/docs/instanceOrgInvite.md +2 -2
  23. data/docs/instanceOrgInvites.md +1 -1
  24. data/docs/instanceOrgMembers.md +2 -1
  25. data/docs/instanceOrgs.md +1 -1
  26. data/docs/me.md +1 -1
  27. data/docs/notebook.md +1 -1
  28. data/docs/org.md +1 -1
  29. data/docs/privateFile.md +4 -4
  30. data/docs/privateFiles.md +1 -1
  31. data/docs/resourceJob.md +2 -2
  32. data/docs/userApiTokens.md +2 -2
  33. data/lib/platform_rest/application.rb +1 -1
  34. data/lib/platform_rest/application_certificates.rb +5 -2
  35. data/lib/platform_rest/application_dashboard.rb +1 -1
  36. data/lib/platform_rest/client.rb +2 -2
  37. data/lib/platform_rest/dashboard.rb +1 -1
  38. data/lib/platform_rest/dashboards.rb +1 -0
  39. data/lib/platform_rest/data_table_row.rb +1 -1
  40. data/lib/platform_rest/data_table_rows.rb +3 -3
  41. data/lib/platform_rest/device.rb +1 -1
  42. data/lib/platform_rest/edge_deployments.rb +3 -3
  43. data/lib/platform_rest/embedded_deployments.rb +3 -3
  44. data/lib/platform_rest/experience.rb +1 -1
  45. data/lib/platform_rest/file.rb +2 -2
  46. data/lib/platform_rest/instance_api_tokens.rb +1 -1
  47. data/lib/platform_rest/instance_member.rb +1 -1
  48. data/lib/platform_rest/instance_org.rb +1 -1
  49. data/lib/platform_rest/instance_org_invite.rb +2 -2
  50. data/lib/platform_rest/instance_org_invites.rb +2 -2
  51. data/lib/platform_rest/instance_org_members.rb +2 -1
  52. data/lib/platform_rest/instance_orgs.rb +1 -1
  53. data/lib/platform_rest/me.rb +1 -1
  54. data/lib/platform_rest/notebook.rb +1 -1
  55. data/lib/platform_rest/org.rb +1 -1
  56. data/lib/platform_rest/private_file.rb +2 -2
  57. data/lib/platform_rest/resource_job.rb +2 -2
  58. data/lib/platform_rest/user_api_tokens.rb +2 -2
  59. data/lib/platform_rest/version.rb +1 -1
  60. data/schemas/advancedApplicationCertQuery.json +1885 -0
  61. data/schemas/advancedApplicationKeyQuery.json +763 -763
  62. data/schemas/apiToken.json +10 -1
  63. data/schemas/apiTokens.json +20 -2
  64. data/schemas/application.json +15 -2
  65. data/schemas/applicationCertificate.json +90 -58
  66. data/schemas/applicationCertificateAuthorities.json +24 -0
  67. data/schemas/applicationCertificateAuthority.json +24 -0
  68. data/schemas/applicationCertificatePatch.json +32 -4
  69. data/schemas/applicationCertificatePost.json +28 -30
  70. data/schemas/applicationCertificates.json +90 -58
  71. data/schemas/applicationCreationByTemplateResult.json +15 -2
  72. data/schemas/applicationDashboardPost.json +179 -128
  73. data/schemas/applicationImportExecutions.json +3 -5
  74. data/schemas/applicationImportResult.json +674 -0
  75. data/schemas/applicationJobLog.json +129 -123
  76. data/schemas/applicationJobLogs.json +129 -123
  77. data/schemas/applicationKey.json +41 -41
  78. data/schemas/applicationKeyPatch.json +4 -4
  79. data/schemas/applicationKeyPost.json +36 -29
  80. data/schemas/applicationKeys.json +41 -41
  81. data/schemas/applicationSearchResult.json +10 -10
  82. data/schemas/applicationTemplates.json +9 -2
  83. data/schemas/applications.json +15 -2
  84. data/schemas/auditLog.json +2 -6
  85. data/schemas/auditLogs.json +2 -6
  86. data/schemas/authedDevice.json +3 -0
  87. data/schemas/credential.json +7 -0
  88. data/schemas/credentialLinkedResources.json +19724 -344
  89. data/schemas/credentialPatch.json +3 -0
  90. data/schemas/credentialPost.json +3 -0
  91. data/schemas/credentials.json +7 -0
  92. data/schemas/dashboard.json +199 -128
  93. data/schemas/dashboardBlockSuggestCodePost.json +19 -0
  94. data/schemas/dashboardPatch.json +179 -128
  95. data/schemas/dashboardPost.json +179 -128
  96. data/schemas/dashboardUpdateEventsResult.json +266 -0
  97. data/schemas/dashboards.json +199 -128
  98. data/schemas/dataTable.json +11 -0
  99. data/schemas/dataTableRowPatch.json +16 -0
  100. data/schemas/dataTableRowPost.json +39 -0
  101. data/schemas/dataTableRowPostResult.json +54 -0
  102. data/schemas/dataTables.json +11 -0
  103. data/schemas/device.json +259 -107
  104. data/schemas/deviceConnectionStatus.json +4 -0
  105. data/schemas/deviceLog.json +3 -0
  106. data/schemas/deviceRecipe.json +259 -108
  107. data/schemas/deviceRecipes.json +259 -108
  108. data/schemas/devices.json +287 -116
  109. data/schemas/edgeDeploymentRelease.json +4252 -39
  110. data/schemas/edgeDeployments.json +28 -0
  111. data/schemas/embeddedDeploymentRelease.json +2073 -0
  112. data/schemas/embeddedDeployments.json +25 -0
  113. data/schemas/error.json +14 -0
  114. data/schemas/event.json +4 -1
  115. data/schemas/eventPlusNewCount.json +4 -1
  116. data/schemas/events.json +4 -1
  117. data/schemas/experienceDomains.json +19 -0
  118. data/schemas/experienceEndpoint.json +19 -0
  119. data/schemas/experienceEndpoints.json +24 -0
  120. data/schemas/experienceLinkedResources.json +19728 -313
  121. data/schemas/experienceSlugs.json +19 -0
  122. data/schemas/experienceUsers.json +16 -2
  123. data/schemas/experienceVersions.json +25 -0
  124. data/schemas/experienceView.json +5 -0
  125. data/schemas/experienceViews.json +10 -0
  126. data/schemas/fileUploadPostResponse.json +92 -103
  127. data/schemas/files.json +5 -1
  128. data/schemas/flow.json +211 -46
  129. data/schemas/flowPatch.json +199 -46
  130. data/schemas/flowPost.json +199 -46
  131. data/schemas/flowStorageMetadata.json +2 -2
  132. data/schemas/flowVersion.json +450 -101
  133. data/schemas/flowVersionPost.json +199 -46
  134. data/schemas/flowVersions.json +9903 -113
  135. data/schemas/flows.json +9637 -46
  136. data/schemas/flowsImportPost.json +398 -92
  137. data/schemas/flowsImportResult.json +661 -147
  138. data/schemas/historicalSummaries.json +3 -2
  139. data/schemas/historicalSummary.json +3 -2
  140. data/schemas/instanceAuditLog.json +2 -6
  141. data/schemas/instanceAuditLogs.json +90 -1
  142. data/schemas/instanceCustomNode.json +41 -2
  143. data/schemas/instanceCustomNodePatch.json +59 -6
  144. data/schemas/instanceCustomNodePost.json +59 -6
  145. data/schemas/instanceCustomNodes.json +41 -2
  146. data/schemas/instanceOrg.json +4 -1
  147. data/schemas/instanceOrgInvite.json +102 -0
  148. data/schemas/instanceOrgInviteSent.json +12 -0
  149. data/schemas/instanceOrgInvites.json +145 -0
  150. data/schemas/instanceOrgMember.json +52 -0
  151. data/schemas/instanceOrgMembers.json +105 -1
  152. data/schemas/instanceOrgPost.json +1 -1
  153. data/schemas/instanceOrgs.json +5 -2
  154. data/schemas/instanceSandbox.json +5 -1
  155. data/schemas/instanceSandboxes.json +9 -1
  156. data/schemas/integration.json +38 -39
  157. data/schemas/integrationPatch.json +8 -8
  158. data/schemas/integrationPost.json +8 -8
  159. data/schemas/integrations.json +38 -39
  160. data/schemas/jobEnqueuedResult.json +1 -1
  161. data/schemas/me.json +685 -88
  162. data/schemas/notebook.json +33 -21
  163. data/schemas/notebookExecutionLogs.json +20 -0
  164. data/schemas/notebookMinuteCounts.json +1 -1
  165. data/schemas/notebookPatch.json +29 -21
  166. data/schemas/notebookPost.json +29 -21
  167. data/schemas/notebooks.json +33 -21
  168. data/schemas/notificationRule.json +4 -0
  169. data/schemas/notificationRules.json +8 -0
  170. data/schemas/org.json +14 -1
  171. data/schemas/orgInvites.json +77 -82
  172. data/schemas/orgInvitesUser.json +44 -47
  173. data/schemas/orgs.json +14 -1
  174. data/schemas/paletteResponse.json +372 -364
  175. data/schemas/periodSummaries.json +1 -1
  176. data/schemas/recentItemList.json +226 -27
  177. data/schemas/resourceJob.json +33 -9
  178. data/schemas/resourceJobExecutionLogs.json +34 -20
  179. data/schemas/resourceJobExecutionOptions.json +1 -1
  180. data/schemas/resourceJobPatch.json +9 -9
  181. data/schemas/resourceJobPost.json +9 -9
  182. data/schemas/resourceJobs.json +33 -9
  183. data/schemas/tagValuesResponse.json +1 -2
  184. data/schemas/templateKeywords.json +1 -0
  185. data/schemas/timeSeriesData.json +36 -4
  186. data/schemas/userOauthToken.json +4 -1
  187. data/schemas/userOauthTokenPost.json +1 -1
  188. data/schemas/userOauthTokens.json +4 -1
  189. data/schemas/validateContextError.json +71 -24
  190. data/schemas/validateContextSuccess.json +71 -24
  191. metadata +10 -1
data/docs/application.md CHANGED
@@ -52,7 +52,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
52
52
  | Name | Type | Required | Description | Default | Example |
53
53
  | ---- | ---- | -------- | ----------- | ------- | ------- |
54
54
  | applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
55
- | options | [Application Apply Template Patch Schema](_schemas.md#application-apply-template-patch-schema) | Y | Object containing template import options | | [Application Apply Template Patch Schema Example](_schemas.md#application-apply-template-patch-schema-example) |
55
+ | options | [Application Apply Template Patch](_schemas.md#application-apply-template-patch) | Y | Object containing template import options | | [Application Apply Template Patch Example](_schemas.md#application-apply-template-patch-example) |
56
56
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
57
57
 
58
58
  #### Successful Responses
@@ -168,7 +168,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
168
168
  | Name | Type | Required | Description | Default | Example |
169
169
  | ---- | ---- | -------- | ----------- | ------- | ------- |
170
170
  | applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
171
- | options | [Application Clone Post Schema](_schemas.md#application-clone-post-schema) | N | Object containing optional clone fields | | [Application Clone Post Schema Example](_schemas.md#application-clone-post-schema-example) |
171
+ | options | [Application Clone Post](_schemas.md#application-clone-post) | N | Object containing optional clone fields | | [Application Clone Post Example](_schemas.md#application-clone-post-example) |
172
172
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
173
173
 
174
174
  #### Successful Responses
@@ -185,7 +185,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
185
185
  | ---- | ---- | ----------- |
186
186
  | 400 | [Error](_schemas.md#error) | Error if malformed request |
187
187
  | 404 | [Error](_schemas.md#error) | Error if application is not found |
188
- | 422 | [Validation Error](_schemas.md#validation-error) | Error if too many validation errors occurred on other resources |
188
+ | 422 | [Validation Errors](_schemas.md#validation-errors) | Error if too many validation errors occurred on other resources |
189
189
 
190
190
  <br/>
191
191
 
@@ -287,7 +287,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
287
287
  | Name | Type | Required | Description | Default | Example |
288
288
  | ---- | ---- | -------- | ----------- | ------- | ------- |
289
289
  | applicationId | string | Y | ID of the associated application | | 575ec8687ae143cd83dc4a97 |
290
- | options | [Application Export Post Schema](_schemas.md#application-export-post-schema) | Y | Object containing export application options | | [Application Export Post Schema Example](_schemas.md#application-export-post-schema-example) |
290
+ | options | [Application Export Post](_schemas.md#application-export-post) | Y | Object containing export application options | | [Application Export Post Example](_schemas.md#application-export-post-example) |
291
291
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
292
292
 
293
293
  #### Successful Responses
@@ -332,7 +332,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
332
332
 
333
333
  | Code | Type | Description |
334
334
  | ---- | ---- | ----------- |
335
- | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive all selected data tables of this application archive location |
335
+ | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive all selected data tables to this application archive location |
336
336
 
337
337
  #### Error Responses
338
338
 
@@ -488,7 +488,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
488
488
 
489
489
  | Code | Type | Description |
490
490
  | ---- | ---- | ----------- |
491
- | 200 | [Application](_schemas.md#application) | Updated application information |
491
+ | 200 | [Application Import Result](_schemas.md#application-import-result) | Updated application information or a dry-run result |
492
492
  | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for the resources to be imported into the application |
493
493
 
494
494
  #### Error Responses
@@ -31,12 +31,13 @@ all.Application, all.Application.bounded, all.Application.read, all.Organization
31
31
  | Name | Type | Required | Description | Default | Example |
32
32
  | ---- | ---- | -------- | ----------- | ------- | ------- |
33
33
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
34
- | sortField | string | N | Field to sort the results by. Accepted values are: certificateInfo.commonName, status, id, creationDate, lastUpdated | certificateInfo.commonName | status |
34
+ | sortField | string | N | Field to sort the results by. Accepted values are: name, certificateInfo.commonName, status, id, creationDate, lastUpdated | certificateInfo.commonName | status |
35
35
  | sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
36
36
  | page | string | N | Which page of results to return | 0 | 0 |
37
37
  | perPage | string | N | How many items to return per page | 100 | 10 |
38
- | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: certificateInfo.commonName, status | | status |
38
+ | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, certificateInfo.commonName, status | | status |
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | the*status |
40
+ | query | [Advanced Application Certificate Query](_schemas.md#advanced-application-certificate-query) | N | Application certificate filter JSON object which overrides the filterField and filter parameters. | | [Advanced Application Certificate Query Example](_schemas.md#advanced-application-certificate-query-example) |
40
41
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
42
 
42
43
  #### Successful Responses
@@ -124,7 +124,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
124
124
 
125
125
  | Code | Type | Description |
126
126
  | ---- | ---- | ----------- |
127
- | 200 | [Dashboard](_schemas.md#dashboard) | Update dashboard information |
127
+ | 200 | [Dashboard](_schemas.md#dashboard) | Updated dashboard information |
128
128
 
129
129
  #### Error Responses
130
130
 
data/docs/applications.md CHANGED
@@ -99,7 +99,7 @@ all.Organization, all.Organization.bounded, all.User, all.User.bounded, applicat
99
99
  | ---- | ---- | ----------- |
100
100
  | 400 | [Error](_schemas.md#error) | Error if malformed request |
101
101
  | 404 | [Error](_schemas.md#error) | Error if application is not found |
102
- | 422 | [Validation Error](_schemas.md#validation-error) | Error if too many validation errors occurred on other resources |
102
+ | 422 | [Validation Errors](_schemas.md#validation-errors) | Error if too many validation errors occurred on other resources |
103
103
 
104
104
  <br/>
105
105
 
data/docs/auth.md CHANGED
@@ -101,7 +101,7 @@ No api access token is required to call this action.
101
101
 
102
102
  | Name | Type | Required | Description | Default | Example |
103
103
  | ---- | ---- | -------- | ----------- | ------- | ------- |
104
- | oauth | [Github Login](_schemas.md#github-login) | Y | User authentication credentials (access token) | | [Github Login Example](_schemas.md#github-login-example) |
104
+ | oauth | [GitHub Login](_schemas.md#github-login) | Y | User authentication credentials (access token) | | [GitHub Login Example](_schemas.md#github-login-example) |
105
105
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
106
106
 
107
107
  #### Successful Responses
data/docs/dashboard.md CHANGED
@@ -116,7 +116,7 @@ all.Organization, all.Organization.bounded, all.User, all.User.bounded, dashboar
116
116
 
117
117
  | Code | Type | Description |
118
118
  | ---- | ---- | ----------- |
119
- | 200 | [Dashboard](_schemas.md#dashboard) | Update dashboard information |
119
+ | 200 | [Dashboard](_schemas.md#dashboard) | Updated dashboard information |
120
120
 
121
121
  #### Error Responses
122
122
 
data/docs/dashboards.md CHANGED
@@ -87,3 +87,4 @@ all.Organization, all.Organization.bounded, all.User, all.User.bounded, dashboar
87
87
  | Code | Type | Description |
88
88
  | ---- | ---- | ----------- |
89
89
  | 400 | [Error](_schemas.md#error) | Error if malformed request |
90
+ | 404 | [Error](_schemas.md#error) | Error if associated application or organization was not found |
data/docs/dataTableRow.md CHANGED
@@ -122,7 +122,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
122
122
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
123
123
  | dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
124
124
  | rowId | string | Y | ID associated with the data table row | | 596f832b128eda5cfe765443 |
125
- | dataTableRow | [Data Table Row Insert Update](_schemas.md#data-table-row-insert-update) | Y | Object containing updated properties for the data table row | | [Data Table Row Insert Update Example](_schemas.md#data-table-row-insert-update-example) |
125
+ | dataTableRow | [Data Table Row Patch](_schemas.md#data-table-row-patch) | Y | Object containing updated properties for the data table row | | [Data Table Row Patch Example](_schemas.md#data-table-row-patch-example) |
126
126
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
127
127
 
128
128
  #### Successful Responses
@@ -146,7 +146,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Application.r
146
146
 
147
147
  ## Post
148
148
 
149
- Inserts a new row(s) into a data table
149
+ Creates new row(s) in a data table
150
150
 
151
151
  ```ruby
152
152
  result = client.data_table_rows.post(
@@ -168,14 +168,14 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
168
168
  | ---- | ---- | -------- | ----------- | ------- | ------- |
169
169
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
170
170
  | dataTableId | string | Y | ID associated with the data table | | 575ed78e7ae143cd83dc4aab |
171
- | dataTableRow | [Data Table Row Insert](_schemas.md#data-table-row-insert) | Y | The row(s) to insert | | [Data Table Row Insert Example](_schemas.md#data-table-row-insert-example) |
171
+ | dataTableRow | [Data Table Row Post](_schemas.md#data-table-row-post) | Y | The row(s) to create | | [Data Table Row Post Example](_schemas.md#data-table-row-post-example) |
172
172
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
173
173
 
174
174
  #### Successful Responses
175
175
 
176
176
  | Code | Type | Description |
177
177
  | ---- | ---- | ----------- |
178
- | 201 | [Data Table Row Insert Result](_schemas.md#data-table-row-insert-result) | Successfully created data table row, or bulk insert count |
178
+ | 201 | [Data Table Row Post Result](_schemas.md#data-table-row-post-result) | Successfully created data table row, or bulk creation information |
179
179
 
180
180
  #### Error Responses
181
181
 
data/docs/device.md CHANGED
@@ -154,7 +154,7 @@ all.Application, all.Application.bounded, all.Application.read, all.Device, all.
154
154
 
155
155
  ## Get Command
156
156
 
157
- Retrieve the last known commands(s) sent to the device
157
+ Retrieve the last known command(s) sent to the device
158
158
 
159
159
  ```ruby
160
160
  result = client.device.get_command(
@@ -87,7 +87,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
87
87
 
88
88
  | Code | Type | Description |
89
89
  | ---- | ---- | ----------- |
90
- | 201 | [Success](_schemas.md#success) | If deployment release has been initiated successfully |
90
+ | 202 | [Success](_schemas.md#success) | If deployment release has been accepted for processing |
91
91
 
92
92
  #### Error Responses
93
93
 
@@ -127,7 +127,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
127
127
 
128
128
  | Code | Type | Description |
129
129
  | ---- | ---- | ----------- |
130
- | 201 | [Success](_schemas.md#success) | If deployment removal has been initiated successfully |
130
+ | 202 | [Success](_schemas.md#success) | If deployment removal has been accepted for processing |
131
131
 
132
132
  #### Error Responses
133
133
 
@@ -167,7 +167,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
167
167
 
168
168
  | Code | Type | Description |
169
169
  | ---- | ---- | ----------- |
170
- | 201 | [Success](_schemas.md#success) | If deployment replacement has been initiated successfully |
170
+ | 202 | [Success](_schemas.md#success) | If deployment replacement has been accepted for processing |
171
171
 
172
172
  #### Error Responses
173
173
 
@@ -125,7 +125,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
125
125
 
126
126
  | Code | Type | Description |
127
127
  | ---- | ---- | ----------- |
128
- | 201 | [Success](_schemas.md#success) | If deployment release has been initiated successfully |
128
+ | 202 | [Success](_schemas.md#success) | If deployment release has been accepted for processing |
129
129
 
130
130
  #### Error Responses
131
131
 
@@ -165,7 +165,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
165
165
 
166
166
  | Code | Type | Description |
167
167
  | ---- | ---- | ----------- |
168
- | 201 | [Success](_schemas.md#success) | If deployment removal has been initiated successfully |
168
+ | 202 | [Success](_schemas.md#success) | If deployment removal has been accepted for processing |
169
169
 
170
170
  #### Error Responses
171
171
 
@@ -205,7 +205,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
205
205
 
206
206
  | Code | Type | Description |
207
207
  | ---- | ---- | ----------- |
208
- | 201 | [Success](_schemas.md#success) | If deployment replacement has been initiated successfully |
208
+ | 202 | [Success](_schemas.md#success) | If deployment replacement has been accepted for processing |
209
209
 
210
210
  #### Error Responses
211
211
 
data/docs/experience.md CHANGED
@@ -78,7 +78,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
78
78
  | removeVersions | string | N | If this is set, all Experience Versions and their contents will be removed (except for develop). | | true |
79
79
  | keepViews | string | N | If this is set, Experience Views (in the develop version) will not be removed. | | true |
80
80
  | keepEndpoints | string | N | If this is set, Experience Endpoints (in the develop version) will not be removed. | | true |
81
- | removeWorkflows | string | N | If this is set, all Experience Workflows (in the develop version) will ve removed. | | true |
81
+ | removeWorkflows | string | N | If this is set, all Experience Workflows (in the develop version) will be removed. | | true |
82
82
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
83
83
 
84
84
  #### Successful Responses
data/docs/file.md CHANGED
@@ -83,7 +83,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Application.r
83
83
 
84
84
  | Code | Type | Description |
85
85
  | ---- | ---- | ----------- |
86
- | 200 | [File Schema](_schemas.md#file-schema) | File information |
86
+ | 200 | [File](_schemas.md#file) | File information |
87
87
 
88
88
  #### Error Responses
89
89
 
@@ -125,7 +125,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
125
125
 
126
126
  | Code | Type | Description |
127
127
  | ---- | ---- | ----------- |
128
- | 201 | [File Schema](_schemas.md#file-schema) | Returns a new file or directory that was created by the move, if a directory a job will kick off to move all the directories children. |
128
+ | 201 | [File](_schemas.md#file) | Returns a new file or directory that was created by the move, if a directory a job will kick off to move all the directory&#x27;s children. |
129
129
 
130
130
  #### Error Responses
131
131
 
@@ -167,7 +167,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
167
167
 
168
168
  | Code | Type | Description |
169
169
  | ---- | ---- | ----------- |
170
- | 201 | [File Upload Post Response](_schemas.md#file-upload-post-response) | Successfully updated file and the information needed to upload the file content |
170
+ | 200 | [File Upload Post Response](_schemas.md#file-upload-post-response) | Successfully updated file and the information needed to upload the file content |
171
171
 
172
172
  #### Error Responses
173
173
 
@@ -209,7 +209,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
209
209
 
210
210
  | Code | Type | Description |
211
211
  | ---- | ---- | ----------- |
212
- | 200 | [File Schema](_schemas.md#file-schema) | Updated file content |
212
+ | 200 | [File](_schemas.md#file) | Updated file content |
213
213
 
214
214
  #### Error Responses
215
215
 
data/docs/files.md CHANGED
@@ -46,7 +46,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Application.r
46
46
 
47
47
  | Code | Type | Description |
48
48
  | ---- | ---- | ----------- |
49
- | 200 | [Files Schema](_schemas.md#files-schema) | Collection of files |
49
+ | 200 | [Files](_schemas.md#files) | Collection of files |
50
50
 
51
51
  #### Error Responses
52
52
 
data/docs/flowVersions.md CHANGED
@@ -36,7 +36,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
36
36
  | ---- | ---- | -------- | ----------- | ------- | ------- |
37
37
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
38
38
  | flowId | string | Y | ID associated with the flow | | 575ed18f7ae143cd83dc4aa6 |
39
- | options | [Flow Versions Delete Post](_schemas.md#flow-versions-delete-post) | Y | Object containing flow version deletion options | | [Flow Versions Delete Post Example](_schemas.md#flow-versions-delete-post-example) |
39
+ | options | [Workflow Versions Delete Post](_schemas.md#workflow-versions-delete-post) | Y | Object containing flow version deletion options | | [Workflow Versions Delete Post Example](_schemas.md#workflow-versions-delete-post-example) |
40
40
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
41
41
 
42
42
  #### Successful Responses
@@ -43,7 +43,7 @@ all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounde
43
43
 
44
44
  | Code | Type | Description |
45
45
  | ---- | ---- | ----------- |
46
- | 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
46
+ | 200 | [API Tokens](_schemas.md#api-tokens) | Collection of API tokens |
47
47
 
48
48
  #### Error Responses
49
49
 
@@ -123,7 +123,7 @@ all.Instance, all.User, instanceMember.*, or instanceMember.patch.
123
123
 
124
124
  | Code | Type | Description |
125
125
  | ---- | ---- | ----------- |
126
- | 200 | [Instance Member Patch](_schemas.md#instance-member-patch) | The modified instance member |
126
+ | 200 | [Instance Member](_schemas.md#instance-member) | The modified instance member |
127
127
 
128
128
  #### Error Responses
129
129
 
data/docs/instanceOrg.md CHANGED
@@ -269,7 +269,7 @@ all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounde
269
269
 
270
270
  ## Payload Counts Breakdown
271
271
 
272
- Returns payload counts per resolution in the time range specified for all application this organization owns
272
+ Returns payload counts per resolution in the time range specified for all applications this organization owns
273
273
 
274
274
  ```ruby
275
275
  result = client.instance_org.payload_counts_breakdown(
@@ -85,7 +85,7 @@ all.Instance, all.Instance.bounded, all.Instance.read, all.User, all.User.bounde
85
85
 
86
86
  | Code | Type | Description |
87
87
  | ---- | ---- | ----------- |
88
- | 200 | [Organization Invitation](_schemas.md#organization-invitation) | A single organization invite |
88
+ | 200 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | A single organization invite |
89
89
 
90
90
  #### Error Responses
91
91
 
@@ -129,7 +129,7 @@ all.Instance, all.User, instanceOrgInvite.*, or instanceOrgInvite.resendInvite.
129
129
 
130
130
  | Code | Type | Description |
131
131
  | ---- | ---- | ----------- |
132
- | 201 | [Organization Invitation](_schemas.md#organization-invitation) | The new org invite |
132
+ | 201 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | The new org invite |
133
133
 
134
134
  #### Error Responses
135
135
 
@@ -86,7 +86,7 @@ all.Instance, all.User, instanceOrgInvites.*, or instanceOrgInvites.post.
86
86
 
87
87
  | Code | Type | Description |
88
88
  | ---- | ---- | ----------- |
89
- | 201 | [Instance Organization Invitations](_schemas.md#instance-organization-invitations) | The new organization invite |
89
+ | 201 | [Instance Organization Invitation](_schemas.md#instance-organization-invitation) | The new organization invite |
90
90
 
91
91
  #### Error Responses
92
92
 
@@ -86,7 +86,8 @@ all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
86
86
 
87
87
  | Code | Type | Description |
88
88
  | ---- | ---- | ----------- |
89
- | 200 | [Instance Org Member](_schemas.md#instance-org-member) | The newly created instance member |
89
+ | 201 | [Instance Org Member](_schemas.md#instance-org-member) | The newly added instance org member |
90
+ | 202 | [Instance Organization Invite Sent](_schemas.md#instance-organization-invite-sent) | An invite was sent to the new member&#x27;s email address |
90
91
 
91
92
  #### Error Responses
92
93
 
data/docs/instanceOrgs.md CHANGED
@@ -83,7 +83,7 @@ all.Instance, all.Instance.bounded, all.User, all.User.bounded, instanceOrgs.*,
83
83
 
84
84
  | Code | Type | Description |
85
85
  | ---- | ---- | ----------- |
86
- | 200 | [Organization](_schemas.md#organization) | The newly created organization |
86
+ | 201 | [Instance Organization](_schemas.md#instance-organization) | The newly created organization |
87
87
 
88
88
  #### Error Responses
89
89
 
data/docs/me.md CHANGED
@@ -215,7 +215,7 @@ all.User, me.*, me.disableTwoFactorAuth, or only.User.
215
215
 
216
216
  ## Disconnect Github
217
217
 
218
- Disconnects the user from Github
218
+ Disconnects the user from GitHub
219
219
 
220
220
  ```ruby
221
221
  result = client.me.disconnect_github(optional_params)
data/docs/notebook.md CHANGED
@@ -42,7 +42,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
42
42
  | ---- | ---- | -------- | ----------- | ------- | ------- |
43
43
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
44
44
  | notebookId | string | Y | ID associated with the notebook | | 575ed78e7ae143cd83dc4aab |
45
- | executionId | undefined | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
45
+ | executionId | string | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
46
46
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
47
47
 
48
48
  #### Successful Responses
data/docs/org.md CHANGED
@@ -342,7 +342,7 @@ all.Organization, all.Organization.bounded, all.Organization.read, all.User, all
342
342
 
343
343
  ## Payload Counts Breakdown
344
344
 
345
- Returns payload counts per resolution in the time range specified for all application this organization owns
345
+ Returns payload counts per resolution in the time range specified for all applications this organization owns
346
346
 
347
347
  ```ruby
348
348
  result = client.org.payload_counts_breakdown(orgId: my_org_id)
data/docs/privateFile.md CHANGED
@@ -84,7 +84,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Application.r
84
84
 
85
85
  | Code | Type | Description |
86
86
  | ---- | ---- | ----------- |
87
- | 200 | [File Schema](_schemas.md#file-schema) | Private file information |
87
+ | 200 | [File](_schemas.md#file) | Private file information |
88
88
 
89
89
  #### Error Responses
90
90
 
@@ -127,7 +127,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
127
127
 
128
128
  | Code | Type | Description |
129
129
  | ---- | ---- | ----------- |
130
- | 201 | [File Schema](_schemas.md#file-schema) | Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directories children. |
130
+ | 201 | [File](_schemas.md#file) | Returns a new private file or directory that was created by the move, if a directory a job will kick off to move all the directory&#x27;s children. |
131
131
 
132
132
  #### Error Responses
133
133
 
@@ -169,7 +169,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
169
169
 
170
170
  | Code | Type | Description |
171
171
  | ---- | ---- | ----------- |
172
- | 201 | [File Upload Post Response](_schemas.md#file-upload-post-response) | Successfully updated private file and the information needed to upload the file content |
172
+ | 200 | [File Upload Post Response](_schemas.md#file-upload-post-response) | Successfully updated private file and the information needed to upload the file content |
173
173
 
174
174
  #### Error Responses
175
175
 
@@ -212,7 +212,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Organization,
212
212
 
213
213
  | Code | Type | Description |
214
214
  | ---- | ---- | ----------- |
215
- | 200 | [File Schema](_schemas.md#file-schema) | Updated private file content |
215
+ | 200 | [File](_schemas.md#file) | Updated private file content |
216
216
 
217
217
  #### Error Responses
218
218
 
data/docs/privateFiles.md CHANGED
@@ -47,7 +47,7 @@ all.Application, all.Application.bounded, all.Application.cli, all.Application.r
47
47
 
48
48
  | Code | Type | Description |
49
49
  | ---- | ---- | ----------- |
50
- | 200 | [Files Schema](_schemas.md#files-schema) | Collection of private files |
50
+ | 200 | [Files](_schemas.md#files) | Collection of private files |
51
51
 
52
52
  #### Error Responses
53
53
 
data/docs/resourceJob.md CHANGED
@@ -39,7 +39,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
39
39
  | ---- | ---- | -------- | ----------- | ------- | ------- |
40
40
  | applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
41
41
  | resourceJobId | string | Y | ID associated with the resource job | | 575ec8687ae143cd83dc4a97 |
42
- | executionId | undefined | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
42
+ | executionId | string | Y | The ID of the execution to cancel | | 632e18632f59592e773a4153 |
43
43
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
44
44
 
45
45
  #### Successful Responses
@@ -253,7 +253,7 @@ all.Application, all.Application.bounded, all.Organization, all.Organization.bou
253
253
 
254
254
  | Code | Type | Description |
255
255
  | ---- | ---- | ----------- |
256
- | 201 | [Resource Job](_schemas.md#resource-job) | Successfully updated resource job |
256
+ | 200 | [Resource Job](_schemas.md#resource-job) | Successfully updated resource job |
257
257
 
258
258
  #### Error Responses
259
259
 
@@ -42,7 +42,7 @@ all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.Us
42
42
 
43
43
  | Code | Type | Description |
44
44
  | ---- | ---- | ----------- |
45
- | 200 | [API Token](_schemas.md#api-token) | Collection of API tokens |
45
+ | 200 | [API Tokens](_schemas.md#api-tokens) | Collection of API tokens |
46
46
 
47
47
  #### Error Responses
48
48
 
@@ -54,7 +54,7 @@ all.User, all.User.bounded, all.User.read, only.User, only.User.bounded, only.Us
54
54
 
55
55
  ## Post
56
56
 
57
- Create a new API token for an user
57
+ Create a new API token for a user
58
58
 
59
59
  ```ruby
60
60
  result = client.user_api_tokens.post(apiToken: my_api_token)
@@ -375,7 +375,7 @@ module PlatformRest
375
375
  # * {boolean} _embedded - Return embedded resources in response
376
376
  #
377
377
  # Responses:
378
- # * 202 - Enqueued a job to archive all selected data tables of this application archive location (https://api.losant.com/#/definitions/jobEnqueuedResult)
378
+ # * 202 - Enqueued a job to archive all selected data tables to this application archive location (https://api.losant.com/#/definitions/jobEnqueuedResult)
379
379
  #
380
380
  # Errors:
381
381
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -41,12 +41,13 @@ module PlatformRest
41
41
  #
42
42
  # Parameters:
43
43
  # * {string} applicationId - ID associated with the application
44
- # * {string} sortField - Field to sort the results by. Accepted values are: certificateInfo.commonName, status, id, creationDate, lastUpdated
44
+ # * {string} sortField - Field to sort the results by. Accepted values are: name, certificateInfo.commonName, status, id, creationDate, lastUpdated
45
45
  # * {string} sortDirection - Direction to sort the results by. Accepted values are: asc, desc
46
46
  # * {string} page - Which page of results to return
47
47
  # * {string} perPage - How many items to return per page
48
- # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: certificateInfo.commonName, status
48
+ # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name, certificateInfo.commonName, status
49
49
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
+ # * {hash} query - Application certificate filter JSON object which overrides the filterField and filter parameters. (https://api.losant.com/#/definitions/advancedApplicationCertQuery)
50
51
  # * {string} losantdomain - Domain scope of request (rarely needed)
51
52
  # * {boolean} _actions - Return resource actions in response
52
53
  # * {boolean} _links - Return resource link in response
@@ -72,6 +73,8 @@ module PlatformRest
72
73
  query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
73
74
  query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
74
75
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
76
+ query_params[:query] = params[:query] if params.has_key?(:query)
77
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
75
78
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
76
79
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
77
80
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -141,7 +141,7 @@ module PlatformRest
141
141
  # * {boolean} _embedded - Return embedded resources in response
142
142
  #
143
143
  # Responses:
144
- # * 200 - Update dashboard information (https://api.losant.com/#/definitions/dashboard)
144
+ # * 200 - Updated dashboard information (https://api.losant.com/#/definitions/dashboard)
145
145
  #
146
146
  # Errors:
147
147
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -27,7 +27,7 @@ module PlatformRest
27
27
  #
28
28
  # User API for accessing platform data
29
29
  #
30
- # Built For Version 1.30.0
30
+ # Built For Version 1.30.1
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -438,7 +438,7 @@ module PlatformRest
438
438
 
439
439
  headers["Accept"] = "application/json"
440
440
  headers["Content-Type"] = "application/json"
441
- headers["Accept-Version"] = "^1.30.0"
441
+ headers["Accept-Version"] = "^1.30.1"
442
442
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
443
443
  path = self.url + options.fetch(:path, "")
444
444
 
@@ -135,7 +135,7 @@ module PlatformRest
135
135
  # * {boolean} _embedded - Return embedded resources in response
136
136
  #
137
137
  # Responses:
138
- # * 200 - Update dashboard information (https://api.losant.com/#/definitions/dashboard)
138
+ # * 200 - Updated dashboard information (https://api.losant.com/#/definitions/dashboard)
139
139
  #
140
140
  # Errors:
141
141
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -108,6 +108,7 @@ module PlatformRest
108
108
  #
109
109
  # Errors:
110
110
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
111
+ # * 404 - Error if associated application or organization was not found (https://api.losant.com/#/definitions/error)
111
112
  def post(params = {})
112
113
  params = Utils.symbolize_hash_keys(params)
113
114
  query_params = { _actions: false, _links: true, _embedded: true }
@@ -139,7 +139,7 @@ module PlatformRest
139
139
  # * {string} applicationId - ID associated with the application
140
140
  # * {string} dataTableId - ID associated with the data table
141
141
  # * {string} rowId - ID associated with the data table row
142
- # * {hash} dataTableRow - Object containing updated properties for the data table row (https://api.losant.com/#/definitions/dataTableRowInsertUpdate)
142
+ # * {hash} dataTableRow - Object containing updated properties for the data table row (https://api.losant.com/#/definitions/dataTableRowPatch)
143
143
  # * {string} losantdomain - Domain scope of request (rarely needed)
144
144
  # * {boolean} _actions - Return resource actions in response
145
145
  # * {boolean} _links - Return resource link in response
@@ -186,7 +186,7 @@ module PlatformRest
186
186
  body: body)
187
187
  end
188
188
 
189
- # Inserts a new row(s) into a data table
189
+ # Creates new row(s) in a data table
190
190
  #
191
191
  # Authentication:
192
192
  # The client must be configured with a valid api
@@ -197,14 +197,14 @@ module PlatformRest
197
197
  # Parameters:
198
198
  # * {string} applicationId - ID associated with the application
199
199
  # * {string} dataTableId - ID associated with the data table
200
- # * {hash} dataTableRow - The row(s) to insert (https://api.losant.com/#/definitions/dataTableRowInsert)
200
+ # * {hash} dataTableRow - The row(s) to create (https://api.losant.com/#/definitions/dataTableRowPost)
201
201
  # * {string} losantdomain - Domain scope of request (rarely needed)
202
202
  # * {boolean} _actions - Return resource actions in response
203
203
  # * {boolean} _links - Return resource link in response
204
204
  # * {boolean} _embedded - Return embedded resources in response
205
205
  #
206
206
  # Responses:
207
- # * 201 - Successfully created data table row, or bulk insert count (https://api.losant.com/#/definitions/dataTableRowInsertResult)
207
+ # * 201 - Successfully created data table row, or bulk creation information (https://api.losant.com/#/definitions/dataTableRowPostResult)
208
208
  #
209
209
  # Errors:
210
210
  # * 400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -187,7 +187,7 @@ module PlatformRest
187
187
  body: body)
188
188
  end
189
189
 
190
- # Retrieve the last known commands(s) sent to the device
190
+ # Retrieve the last known command(s) sent to the device
191
191
  #
192
192
  # Authentication:
193
193
  # The client must be configured with a valid api