losant_rest 1.19.6 → 1.19.8

Sign up to get free protection for your applications and to get access to all the features.
Files changed (58) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/test.yml +30 -0
  3. data/README.md +2 -2
  4. data/docs/_schemas.md +7742 -2728
  5. data/docs/devices.md +0 -1
  6. data/docs/experienceUsers.md +1 -0
  7. data/docs/instanceOrgs.md +1 -0
  8. data/lib/platform_rest/client.rb +2 -2
  9. data/lib/platform_rest/devices.rb +0 -1
  10. data/lib/platform_rest/experience_users.rb +3 -0
  11. data/lib/platform_rest/instance_orgs.rb +3 -0
  12. data/lib/platform_rest/version.rb +1 -1
  13. data/schemas/advancedExperienceUserQuery.json +1068 -0
  14. data/schemas/advancedInstanceOrgQuery.json +1171 -0
  15. data/schemas/applicationDashboardPost.json +7 -0
  16. data/schemas/credential.json +52 -1
  17. data/schemas/credentialLinkedResources.json +345 -24
  18. data/schemas/credentialPatch.json +62 -0
  19. data/schemas/credentialPost.json +74 -1
  20. data/schemas/credentials.json +52 -1
  21. data/schemas/dashboard.json +7 -0
  22. data/schemas/dashboardPatch.json +7 -0
  23. data/schemas/dashboardPost.json +7 -0
  24. data/schemas/dashboards.json +7 -0
  25. data/schemas/devicesExportPost.json +8 -0
  26. data/schemas/devicesRemoveDataPost.json +10 -0
  27. data/schemas/experienceLinkedResources.json +356 -24
  28. data/schemas/experienceVersion.json +64 -0
  29. data/schemas/experienceVersionPatch.json +64 -0
  30. data/schemas/experienceVersionPost.json +64 -0
  31. data/schemas/experienceVersions.json +64 -0
  32. data/schemas/experienceView.json +11 -0
  33. data/schemas/experienceViewPatch.json +11 -0
  34. data/schemas/experienceViewPost.json +11 -0
  35. data/schemas/experienceViews.json +11 -0
  36. data/schemas/flow.json +115 -8
  37. data/schemas/flowPatch.json +115 -8
  38. data/schemas/flowPost.json +115 -8
  39. data/schemas/flowVersion.json +230 -16
  40. data/schemas/flowVersionPost.json +115 -8
  41. data/schemas/flowVersions.json +230 -16
  42. data/schemas/flows.json +115 -8
  43. data/schemas/flowsImportPost.json +230 -16
  44. data/schemas/flowsImportResult.json +345 -24
  45. data/schemas/instanceCustomNode.json +2 -1
  46. data/schemas/instanceCustomNodePatch.json +3 -9
  47. data/schemas/instanceCustomNodePost.json +3 -9
  48. data/schemas/instanceCustomNodes.json +2 -1
  49. data/schemas/notebook.json +8 -0
  50. data/schemas/notebookPatch.json +8 -0
  51. data/schemas/notebookPost.json +8 -0
  52. data/schemas/notebooks.json +8 -0
  53. data/schemas/resourceJob.json +2 -1
  54. data/schemas/resourceJobExecutionLogs.json +2 -1
  55. data/schemas/resourceJobPost.json +2 -1
  56. data/schemas/resourceJobs.json +2 -1
  57. metadata +5 -3
  58. data/.travis.yml +0 -7
data/docs/devices.md CHANGED
@@ -427,7 +427,6 @@ all.Application, all.Organization, all.User, devices.*, or devices.removeData.
427
427
 
428
428
  | Code | Type | Description |
429
429
  | ---- | ---- | ----------- |
