@browserless.io/browserless 2.24.0-beta-4 → 2.24.0

package/static/docs/swagger.min.json

@@ -62,7 +62,7 @@
       ]
     },
     "CookieParam": {
-      "description": "Cookie parameter object",
+      "description": "Cookie parameter object used to set cookies in the page-level cookies\nAPI.",
       "type": "object",
       "properties": {
         "name": {
@@ -130,7 +130,14 @@
         },
         "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\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         }
       },
       "additionalProperties": false,
@@ -139,6 +146,24 @@
         "value"
       ]
     },
+    "CookiePartitionKey": {
+      "description": "Represents a cookie partition key in Chrome.",
+      "type": "object",
+      "properties": {
+        "sourceOrigin": {
+          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+          "type": "string"
+        },
+        "hasCrossSiteAncestor": {
+          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+          "type": "boolean"
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "sourceOrigin"
+      ]
+    },
     "GoToOptions": {
       "type": "object",
       "properties": {
@@ -255,14 +280,14 @@
                 "length": {
                   "type": "number"
                 },
-                "__@toStringTag@14520": {
+                "__@toStringTag@14524": {
                   "type": "string",
                   "const": "Uint8Array"
                 }
               },
               "required": [
                 "BYTES_PER_ELEMENT",
-                "__@toStringTag@14520",
+                "__@toStringTag@14524",
                 "buffer",
                 "byteLength",
                 "byteOffset",
@@ -297,13 +322,13 @@
         "byteLength": {
           "type": "number"
         },
-        "__@toStringTag@14520": {
+        "__@toStringTag@14524": {
           "type": "string"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@toStringTag@14520",
+        "__@toStringTag@14524",
         "byteLength"
       ]
     },
@@ -313,18 +338,18 @@
         "byteLength": {
           "type": "number"
         },
-        "__@species@14558": {
+        "__@species@14562": {
           "$ref": "#/definitions/SharedArrayBuffer"
         },
-        "__@toStringTag@14520": {
+        "__@toStringTag@14524": {
           "type": "string",
           "const": "SharedArrayBuffer"
         }
       },
       "additionalProperties": false,
       "required": [
-        "__@species@14558",
-        "__@toStringTag@14520",
+        "__@species@14562",
+        "__@toStringTag@14524",
         "byteLength"
       ]
     },
@@ -828,7 +853,14 @@
         },
         "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\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-          "type": "string"
+          "anyOf": [
+            {
+              "$ref": "#/definitions/CookiePartitionKey"
+            },
+            {
+              "type": "string"
+            }
+          ]
         },
         "partitionKeyOpaque": {
           "description": "True if cookie partition key is opaque. Supported only in Chrome.",
@@ -969,7 +1001,7 @@
   },
   "info": {
     "title": "Browserless",
-    "version": "2.24.0-beta-4",
+    "version": "2.24.0",
     "x-logo": {
       "altText": "browserless logo",
       "url": "./docs/browserless-logo-inline.svg"
@@ -1019,6 +1051,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1305,6 +1345,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1413,6 +1461,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -1875,6 +1931,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2163,6 +2227,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2286,6 +2358,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -2741,7 +2821,14 @@
                         },
                         "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\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-                          "type": "string"
+                          "anyOf": [
+                            {
+                              "$ref": "#/definitions/CookiePartitionKey"
+                            },
+                            {
+                              "type": "string"
+                            }
+                          ]
                         },
                         "partitionKeyOpaque": {
                           "description": "True if cookie partition key is opaque. Supported only in Chrome.",
@@ -2761,6 +2848,24 @@
                         "value"
                       ]
                     },
+                    "CookiePartitionKey": {
+                      "description": "Represents a cookie partition key in Chrome.",
+                      "type": "object",
+                      "properties": {
+                        "sourceOrigin": {
+                          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+                          "type": "string"
+                        },
+                        "hasCrossSiteAncestor": {
+                          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+                          "type": "boolean"
+                        }
+                      },
+                      "additionalProperties": false,
+                      "required": [
+                        "sourceOrigin"
+                      ]
+                    },
                     "InBoundRequest": {
                       "type": "object",
                       "properties": {
@@ -2884,6 +2989,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3186,6 +3299,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3275,6 +3396,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3364,6 +3493,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3453,6 +3590,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3541,6 +3686,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3827,6 +3980,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -3935,6 +4096,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4043,6 +4212,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4331,6 +4508,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4454,6 +4639,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -4909,7 +5102,14 @@
                         },
                         "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\n(https://w3c.github.io/webdriver-bidi/#type-storage-PartitionKey).",
-                          "type": "string"
+                          "anyOf": [
+                            {
+                              "$ref": "#/definitions/CookiePartitionKey"
+                            },
+                            {
+                              "type": "string"
+                            }
+                          ]
                         },
                         "partitionKeyOpaque": {
                           "description": "True if cookie partition key is opaque. Supported only in Chrome.",
@@ -4929,6 +5129,24 @@
                         "value"
                       ]
                     },
