losant_rest 1.17.1 → 1.17.2

data/docs/application.md

@@ -96,7 +96,7 @@ all.Application, all.Organization, all.User, application.*, or application.archi
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | Enqueued a job to archive this applications device data |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive this applications device data |
 
 #### Error Responses
 
@@ -133,7 +133,7 @@ all.Application, all.Organization, all.User, application.*, or application.backf
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | Enqueued a job to backfill device data to this application archive location |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to backfill device data to this application archive location |
 
 #### Error Responses
 
@@ -289,7 +289,7 @@ all.Application, all.Organization, all.User, application.*, or application.fullD
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | Enqueued a job to archive all selected data tables of this application archive location |
+| 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 |
 
 #### Error Responses
 
@@ -326,7 +326,7 @@ all.Application, all.Organization, all.User, application.*, or application.fullE
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | Enqueued a job to archive all events to this application archive location |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | Enqueued a job to archive all events to this application archive location |
 
 #### Error Responses
 

data/docs/dashboard.md

@@ -156,7 +156,7 @@ all.Organization, all.User, dashboard.*, or dashboard.sendReport.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | Send dashboard report |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If dashboard report was enqueued to be sent |
 
 #### Error Responses
 

data/docs/data.md

@@ -41,7 +41,7 @@ all.Application, all.Application.read, all.Device, all.Device.read, all.Organiza
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If command was successfully sent |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If command was successfully sent |
 
 #### Error Responses
 

data/docs/dataTableRows.md

