@browserless.io/browserless 2.34.0 → 2.36.0

package/static/docs/swagger.min.json

@@ -249,6 +249,82 @@
       "type": "object",
       "additionalProperties": false
     },
+    "Protocol.Emulation.UserAgentMetadata": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+      "type": "object",
+      "properties": {
+        "brands": {
+          "description": "Brands appearing in Sec-CH-UA.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersionList": {
+          "description": "Brands appearing in Sec-CH-UA-Full-Version-List.",
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/Protocol.Emulation.UserAgentBrandVersion"
+          }
+        },
+        "fullVersion": {
+          "type": "string"
+        },
+        "platform": {
+          "type": "string"
+        },
+        "platformVersion": {
+          "type": "string"
+        },
+        "architecture": {
+          "type": "string"
+        },
+        "model": {
+          "type": "string"
+        },
+        "mobile": {
+          "type": "boolean"
+        },
+        "bitness": {
+          "type": "string"
+        },
+        "wow64": {
+          "type": "boolean"
+        },
+        "formFactors": {
+          "description": "Used to specify User Agent form-factor values.\nSee https://wicg.github.io/ua-client-hints/#sec-ch-ua-form-factors",
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "architecture",
+        "mobile",
+        "model",
+        "platform",
+        "platformVersion"
+      ]
+    },
+    "Protocol.Emulation.UserAgentBrandVersion": {
+      "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints",
+      "type": "object",
+      "properties": {
+        "brand": {
+          "type": "string"
+        },
+        "version": {
+          "type": "string"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "brand",
+        "version"
+      ]
+    },
     "Viewport": {
       "type": "object",
       "properties": {
@@ -676,18 +752,6 @@
       "description": "Represents a cookie object.",
       "type": "object",
       "properties": {
-        "name": {
-          "description": "Cookie name.",
-          "type": "string"
-        },
-        "value": {
-          "description": "Cookie value.",
-          "type": "string"
-        },
-        "domain": {
-          "description": "Cookie domain.",
-          "type": "string"
-        },
         "path": {
           "description": "Cookie path.",
           "type": "string"
@@ -700,10 +764,6 @@
           "description": "Cookie size.",
           "type": "number"
         },
-        "httpOnly": {
-          "description": "True if cookie is http-only.",
-          "type": "boolean"
-        },
         "secure": {
           "description": "True if cookie is secure.",
           "type": "boolean"
@@ -712,6 +772,26 @@
           "description": "True in case of session cookie.",
           "type": "boolean"
         },
+        "partitionKeyOpaque": {
+          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+          "type": "boolean"
+        },
+        "name": {
+          "description": "Cookie name.",
+          "type": "string"
+        },
+        "value": {
+          "description": "Cookie value.",
+          "type": "string"
+        },
+        "domain": {
+          "description": "Cookie domain.",
+          "type": "string"
+        },
+        "httpOnly": {
+          "description": "True if cookie is http-only.",
+          "type": "boolean"
+        },
         "sameSite": {
           "description": "Cookie SameSite type.",
           "enum": [
@@ -744,7 +824,7 @@
           "type": "string"
         },
         "partitionKey": {
-          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
           "anyOf": [
             {
               "$ref": "#/definitions/CookiePartitionKey"
@@ -753,17 +833,12 @@
               "type": "string"
             }
           ]
-        },
-        "partitionKeyOpaque": {
-          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-          "type": "boolean"
         }
       },
       "additionalProperties": false,
       "required": [
         "domain",
         "expires",
-        "httpOnly",
         "name",
         "path",
         "secure",
@@ -906,7 +981,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.34.0",
+    "version": "2.36.0",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -1094,7 +1169,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -2029,7 +2117,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -2490,7 +2591,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -2756,18 +2870,6 @@
                       "description": "Represents a cookie object.",
                       "type": "object",
                       "properties": {
-                        "name": {
-                          "description": "Cookie name.",
-                          "type": "string"
-                        },
-                        "value": {
-                          "description": "Cookie value.",
-                          "type": "string"
-                        },
-                        "domain": {
-                          "description": "Cookie domain.",
-                          "type": "string"
-                        },
                         "path": {
                           "description": "Cookie path.",
                           "type": "string"
@@ -2780,10 +2882,6 @@
                           "description": "Cookie size.",
                           "type": "number"
                         },
-                        "httpOnly": {
-                          "description": "True if cookie is http-only.",
-                          "type": "boolean"
-                        },
                         "secure": {
                           "description": "True if cookie is secure.",
                           "type": "boolean"
@@ -2792,6 +2890,26 @@
                           "description": "True in case of session cookie.",
                           "type": "boolean"
                         },
+                        "partitionKeyOpaque": {
+                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+                          "type": "boolean"
+                        },
+                        "name": {
+                          "description": "Cookie name.",
+                          "type": "string"
+                        },
+                        "value": {
+                          "description": "Cookie value.",
+                          "type": "string"
+                        },
+                        "domain": {
+                          "description": "Cookie domain.",
+                          "type": "string"
+                        },
+                        "httpOnly": {
+                          "description": "True if cookie is http-only.",
+                          "type": "boolean"
+                        },
                         "sameSite": {
                           "description": "Cookie SameSite type.",
                           "enum": [
@@ -2824,7 +2942,7 @@
                           "type": "string"
                         },
                         "partitionKey": {
-                          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+                          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
                           "anyOf": [
                             {
                               "$ref": "#/definitions/CookiePartitionKey"
@@ -2833,17 +2951,12 @@
                               "type": "string"
                             }
                           ]
-                        },
-                        "partitionKeyOpaque": {
-                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-                          "type": "boolean"
                         }
                       },
                       "additionalProperties": false,
                       "required": [
                         "domain",
                         "expires",
-                        "httpOnly",
                         "name",
                         "path",
                         "secure",
@@ -3144,7 +3257,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -3468,7 +3594,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -4029,7 +4168,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -4490,7 +4642,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -4756,18 +4921,6 @@
                       "description": "Represents a cookie object.",
                       "type": "object",
                       "properties": {
-                        "name": {
-                          "description": "Cookie name.",
-                          "type": "string"
-                        },
-                        "value": {
-                          "description": "Cookie value.",
-                          "type": "string"
-                        },
-                        "domain": {
-                          "description": "Cookie domain.",
-                          "type": "string"
-                        },
                         "path": {
                           "description": "Cookie path.",
                           "type": "string"
@@ -4780,10 +4933,6 @@
                           "description": "Cookie size.",
                           "type": "number"
                         },
-                        "httpOnly": {
-                          "description": "True if cookie is http-only.",
-                          "type": "boolean"
-                        },
                         "secure": {
                           "description": "True if cookie is secure.",
                           "type": "boolean"
@@ -4792,6 +4941,26 @@
                           "description": "True in case of session cookie.",
                           "type": "boolean"
                         },
+                        "partitionKeyOpaque": {
+                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+                          "type": "boolean"
+                        },
+                        "name": {
+                          "description": "Cookie name.",
+                          "type": "string"
+                        },
+                        "value": {
+                          "description": "Cookie value.",
+                          "type": "string"
+                        },
+                        "domain": {
+                          "description": "Cookie domain.",
+                          "type": "string"
+                        },
+                        "httpOnly": {
+                          "description": "True if cookie is http-only.",
+                          "type": "boolean"
+                        },
                         "sameSite": {
                           "description": "Cookie SameSite type.",
                           "enum": [
@@ -4824,7 +4993,7 @@
                           "type": "string"
                         },
                         "partitionKey": {
-                          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+                          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
                           "anyOf": [
                             {
                               "$ref": "#/definitions/CookiePartitionKey"
@@ -4833,17 +5002,12 @@
                               "type": "string"
                             }
                           ]
-                        },
-                        "partitionKeyOpaque": {
-                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-                          "type": "boolean"
                         }
                       },
                       "additionalProperties": false,
                       "required": [
                         "domain",
                         "expires",
-                        "httpOnly",
                         "name",
                         "path",
                         "secure",
@@ -5144,7 +5308,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -5468,7 +5645,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -6029,7 +6219,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -6490,7 +6693,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [
@@ -6756,18 +6972,6 @@
                       "description": "Represents a cookie object.",
                       "type": "object",
                       "properties": {
-                        "name": {
-                          "description": "Cookie name.",
-                          "type": "string"
-                        },
-                        "value": {
-                          "description": "Cookie value.",
-                          "type": "string"
-                        },
-                        "domain": {
-                          "description": "Cookie domain.",
-                          "type": "string"
-                        },
                         "path": {
                           "description": "Cookie path.",
                           "type": "string"
@@ -6780,10 +6984,6 @@
                           "description": "Cookie size.",
                           "type": "number"
                         },
-                        "httpOnly": {
-                          "description": "True if cookie is http-only.",
-                          "type": "boolean"
-                        },
                         "secure": {
                           "description": "True if cookie is secure.",
                           "type": "boolean"
@@ -6792,6 +6992,26 @@
                           "description": "True in case of session cookie.",
                           "type": "boolean"
                         },
+                        "partitionKeyOpaque": {
+                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
+                          "type": "boolean"
+                        },
+                        "name": {
+                          "description": "Cookie name.",
+                          "type": "string"
+                        },
+                        "value": {
+                          "description": "Cookie value.",
+                          "type": "string"
+                        },
+                        "domain": {
+                          "description": "Cookie domain.",
+                          "type": "string"
+                        },
+                        "httpOnly": {
+                          "description": "True if cookie is http-only.",
+                          "type": "boolean"
+                        },
                         "sameSite": {
                           "description": "Cookie SameSite type.",
                           "enum": [
@@ -6824,7 +7044,7 @@
                           "type": "string"
                         },
                         "partitionKey": {
-                          "description": "Cookie partition key. In Chrome, it is the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
+                          "description": "Cookie partition key. In Chrome, it matches the top-level site the\npartitioned cookie is available in. In Firefox, it matches the\nsource origin in the\n{@link https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey PartitionKey}.",
                           "anyOf": [
                             {
                               "$ref": "#/definitions/CookiePartitionKey"
@@ -6833,17 +7053,12 @@
                               "type": "string"
                             }
                           ]
-                        },
-                        "partitionKeyOpaque": {
-                          "description": "True if cookie partition key is opaque. Supported only in Chrome.",
-                          "type": "boolean"
                         }
                       },
                       "additionalProperties": false,
                       "required": [
                         "domain",
                         "expires",
-                        "httpOnly",
                         "name",
                         "path",
                         "secure",
@@ -7144,7 +7359,20 @@
                     "type": "string"
                   },
                   "userAgent": {
-                    "type": "string"
+                    "type": "object",
+                    "properties": {
+                      "userAgent": {
+                        "type": "string"
+                      },
+                      "userAgentMetadata": {
+                        "description": "Used to specify User Agent Client Hints to emulate. See https://wicg.github.io/ua-client-hints\nMissing optional values will be filled in by the target with what it would normally use.",
+                        "$ref": "#/definitions/Protocol.Emulation.UserAgentMetadata"
+                      },
+                      "platform": {
+                        "type": "string"
+                      }
+                    },
+                    "additionalProperties": false
                   },
                   "viewport": {
                     "anyOf": [