+                    "CookiePartitionKey": {
+                      "description": "Represents a cookie partition key in Chrome.",
+                      "type": "object",
+                      "properties": {
+                        "sourceOrigin": {
+                          "description": "The site of the top-level URL the browser was visiting at the start of the request\nto the endpoint that set the cookie.\n\nIn Chrome, maps to the CDP's `topLevelSite` partition key.",
+                          "type": "string"
+                        },
+                        "hasCrossSiteAncestor": {
+                          "description": "Indicates if the cookie has any ancestors that are cross-site to\nthe topLevelSite.\n\nSupported only in Chrome.",
+                          "type": "boolean"
+                        }
+                      },
+                      "additionalProperties": false,
+                      "required": [
+                        "sourceOrigin"
+                      ]
+                    },
                     "InBoundRequest": {
                       "type": "object",
                       "properties": {
@@ -5052,6 +5270,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5354,6 +5580,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5443,6 +5677,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5596,6 +5838,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {
@@ -5847,6 +6097,116 @@
         ]
       }
     },
+    "/kill/+([0-9a-zA-Z-_])": {
+      "get": {
+        "definitions": {},
+        "description": "Kill running sessions based on BrowserId or TrackingId.",
+        "parameters": [
+          {
+            "in": "query",
+            "name": "token",
+            "required": true,
+            "schema": {
+              "description": "The authorization token",
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "blockAds",
+            "required": false,
+            "schema": {
+              "description": "Whether or nor to load ad-blocking extensions for the session.\nThis currently uses uBlock Origin and may cause certain sites\nto not load properly.",
+              "type": "boolean"
+            }
+          },
+          {
+            "in": "query",
+            "name": "browserId",
+            "required": false,
+            "schema": {
+              "type": "string"
+            }
+          },
+          {
+            "in": "query",
+            "name": "launch",
+            "required": false,
+            "schema": {
+              "description": "Launch options, which can be either an object\nof puppeteer.launch options or playwright.launchServer\noptions, depending on the API. Must be either JSON\nobject, or a base64-encoded JSON object.",
+              "anyOf": [
+                {
+                  "$ref": "#/definitions/CDPLaunchOptions"
+                },
+                {
+                  "$ref": "#/definitions/BrowserServerOptions"
+                },
+                {
+                  "type": "string"
+                }
+              ]
+            }
+          },
+          {
+            "in": "query",
+            "name": "timeout",
+            "required": false,
+            "schema": {
+              "description": "Override the system-level timeout for this request.\nAccepts a value in milliseconds.",
+              "type": "number"
+            }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "required": false,
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
+          }
+        ],
+        "requestBody": {
+          "content": {}
+        },
+        "responses": {
+          "400": {
+            "code": 400,
+            "description": "The request contains errors or didn't properly encode content.",
+            "message": "HTTP/1.1 400 Bad Request"
+          },
+          "401": {
+            "code": 401,
+            "description": "The request is missing, or contains bad, authorization credentials.",
+            "message": "HTTP/1.1 401 Unauthorized"
+          },
+          "404": {
+            "code": 404,
+            "description": "Resource couldn't be found.",
+            "message": "HTTP/1.1 404 Not Found"
+          },
+          "408": {
+            "code": 408,
+            "description": "The request took has taken too long to process.",
+            "message": "HTTP/1.1 408 Request Timeout"
+          },
+          "429": {
+            "code": 429,
+            "description": "Too many requests are currently being processed.",
+            "message": "HTTP/1.1 429 Too Many Requests"
+          },
+          "500": {
+            "code": 500,
+            "description": "An internal error occurred when handling the request.",
+            "message": "HTTP/1.1 500 Internal Server Error"
+          }
+        },
+        "summary": "/kill/+([0-9a-zA-Z-_])",
+        "tags": [
+          "Management REST APIs"
+        ]
+      }
+    },
     "/meta": {
       "get": {
         "definitions": {},
@@ -6147,6 +6507,7 @@
             "name": "trackingId",
             "required": false,
             "schema": {
+              "description": "Custom session identifier",
               "type": "string"
             }
           }
@@ -6281,6 +6642,14 @@
               "description": "The authorization token",
               "type": "string"
             }
+          },
+          {
+            "in": "query",
+            "name": "trackingId",
+            "schema": {
+              "description": "Custom session identifier",
+              "type": "string"
+            }
           }
         ],
         "requestBody": {