@@ -88,7 +88,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success With Job ID](_schemas.md#success-with-job-id) | If request was successfully queued |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If request was successfully queued |
 
 #### Error Responses
 

data/docs/device.md

@@ -96,7 +96,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of export was successfully started |
 
 #### Error Responses
 
@@ -439,7 +439,7 @@ all.Application, all.Organization, all.User, device.*, or device.removeData.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If data removal was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If data removal was successfully started |
 
 #### Error Responses
 

data/docs/deviceRecipe.md

@@ -45,7 +45,7 @@ all.Application, all.Organization, all.User, deviceRecipe.*, or deviceRecipe.bul
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 201 | [Device Recipe Bulk Create](_schemas.md#device-recipe-bulk-create) | If devices were successfully created |
-| 202 | [Device Recipe Bulk Create Enqueue](_schemas.md#device-recipe-bulk-create-enqueue) | If devices were enqueued to be created |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If devices were enqueued to be created |
 
 #### Error Responses
 

data/docs/devices.md

@@ -170,7 +170,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of export was successfully started |
 
 #### Error Responses
 
@@ -299,7 +299,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of export was successfully started |
 
 #### Error Responses
 
@@ -423,6 +423,7 @@ all.Application, all.Device, all.Organization, all.User, devices.*, or devices.s
 | Code | Type | Description |
 | ---- | ---- | ----------- |
 | 200 | [Success](_schemas.md#success) | If command was successfully sent |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If command was queued to be sent |
 
 #### Error Responses
 

data/docs/embeddedDeployments.md

@@ -41,7 +41,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success With Job ID](_schemas.md#success-with-job-id) | If generation of export was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of export was successfully started |
 
 #### Error Responses
 

data/docs/events.md

@@ -80,7 +80,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If generation of export was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of export was successfully started |
 
 #### Error Responses
 
@@ -207,7 +207,8 @@ all.Application, all.Organization, all.User, events.*, or events.patch.
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If the bulk update has been successfully started |
+| 200 | [Success](_schemas.md#success) | If the bulk update has been completed |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If a bulk update job has been enqueued |
 
 #### Error Responses
 

data/docs/experienceGroups.md

@@ -37,6 +37,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | perPage | string | N | How many items to return per page | 100 | 10 |
 | filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name |  | name |
 | filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. |  | my*group |
+| query | [Advanced Experience Group Query](_schemas.md#advanced-experience-group-query) | N | Experience group filter JSON object which overrides the filter and filterField fields. |  | [Advanced Experience Group Query Example](_schemas.md#advanced-experience-group-query-example) |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses

data/docs/instance.md

@@ -40,7 +40,7 @@ all.Instance, all.Instance.read, all.User, all.User.read, instance.*, or instanc
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success](_schemas.md#success) | If generation of report was successfully started |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If generation of report was successfully started |
 
 #### Error Responses
 

data/docs/notebook.md

@@ -296,7 +296,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 
 | Code | Type | Description |
 | ---- | ---- | ----------- |
-| 200 | [Success With Job ID](_schemas.md#success-with-job-id) | If export request was accepted and successfully queued |
+| 202 | [Job Enqueued API Result](_schemas.md#job-enqueued-api-result) | If export request was accepted and successfully queued |
 
 #### Error Responses
 

data/lib/losant_rest/application.rb

@@ -96,7 +96,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Enqueued a job to archive this applications device data (https://api.losant.com/#/definitions/success)
+    # *  202 - Enqueued a job to archive this applications device data (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -142,7 +142,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Enqueued a job to backfill device data to this application archive location (https://api.losant.com/#/definitions/success)
+    # *  202 - Enqueued a job to backfill device data to this application archive location (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -327,7 +327,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Enqueued a job to archive all selected data tables of this application archive location (https://api.losant.com/#/definitions/success)
+    # *  202 - Enqueued a job to archive all selected data tables of this application archive location (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -371,7 +371,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Enqueued a job to archive all events to this application archive location (https://api.losant.com/#/definitions/success)
+    # *  202 - Enqueued a job to archive all events to this application archive location (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/dashboard.rb

@@ -182,7 +182,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - Send dashboard report (https://api.losant.com/#/definitions/success)
+    # *  202 - If dashboard report was enqueued to be sent (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/data.rb

@@ -48,7 +48,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If command was successfully sent (https://api.losant.com/#/definitions/success)
+    # *  202 - If command was successfully sent (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/data_table_rows.rb

@@ -99,7 +99,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If request was successfully queued (https://api.losant.com/#/definitions/successWithJobId)
+    # *  202 - If request was successfully queued (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/device.rb

@@ -99,7 +99,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -515,7 +515,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If data removal was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If data removal was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/device_recipe.rb

@@ -50,7 +50,7 @@ module LosantRest
     #
     # Responses:
     # *  201 - If devices were successfully created (https://api.losant.com/#/definitions/deviceRecipeBulkCreate)
-    # *  202 - If devices were enqueued to be created (https://api.losant.com/#/definitions/deviceRecipeBulkCreateEnqueued)
+    # *  202 - If devices were enqueued to be created (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/devices.rb

@@ -198,7 +198,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -365,7 +365,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -511,6 +511,7 @@ module LosantRest
     #
     # Responses:
     # *  200 - If command was successfully sent (https://api.losant.com/#/definitions/success)
+    # *  202 - If command was queued to be sent (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/embedded_deployments.rb

@@ -48,7 +48,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of export was successfully started (https://api.losant.com/#/definitions/successWithJobId)
+    # *  202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/events.rb

@@ -94,7 +94,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of export was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If generation of export was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)
@@ -253,7 +253,8 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If the bulk update has been successfully started (https://api.losant.com/#/definitions/success)
+    # *  200 - If the bulk update has been completed (https://api.losant.com/#/definitions/success)
+    # *  202 - If a bulk update job has been enqueued (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/experience_groups.rb

@@ -47,6 +47,7 @@ module LosantRest
     # *  {string} perPage - How many items to return per page
     # *  {string} filterField - Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name
     # *  {string} filter - Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering.
+    # *  {hash} query - Experience group filter JSON object which overrides the filter and filterField fields. (https://api.losant.com/#/definitions/advancedExperienceGroupQuery)
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -72,6 +73,8 @@ module LosantRest
       query_params[:perPage] = params[:perPage] if params.has_key?(:perPage)
       query_params[:filterField] = params[:filterField] if params.has_key?(:filterField)
       query_params[:filter] = params[:filter] if params.has_key?(:filter)
+      query_params[:query] = params[:query] if params.has_key?(:query)
+      query_params[:query] = JSON.dump(query_params[:query]) if query_params.has_key?(:query)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)
       query_params[:_actions] = params[:_actions] if params.has_key?(:_actions)
       query_params[:_links] = params[:_links] if params.has_key?(:_links)

data/lib/losant_rest/instance.rb

@@ -48,7 +48,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If generation of report was successfully started (https://api.losant.com/#/definitions/success)
+    # *  202 - If generation of report was successfully started (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/notebook.rb

@@ -338,7 +338,7 @@ module LosantRest
     # *  {boolean} _embedded - Return embedded resources in response
     #
     # Responses:
-    # *  200 - If export request was accepted and successfully queued (https://api.losant.com/#/definitions/successWithJobId)
+    # *  202 - If export request was accepted and successfully queued (https://api.losant.com/#/definitions/jobEnqueuedResult)
     #
     # Errors:
     # *  400 - Error if malformed request (https://api.losant.com/#/definitions/error)

data/lib/losant_rest/version.rb

@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module LosantRest
-  VERSION = "1.17.1"
+  VERSION = "1.17.2"
 end