losant_rest 1.22.2 → 1.22.4

data/docs/experienceEndpoints.md

@@ -121,7 +121,7 @@ all.Application, all.Application.read, all.Organization, all.Organization.read,
 | end | string | N | End of time range in milliseconds since epoch | 0 | 0 |
 | resolution | string | N | Resolution in milliseconds | 3600000 | 3600000 |
 | versionFilter | string | N | Filters the stats to a particular experience version |  | myVersion |
-| domainFilter | string | N | Filters the stats to a particular experience domain or slug |  | mycustomdomain.com |
+| domainFilter | string | N | Filters the stats to a particular experience domain or slug |  | example.com |
 | statusCodeFilter | string | N | Filters the stats to a particular status code |  | 200 |
 | endpointIdFilter | string | N | Filters the stats to a particular endpoint |  | 575ec8687ae143cd83dc4a98 |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |

data/docs/me.md

@@ -194,6 +194,9 @@ all.User, me.*, or me.disableTwoFactorAuth.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | data | [Disable Multi-Factor Authentication](_schemas.md#disable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties |  | [Disable Multi-Factor Authentication Example](_schemas.md#disable-multi-factor-authentication-example) |
+| includeRecent | string | N | Should the user include recent app/dashboard info |  | true |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -229,6 +232,9 @@ all.User, me.*, or me.disconnectGithub.
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
+| includeRecent | string | N | Should the user include recent app/dashboard info |  | true |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -265,6 +271,9 @@ all.User, me.*, or me.enableTwoFactorAuth.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | data | [Enable Multi-Factor Authentication](_schemas.md#enable-multi-factor-authentication) | Y | Object containing multi-factor authentication properties |  | [Enable Multi-Factor Authentication Example](_schemas.md#enable-multi-factor-authentication-example) |
+| includeRecent | string | N | Should the user include recent app/dashboard info |  | true |
+| summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
+| summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
 
 #### Successful Responses
@@ -372,7 +381,7 @@ all.User, all.User.read, me.*, or me.get.
 
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
-| includeRecent | undefined | N | Should the user include recent app/dashboard info |  | true |
+| includeRecent | string | N | Should the user include recent app/dashboard info |  | true |
 | summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
 | summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |
@@ -519,6 +528,7 @@ all.User, me.*, or me.patch.
 | Name | Type | Required | Description | Default | Example |
 | ---- | ---- | -------- | ----------- | ------- | ------- |
 | user | [Me Patch](_schemas.md#me-patch) | Y | Object containing new user properties |  | [Me Patch Example](_schemas.md#me-patch-example) |
+| includeRecent | string | N | Should the user include recent app/dashboard info |  | true |
 | summaryExclude | string | N | Comma-separated list of summary fields to exclude from user summary |  | payloadCount |
 | summaryInclude | string | N | Comma-separated list of summary fields to include in user summary |  | payloadCount |
 | losantdomain | string | N | Domain scope of request (rarely needed) |  | example.com |

data/lib/platform_rest/client.rb

@@ -27,7 +27,7 @@ module PlatformRest
   #
   # User API for accessing platform data
   #
-  # Built For Version 1.28.1
+  # Built For Version 1.28.4
   class Client
     attr_accessor :auth_token, :url
 
@@ -422,7 +422,7 @@ module PlatformRest
 
       headers["Accept"]         = "application/json"
       headers["Content-Type"]   = "application/json"
-      headers["Accept-Version"] = "^1.28.1"
+      headers["Accept-Version"] = "^1.28.4"
       headers["Authorization"]  = "Bearer #{self.auth_token}" if self.auth_token
       path = self.url + options.fetch(:path, "")
 

data/lib/platform_rest/me.rb

@@ -218,6 +218,9 @@ module PlatformRest
     #
     # Parameters:
     # *  {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthDisable)
+    # *  {string} includeRecent - Should the user include recent app/dashboard info
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -237,6 +240,9 @@ module PlatformRest
       raise ArgumentError.new("data is required") unless params.has_key?(:data)
 
       body = params[:data] if params.has_key?(:data)
+      query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)
@@ -261,6 +267,9 @@ module PlatformRest
     # all.User, me.*, or me.disconnectGithub.
     #
     # Parameters:
+    # *  {string} includeRecent - Should the user include recent app/dashboard info
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -278,6 +287,9 @@ module PlatformRest
       body = nil
 
 
+      query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)
@@ -303,6 +315,9 @@ module PlatformRest
     #
     # Parameters:
     # *  {hash} data - Object containing multi-factor authentication properties (https://api.losant.com/#/definitions/multiFactorAuthEnable)
+    # *  {string} includeRecent - Should the user include recent app/dashboard info
+    # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
+    # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
     # *  {boolean} _actions - Return resource actions in response
     # *  {boolean} _links - Return resource link in response
@@ -322,6 +337,9 @@ module PlatformRest
       raise ArgumentError.new("data is required") unless params.has_key?(:data)
 
       body = params[:data] if params.has_key?(:data)
+      query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
+      query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
+      query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       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)
@@ -433,7 +451,7 @@ module PlatformRest
     # all.User, all.User.read, me.*, or me.get.
     #
     # Parameters:
-    # *  {undefined} includeRecent - Should the user include recent app/dashboard info
+    # *  {string} includeRecent - Should the user include recent app/dashboard info
     # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
     # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -610,6 +628,7 @@ module PlatformRest
     #
     # Parameters:
     # *  {hash} user - Object containing new user properties (https://api.losant.com/#/definitions/mePatch)
+    # *  {string} includeRecent - Should the user include recent app/dashboard info
     # *  {string} summaryExclude - Comma-separated list of summary fields to exclude from user summary
     # *  {string} summaryInclude - Comma-separated list of summary fields to include in user summary
     # *  {string} losantdomain - Domain scope of request (rarely needed)
@@ -631,6 +650,7 @@ module PlatformRest
       raise ArgumentError.new("user is required") unless params.has_key?(:user)
 
       body = params[:user] if params.has_key?(:user)
+      query_params[:includeRecent] = params[:includeRecent] if params.has_key?(:includeRecent)
       query_params[:summaryExclude] = params[:summaryExclude] if params.has_key?(:summaryExclude)
       query_params[:summaryInclude] = params[:summaryInclude] if params.has_key?(:summaryInclude)
       headers[:losantdomain] = params[:losantdomain] if params.has_key?(:losantdomain)

data/lib/platform_rest/version.rb

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2024 Losant IoT, Inc.
+# Copyright (c) 2025 Losant IoT, Inc.
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -21,5 +21,5 @@
 # SOFTWARE.
 
 module PlatformRest
-  VERSION = "1.22.2"
+  VERSION = "1.22.4"
 end

data/schemas/application.json

@@ -461,6 +461,60 @@
           },
           "maxItems": 1000
         },
+        "includeApplicationExport": {
+          "type": "boolean",
+          "default": false
+        },
+        "applicationExportOptions": {
+          "type": "object",
+          "properties": {
+            "includeFiles": {
+              "type": "boolean",
+              "default": false
+            },
+            "includeDataTableRows": {
+              "type": "boolean",
+              "default": false
+            },
+            "includeDevices": {
+              "type": "boolean",
+              "default": false
+            },
+            "exportType": {
+              "type": "string",
+              "enum": [
+                "repo"
+              ],
+              "default": "repo"
+            },
+            "credentialName": {
+              "type": "string",
+              "minLength": 1,
+              "maxLength": 255
+            },
+            "repo": {
+              "type": "object",
+              "properties": {
+                "branch": {
+                  "type": "string",
+                  "maxLength": 255
+                },
+                "directory": {
+                  "type": "string",
+                  "maxLength": 1024
+                },
+                "commitMessage": {
+                  "type": "string",
+                  "maxLength": 1024
+                }
+              }
+            }
+          },
+          "required": [
+            "credentialName"
+          ],
+          "additionalProperties": false
+        },
         "delayDays": {
           "type": "integer",
           "minimum": 1

data/schemas/applicationCreationByTemplateResult.json

@@ -466,6 +466,60 @@
               },
               "maxItems": 1000
             },