430
- | 200 | [Devices Data Removed](_schemas.md#devices-data-removed) | Object indicating number of devices completed or skipped |
431
430
  | 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a job was enqueued for device data to be removed |
432
431
 
433
432
  #### Error Responses
@@ -39,6 +39,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
39
39
  | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*user |
40
40
  | experienceGroupId | string | N | Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups. | | 575ec8687ae143cd83dc4a97 |
41
41
  | includeAncestorGroups | string | N | If set will include members from ancestors of the specified experienceGroupId | | true |
42
+ | query | [Advanced Experience User Query](_schemas.md#advanced-experience-user-query) | N | Experience user filter JSON object which overrides all other filter params. | | [Advanced Experience User Query Example](_schemas.md#advanced-experience-user-query-example) |
42
43
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
43
44
 
44
45
  #### Successful Responses
data/docs/instanceOrgs.md CHANGED
@@ -38,6 +38,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or ins
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*org |
40
40
  | summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
41
+ | query | [Advanced Instance Organization Query](_schemas.md#advanced-instance-organization-query) | N | Organization filter JSON object which overrides all other filter params. | | [Advanced Instance Organization Query Example](_schemas.md#advanced-instance-organization-query-example) |
41
42
  | losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
42
43
 
43
44
  #### Successful Responses
@@ -27,7 +27,7 @@ module PlatformRest
27
27
  #
28
28
  # User API for accessing platform data
29
29
  #
30
- # Built For Version 1.26.6
30
+ # Built For Version 1.26.8
31
31
  class Client
32
32
  attr_accessor :auth_token, :url
33
33
 
@@ -398,7 +398,7 @@ module PlatformRest
398
398
 
399
399
  headers["Accept"] = "application/json"
400
400
  headers["Content-Type"] = "application/json"
401
- headers["Accept-Version"] = "^1.26.6"
401
+ headers["Accept-Version"] = "^1.26.8"
402
402
  headers["Authorization"] = "Bearer #{self.auth_token}" if self.auth_token
403
403
  path = self.url + options.fetch(:path, "")
404
404
 
@@ -523,7 +523,6 @@ module PlatformRest
523
523
  # * {boolean} _embedded - Return embedded resources in response
524
524
  #
525
525
  # Responses:
526
- # * 200 - Object indicating number of devices completed or skipped (https://api.losant.com/#/definitions/devicesDataRemoved)
527
526
  # * 202 - If a job was enqueued for device data to be removed (https://api.losant.com/#/definitions/jobEnqueuedResult)
528
527
  #
529
528
  # Errors:
@@ -49,6 +49,7 @@ module PlatformRest
49
49
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
50
  # * {string} experienceGroupId - Filter users to those only in the specified group, special experienceGroupIds of 'any' which will give users who are in at least one group and 'none' will give you users who are not in any groups.
51
51
  # * {string} includeAncestorGroups - If set will include members from ancestors of the specified experienceGroupId
52
+ # * {hash} query - Experience user filter JSON object which overrides all other filter params. (https://api.losant.com/#/definitions/advancedExperienceUserQuery)
52
53
  # * {string} losantdomain - Domain scope of request (rarely needed)
53
54
  # * {boolean} _actions - Return resource actions in response
54
55
  # * {boolean} _links - Return resource link in response
@@ -76,6 +77,8 @@ module PlatformRest
76
77
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
77
78
  query_params[:experienceGroupId] = params[:experienceGroupId] if params.has_key?(:experienceGroupId)
78
79
  query_params[:includeAncestorGroups] = params[:includeAncestorGroups] if params.has_key?(:includeAncestorGroups)
80
+ query_params[:query] = params[:query] if params.has_key?(:query)
81
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
79
82
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
80
83
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
81
84
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -48,6 +48,7 @@ module PlatformRest
48
48
  # * {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
49
49
  # * {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
50
50
  # * {string} summaryInclude - Comma-separated list of summary fields to include in org summary
51
+ # * {hash} query - Organization filter JSON object which overrides all other filter params. (https://api.losant.com/#/definitions/advancedInstanceOrgQuery)
51
52
  # * {string} losantdomain - Domain scope of request (rarely needed)
52
53
  # * {boolean} _actions - Return resource actions in response
53
54
  # * {boolean} _links - Return resource link in response
@@ -73,6 +74,8 @@ module PlatformRest
73
74
  query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
74
75
  query_params[:filter] = params[:filter] if params.has_key?(:filter)
75
76
  query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
77
+ query_params[:query] = params[:query] if params.has_key?(:query)
78
+ query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
76
79
  headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
77
80
  query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
78
81
  query_params[:_links] = params[:_links] if params.has_key?(:_links)
@@ -21,5 +21,5 @@
21
21
  # SOFTWARE.
22
22
 
23
23
  module PlatformRest
24
- VERSION = "1.19.6"
24
+ VERSION = "1.19.8"
25
25
  end