+            "includeApplicationExport": {
+              "type": "boolean",
+              "default": false
+            },
+            "applicationExportOptions": {
+              "type": "object",
+              "properties": {
+                "includeFiles": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "includeDataTableRows": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "includeDevices": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "exportType": {
+                  "type": "string",
+                  "enum": [
+                    "repo"
+                  ],
+                  "default": "repo"
+                },
+                "credentialName": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 255
+                },
+                "repo": {
+                  "type": "object",
+                  "properties": {
+                    "branch": {
+                      "type": "string",
+                      "maxLength": 255
+                    },
+                    "directory": {
+                      "type": "string",
+                      "maxLength": 1024
+                    },
+                    "commitMessage": {
+                      "type": "string",
+                      "maxLength": 1024
+                    }
+                  }
+                }
+              },
+              "required": [
+                "credentialName"
+              ],
+              "additionalProperties": false
+            },
             "delayDays": {
               "type": "integer",
               "minimum": 1

data/schemas/applicationPatch.json

@@ -85,159 +85,220 @@
       "maxItems": 100
     },
     "archiveConfig": {
-      "type": "object",
-      "properties": {
-        "directory": {
-          "type": "string",
-          "maxLength": 255
-        },
-        "mode": {
-          "type": "string",
-          "enum": [
-            "all",
-            "whitelist",
-            "blacklist"
-          ]
-        },
-        "deviceIds": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "maxItems": 1000
-        },
-        "deviceTags": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "properties": {
-              "key": {
-                "type": "string",
-                "pattern": "^[0-9a-zA-Z_-]{1,255}$"
-              },
-              "value": {
-                "type": "string",
-                "minLength": 1,
-                "maxLength": 255
-              }
-            },
-            "additionalProperties": false
-          },
-          "maxItems": 100
-        },
-        "includeDevices": {
-          "type": "boolean",
-          "default": true
-        },
-        "includeEvents": {
-          "type": "boolean",
-          "default": false
-        },
-        "includeDataTables": {
-          "type": "boolean",
-          "default": false
-        },
-        "dataTablesMode": {
-          "type": "string",
-          "enum": [
-            "all",
-            "whitelist",
-            "blacklist"
-          ]
-        },
-        "dataTableIds": {
-          "type": "array",
-          "items": {
-            "type": "string",
-            "pattern": "^[A-Fa-f\\d]{24}$"
-          },
-          "maxItems": 1000
-        },
-        "delayDays": {
-          "type": "integer",
-          "minimum": 1
-        },
-        "s3": {
+      "oneOf": [
+        {
           "type": "object",
           "properties": {
-            "bucket": {
+            "directory": {
               "type": "string",
               "maxLength": 255
             },
-            "accessKeyId": {
+            "mode": {
               "type": "string",
-              "minLength": 4,
-              "maxLength": 128
+              "enum": [
+                "all",
+                "whitelist",
+                "blacklist"
+              ]
             },
-            "secretAccessKey": {
-              "type": "string",
-              "minLength": 4,
-              "maxLength": 128
+            "deviceIds": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^[A-Fa-f\\d]{24}$"
+              },
+              "maxItems": 1000
             },
-            "region": {
-              "type": "string",
-              "maxLength": 128
-            }
-          },
-          "required": [
-            "bucket"
-          ],
-          "additionalProperties": false
-        },
-        "credentialName": {
-          "type": "string",
-          "minLength": 1,
-          "maxLength": 255
-        },
-        "gcs": {
-          "type": "object",
-          "properties": {
-            "projectId": {
-              "type": "string",
-              "minLength": 1,
-              "maxLength": 1024
+            "deviceTags": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "key": {
+                    "type": "string",
+                    "pattern": "^[0-9a-zA-Z_-]{1,255}$"
+                  },
+                  "value": {
+                    "type": "string",
+                    "minLength": 1,
+                    "maxLength": 255
+                  }
+                },
+                "additionalProperties": false
+              },
+              "maxItems": 100
             },
-            "keyJson": {
-              "type": "string",
-              "maxLength": 32767,
-              "minLength": 4
+            "includeDevices": {
+              "type": "boolean",
+              "default": true
             },
-            "bucket": {
-              "type": "string",
-              "maxLength": 255
-            }
-          },
-          "required": [
-            "bucket"
-          ],
-          "additionalProperties": false
-        },
-        "azure": {
-          "type": "object",
-          "properties": {
-            "account": {
+            "includeEvents": {
+              "type": "boolean",
+              "default": false
+            },
+            "includeDataTables": {
+              "type": "boolean",
+              "default": false
+            },
+            "dataTablesMode": {
               "type": "string",
-              "minLength": 3,
-              "maxLength": 24
+              "enum": [
+                "all",
+                "whitelist",
+                "blacklist"
+              ]
+            },
+            "dataTableIds": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "pattern": "^[A-Fa-f\\d]{24}$"
+              },
+              "maxItems": 1000
+            },
+            "includeApplicationExport": {
+              "type": "boolean",
+              "default": false
+            },
+            "applicationExportOptions": {
+              "type": "object",
+              "properties": {
+                "includeFiles": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "includeDataTableRows": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "includeDevices": {
+                  "type": "boolean",
+                  "default": false
+                },
+                "exportType": {
+                  "type": "string",
+                  "enum": [
+                    "repo"
+                  ],
+                  "default": "repo"
+                },
+                "credentialName": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 255
+                },
+                "repo": {
+                  "type": "object",
+                  "properties": {
+                    "branch": {
+                      "type": "string",
+                      "maxLength": 255
+                    },
+                    "directory": {
+                      "type": "string",
+                      "maxLength": 1024
+                    },
+                    "commitMessage": {
+                      "type": "string",
+                      "maxLength": 1024
+                    }
+                  }
+                }
+              },
+              "required": [
+                "credentialName"
+              ],
+              "additionalProperties": false
+            },
+            "delayDays": {
+              "type": "integer",
+              "minimum": 1
+            },
+            "s3": {
+              "type": "object",
+              "properties": {
+                "bucket": {
+                  "type": "string",
+                  "maxLength": 255
+                },
+                "accessKeyId": {
+                  "type": "string",
+                  "minLength": 4,
+                  "maxLength": 128
+                },
+                "secretAccessKey": {
+                  "type": "string",
+                  "minLength": 4,
+                  "maxLength": 128
+                },
+                "region": {
+                  "type": "string",
+                  "maxLength": 128
+                }
+              },
+              "required": [
+                "bucket"
+              ],
+              "additionalProperties": false
             },
-            "accountKey": {
+            "credentialName": {
               "type": "string",
+              "minLength": 1,
               "maxLength": 255
             },
-            "bucket": {
-              "type": "string",
-              "minLength": 3,
-              "maxLength": 63
+            "gcs": {
+              "type": "object",
+              "properties": {
+                "projectId": {
+                  "type": "string",
+                  "minLength": 1,
+                  "maxLength": 1024
+                },
+                "keyJson": {
+                  "type": "string",
+                  "maxLength": 32767,
+                  "minLength": 4
+                },
+                "bucket": {
+                  "type": "string",
+                  "maxLength": 255
+                }
+              },
+              "required": [
+                "bucket"
+              ],
+              "additionalProperties": false
+            },
+            "azure": {
+              "type": "object",
+              "properties": {
+                "account": {
+                  "type": "string",
+                  "minLength": 3,
+                  "maxLength": 24
+                },
+                "accountKey": {
+                  "type": "string",
+                  "maxLength": 255
+                },
+                "bucket": {
+                  "type": "string",
+                  "minLength": 3,
+                  "maxLength": 63
+                }
+              },
+              "required": [
+                "bucket"
+              ],
+              "additionalProperties": false
             }
           },
-          "required": [
-            "bucket"
-          ],
           "additionalProperties": false
+        },
+        {
+          "type": "null"
         }
-      },
-      "additionalProperties": false
+      ]
     },
     "blobUrlTTL": {
       "type": "number",