@wdio/protocols 9.16.2 → 9.23.1

package/build/index.js

@@ -67,19 +67,19 @@ var webdriver_default = {
       parameters: [
         {
           name: "implicit",
-          type: "number",
+          type: "(number|null)",
           description: "integer in ms for session implicit wait timeout",
           required: false
         },
         {
           name: "pageLoad",
-          type: "number",
+          type: "(number|null)",
           description: "integer in ms for session page load timeout",
           required: false
         },
         {
           name: "script",
-          type: "number",
+          type: "(number|null)",
           description: "integer in ms for session script timeout",
           required: false
         }
@@ -1362,13 +1362,13 @@ var webdriver_default = {
           name: "protocol",
           type: "string",
           description: "Valid values: 'ctap1/u2f', 'ctap2', 'ctap2_1'.",
-          required: false
+          required: true
         },
         {
           name: "transport",
           type: "string",
           description: "Valid values: 'usb', 'nfc', 'ble' or 'internal'.",
-          required: false
+          required: true
         },
         {
           name: "hasResidentKey",
@@ -1391,19 +1391,19 @@ var webdriver_default = {
         {
           name: "isUserVerified",
           type: "boolean",
-          description: "Valid values: An array containing extension identifiers.",
+          description: "Valid values: true, false.",
           required: false
         },
         {
           name: "extensions",
           type: "string[]",
-          description: "Valid values: Up to 3 User Verification Method entries.",
+          description: "An array of extension identifiers",
           required: false
         },
         {
           name: "uvm",
           type: "object[]",
-          description: "",
+          description: "Valid values: Up to 3 User Verification Method entries.",
           required: false
         }
       ],
@@ -1468,13 +1468,13 @@ var webdriver_default = {
           name: "userHandle",
           type: "string",
           description: "The userHandle associated to the credential encoded using Base64url Encoding. This property may not be defined.",
-          required: true
+          required: false
         },
         {
           name: "signCount",
-          type: "number",
+          type: "(number|null)",
           description: "The initial value for a signature counter associated to the public key credential source.",
-          required: true
+          required: false
         },
         {
           name: "largeBlob",
@@ -1545,7 +1545,14 @@ var webdriver_default = {
           description: "id of authenticator"
         }
       ],
-      parameters: []
+      parameters: [
+        {
+          name: "isUserVerified",
+          type: "boolean",
+          description: "Whether to always succeed in user verification",
+          required: true
+        }
+      ]
     }
   }
 };
@@ -2403,6 +2410,7 @@ var mjsonwp_default = {
     GET: {
       command: "getNetworkConnection",
       ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes",
+      deprecated: "For Appium Android automation, use `driver.execute('mobile: getConnectivity', { ... })` instead",
       parameters: [],
       returns: {
         type: "number",
@@ -2413,6 +2421,7 @@ var mjsonwp_default = {
     POST: {
       command: "setNetworkConnection",
       ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-modes",
+      deprecated: "For Appium Android automation, use `driver.execute('mobile: setConnectivity', { ... })` instead",
       parameters: [
         {
           name: "type",
@@ -2427,6 +2436,7 @@ var mjsonwp_default = {
     GET: {
       command: "touchPerform",
       ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#touch-gestures",
+      deprecated: "For Appium, use `driver.performActions(...)` instead",
       parameters: [
         {
           name: "actions",
@@ -2441,6 +2451,7 @@ var mjsonwp_default = {
     GET: {
       command: "multiTouchPerform",
       ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#touch-gestures",
+      deprecated: "For Appium, use `driver.performActions(...)` instead",
       parameters: [
         {
           name: "actions",
@@ -2460,6 +2471,7 @@ var mjsonwp_default = {
     POST: {
       command: "receiveAsyncResponse",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#mobile-json-wire-protocol-endpoints",
+      deprecated: "For Appium, use `driver.executeAsyncScript(...)` instead",
       parameters: [
         {
           name: "status",
@@ -3023,7 +3035,7 @@ var appium_default = {
     GET: {
       command: "getSession",
       description: "Retrieve the capabilities of the current session.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#getsession",
       deprecated: "Use `getAppiumSessionCapabilities` instead",
       parameters: [],
       returns: {
@@ -3036,7 +3048,7 @@ var appium_default = {
   "/session/:sessionId/context": {
     GET: {
       command: "getAppiumContext",
-      ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
+      ref: "https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcurrentcontext",
       parameters: [],
       returns: {
         type: "Context",
@@ -3046,7 +3058,7 @@ var appium_default = {
     },
     POST: {
       command: "switchAppiumContext",
-      ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
+      ref: "https://appium.io/docs/en/latest/reference/api/mjsonwp/#setcontext",
       parameters: [
         {
           name: "name",
@@ -3060,7 +3072,7 @@ var appium_default = {
   "/session/:sessionId/contexts": {
     GET: {
       command: "getAppiumContexts",
-      ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#webviews-and-other-contexts",
+      ref: "https://appium.io/docs/en/latest/reference/api/mjsonwp/#getcontexts",
       parameters: [],
       returns: {
         type: "Context[]",
@@ -3073,7 +3085,7 @@ var appium_default = {
     GET: {
       command: "getAppiumCommands",
       description: "Retrieve the endpoints and BiDi commands supported in the current session.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#listcommands",
       parameters: [],
       returns: {
         type: "Object",
@@ -3086,7 +3098,7 @@ var appium_default = {
     GET: {
       command: "getAppiumExtensions",
       description: "Retrieve the extension commands supported in the current session.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#listextensions",
       parameters: [],
       returns: {
         type: "Object",
@@ -3099,7 +3111,7 @@ var appium_default = {
     GET: {
       command: "getAppiumSessionCapabilities",
       description: "Retrieve the capabilities of the current session.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/lib/protocol/routes.js",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#getappiumsessioncapabilities",
       parameters: [],
       returns: {
         type: "Object",
@@ -3113,6 +3125,7 @@ var appium_default = {
       command: "shake",
       description: "Perform a shake action on the device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/shake/",
+      deprecated: "Use `driver.execute('mobile: shake')` instead",
       parameters: [],
       support: {
         ios: {
@@ -3127,6 +3140,7 @@ var appium_default = {
       command: "lock",
       description: "Lock the device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/lock/",
+      deprecated: "Use `driver.execute('mobile: lock', { ... })` instead",
       parameters: [
         {
           name: "seconds",
@@ -3153,6 +3167,7 @@ var appium_default = {
       command: "unlock",
       description: "Unlock the device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/unlock/",
+      deprecated: "Use `driver.execute('mobile: unlock')` instead",
       parameters: [],
       support: {
         android: {
@@ -3169,6 +3184,7 @@ var appium_default = {
       command: "isLocked",
       description: "Check whether the device is locked or not.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/interactions/is-locked/",
+      deprecated: "Use `driver.execute('mobile: isLocked')` instead",
       parameters: [],
       returns: {
         type: "boolean",
@@ -3265,6 +3281,7 @@ var appium_default = {
       command: "getPerformanceDataTypes",
       description: "Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/performance-data-types/",
+      deprecated: "Use `driver.execute('mobile: getPerformanceDataTypes')` instead",
       parameters: [],
       returns: {
         type: "string[]",
@@ -3283,6 +3300,7 @@ var appium_default = {
       command: "getPerformanceData",
       description: "Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/performance-data/get-performance-data/",
+      deprecated: "Use `driver.execute('mobile: getPerformanceData', { ... })` instead",
       parameters: [
         {
           name: "packageName",
@@ -3320,6 +3338,7 @@ var appium_default = {
       command: "pressKeyCode",
       description: "Press a particular key on the device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/press-keycode/",
+      deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
       parameters: [
         {
           name: "keycode",
@@ -3352,6 +3371,7 @@ var appium_default = {
       command: "longPressKeyCode",
       description: "Press and hold a particular key code on the device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/long-press-keycode/",
+      deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
       parameters: [
         {
           name: "keycode",
@@ -3384,6 +3404,7 @@ var appium_default = {
       command: "sendKeyEvent",
       description: "Send a key code to the device.",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
+      deprecated: "Use `driver.execute('mobile: pressKey', { ... })` instead",
       parameters: [
         {
           name: "keycode",
@@ -3409,7 +3430,7 @@ var appium_default = {
     POST: {
       command: "rotateDevice",
       description: "Rotate the device in three dimensions.",
-      ref: "https://github.com/SeleniumHQ/mobile-spec/blob/master/spec-draft.md#device-rotation",
+      ref: "https://appium.io/docs/en/latest/reference/api/mjsonwp/#setrotation",
       parameters: [
         {
           name: "x",
@@ -3448,6 +3469,7 @@ var appium_default = {
       command: "getCurrentActivity",
       description: "Get the name of the current Android activity.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-activity/",
+      deprecated: "Use `driver.execute('mobile: getCurrentActivity')` instead",
       parameters: [],
       returns: {
         type: "string",
@@ -3466,6 +3488,7 @@ var appium_default = {
       command: "getCurrentPackage",
       description: "Get the name of the current Android package.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/current-package/",
+      deprecated: "Use `driver.execute('mobile: getCurrentPackage')` instead",
       parameters: [],
       returns: {
         type: "string",
@@ -3483,13 +3506,19 @@ var appium_default = {
     POST: {
       command: "installApp",
       description: "Install the given app onto the device.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/install-app/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#installapp",
       parameters: [
         {
           name: "appPath",
           type: "string",
-          description: "path to application .apk file",
+          description: "Path to application .apk file",
           required: true
+        },
+        {
+          name: "options",
+          type: "object",
+          description: "Driver-specific installation options",
+          required: false
         }
       ],
       support: {
@@ -3506,14 +3535,26 @@ var appium_default = {
   "/session/:sessionId/appium/device/activate_app": {
     POST: {
       command: "activateApp",
-      description: "Activate the given app onto the device",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/activate-app/",
+      description: "Activate the given app on the device",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#activateapp",
       parameters: [
         {
           name: "appId",
           type: "string",
-          description: "App ID (package ID for Android, bundle ID for iOS)",
-          required: true
+          description: "App package ID (required for Android)",
+          required: false
+        },
+        {
+          name: "bundleId",
+          type: "string",
+          description: "Bundle ID (required for iOS)",
+          required: false
+        },
+        {
+          name: "options",
+          type: "object",
+          description: "Driver-specific launch options",
+          required: false
         }
       ],
       support: {
@@ -3530,15 +3571,32 @@ var appium_default = {
     POST: {
       command: "removeApp",
       description: "Remove an app from the device.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/remove-app/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#removeapp",
       parameters: [
         {
           name: "appId",
           type: "string",
-          description: "App ID (package ID for Android, bundle ID for iOS)",
-          required: true
+          description: "App package ID (required for Android)",
+          required: false
+        },
+        {
+          name: "bundleId",
+          type: "string",
+          description: "Bundle ID (required for iOS)",
+          required: false
+        },
+        {
+          name: "options",
+          type: "object",
+          description: "Driver-specific uninstall options",
+          required: false
         }
       ],
+      returns: {
+        type: "boolean",
+        name: "didRemovalSucceed",
+        description: "Return true if uninstall was successful, false if not"
+      },
       support: {
         ios: {
           XCUITest: "9.3+",
@@ -3554,18 +3612,24 @@ var appium_default = {
     POST: {
       command: "terminateApp",
       description: "Terminate the given app on the device",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/terminate-app/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#terminateapp",
       parameters: [
         {
           name: "appId",
           type: "string",
-          description: "App ID (package ID for Android, bundle ID for iOS)",
-          required: true
+          description: "App package ID (required for Android)",
+          required: false
+        },
+        {
+          name: "bundleId",
+          type: "string",
+          description: "Bundle ID (required for iOS)",
+          required: false
         },
         {
           name: "options",
           type: "object",
-          description: 'Command options. E.g. "timeout": (Only Android) Timeout to retry terminate the app (see more in Appium docs)',
+          description: "Driver-specific termination options",
           required: false
         }
       ],
@@ -3583,13 +3647,19 @@ var appium_default = {
     POST: {
       command: "isAppInstalled",
       description: "Check whether the specified app is installed on the device.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/is-app-installed/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#isappinstalled",
       parameters: [
         {
           name: "appId",
           type: "string",
-          description: "App ID (package ID for Android, bundle ID for iOS)",
-          required: true
+          description: "App package ID (required for Android)",
+          required: false
+        },
+        {
+          name: "bundleId",
+          type: "string",
+          description: "Bundle ID (required for iOS)",
+          required: false
         }
       ],
       returns: {
@@ -3612,19 +3682,25 @@ var appium_default = {
     POST: {
       command: "queryAppState",
       description: "Get the given app status on the device",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/app-state/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#queryappstate",
       parameters: [
         {
           name: "appId",
           type: "string",
-          description: "App ID (package ID for Android, bundle ID for iOS)",
-          required: true
+          description: "App package ID (required for Android)",
+          required: false
+        },
+        {
+          name: "bundleId",
+          type: "string",
+          description: "Bundle ID (required for iOS)",
+          required: false
         }
       ],
       returns: {
         type: "number",
         name: "appStatus",
-        description: "0 is not installed. 1 is not running. 2 is running in background or suspended. 3 is running in background. 4 is running in foreground"
+        description: "0 is not installed. 1 is not running. 2 is running in background suspended. 3 is running in background. 4 is running in foreground"
       },
       support: {
         ios: {
@@ -3640,7 +3716,7 @@ var appium_default = {
     POST: {
       command: "hideKeyboard",
       description: "Hide soft keyboard.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/hide-keyboard/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#hidekeyboard",
       parameters: [
         {
           name: "strategy",
@@ -3685,7 +3761,7 @@ var appium_default = {
     GET: {
       command: "isKeyboardShown",
       description: "Whether or not the soft keyboard is shown.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/keys/is-keyboard-shown/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#iskeyboardshown",
       parameters: [],
       returns: {
         type: "boolean",
@@ -3710,7 +3786,7 @@ var appium_default = {
     POST: {
       command: "pushFile",
       description: "Place a file onto the device in a particular place.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/push-file/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#pushfile",
       parameters: [
         {
           name: "path",
@@ -3743,7 +3819,7 @@ var appium_default = {
     POST: {
       command: "pullFile",
       description: "Retrieve a file from the device's file system.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-file/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#pullfile",
       parameters: [
         {
           name: "path",
@@ -3775,7 +3851,7 @@ var appium_default = {
     POST: {
       command: "pullFolder",
       description: "Retrieve a folder from the device's file system.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/device/files/pull-folder/",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#pullfolder",
       parameters: [
         {
           name: "path",
@@ -3784,6 +3860,11 @@ var appium_default = {
           required: true
         }
       ],
+      returns: {
+        type: "string",
+        name: "response",
+        description: "Zip file of the folder contents in base64"
+      },
       support: {
         ios: {
           XCUITest: "9.3+",
@@ -3803,6 +3884,7 @@ var appium_default = {
       command: "toggleAirplaneMode",
       description: "Toggle airplane mode on device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-airplane-mode/",
+      deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
       parameters: [],
       support: {
         android: {
@@ -3816,6 +3898,7 @@ var appium_default = {
       command: "toggleData",
       description: "Switch the state of data service.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-data/",
+      deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
       parameters: [],
       support: {
         android: {
@@ -3829,6 +3912,7 @@ var appium_default = {
       command: "toggleWiFi",
       description: "Switch the state of the wifi service.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-wifi/",
+      deprecated: "Use `driver.execute('mobile: setConnectivity', { ... })` instead",
       parameters: [],
       support: {
         android: {
@@ -3842,6 +3926,7 @@ var appium_default = {
       command: "toggleLocationServices",
       description: "Switch the state of the location service.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/toggle-location-services/",
+      deprecated: "Use `driver.execute('mobile: toggleGps')` instead",
       parameters: [],
       support: {
         android: {
@@ -3855,6 +3940,7 @@ var appium_default = {
       command: "toggleNetworkSpeed",
       description: "Set network speed (Emulator only)",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/network-speed/",
+      deprecated: "Use `driver.execute('mobile: networkSpeed', { ... })` instead",
       parameters: [
         {
           name: "netspeed",
@@ -3873,8 +3959,9 @@ var appium_default = {
   "/session/:sessionId/appium/device/open_notifications": {
     POST: {
       command: "openNotifications",
-      description: "Open Android notifications (Emulator only).",
+      description: "Open Android notifications.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/open-notifications/",
+      deprecated: "Use `driver.execute('mobile: openNotifications')` or `driver.execute('mobile: statusBar', { ... })` instead",
       parameters: [],
       support: {
         android: {
@@ -3888,6 +3975,7 @@ var appium_default = {
       command: "startActivity",
       description: "Start an Android activity by providing package name and activity name.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/activity/start-activity/",
+      deprecated: "Use `driver.execute('mobile: startActivity', { ... })` instead",
       parameters: [
         {
           name: "appPackage",
@@ -3959,6 +4047,7 @@ var appium_default = {
       command: "getSystemBars",
       description: "Retrieve visibility and bounds information of the status and navigation bars.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/system/system-bars/",
+      deprecated: "Use `driver.execute('mobile: getSystemBars')` instead",
       parameters: [],
       returns: {
         type: "object[]",
@@ -3999,6 +4088,7 @@ var appium_default = {
       command: "getDisplayDensity",
       description: "Get display density from device.",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
+      deprecated: "Use `driver.execute('mobile: getDisplayDensity')` instead",
       parameters: [],
       returns: {
         type: "*",
@@ -4016,6 +4106,7 @@ var appium_default = {
       command: "touchId",
       description: "Simulate a [touch id](https://support.apple.com/en-ca/ht201371) event (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true and the Simulator must be [enrolled](https://support.apple.com/en-ca/ht201371). When you set allowTouchIdEnroll to true, it will set the Simulator to be enrolled by default. The enrollment state can be [toggled](https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/index.html). This call will only work if Appium process or its parent application (e.g. Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/touch-id/",
+      deprecated: "Use `driver.execute('mobile: sendBiometricMatch', { ... })` instead",
       parameters: [
         {
           name: "match",
@@ -4036,6 +4127,7 @@ var appium_default = {
       command: "toggleEnrollTouchId",
       description: "Toggle the simulator being [enrolled](https://support.apple.com/en-ca/ht201371) to accept touchId (iOS Simulator only). To enable this feature, the `allowTouchIdEnroll` desired capability must be set to true. When `allowTouchIdEnroll` is set to true the Simulator will be enrolled by default, and the 'Toggle Touch ID Enrollment' changes the enrollment state. This call will only work if the Appium process or its parent application (e.g., Terminal.app or Appium.app) has access to Mac OS accessibility in System Preferences > Security & Privacy > Privacy > Accessibility list.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/simulator/toggle-touch-id-enrollment/",
+      deprecated: "Use `driver.execute('mobile: enrollBiometric', { ... })` instead",
       parameters: [
         {
           name: "enabled",
@@ -4057,7 +4149,7 @@ var appium_default = {
       command: "launchApp",
       description: "Launch an app on device.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/launch-app/",
-      deprecated: "For iOS, utilize `driver.execute('mobile: launchApp', { ... })`, and for Android, make use of `driver.execute('mobile: activateApp', { ... })`.",
+      deprecated: "Use `driver.execute('mobile: launchApp', { ... })` (iOS) or `driver.execute('mobile: activateApp', { ... })` (Android) instead",
       parameters: [],
       support: {
         ios: {
@@ -4098,7 +4190,7 @@ var appium_default = {
         {
           name: "seconds",
           type: "(number|null)",
-          description: "timeout to restore app, if 'null' app won't be restored",
+          description: "Timeout after which to restore the app. A value of -1 disables the timeout",
           required: true,
           default: "null"
         }
@@ -4119,6 +4211,7 @@ var appium_default = {
       command: "endCoverage",
       description: "Get test coverage data.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/end-test-coverage/",
+      deprecated: "Use `driver.execute('mobile: shell', { ... })` instead",
       parameters: [
         {
           name: "intent",
@@ -4145,6 +4238,7 @@ var appium_default = {
       command: "getStrings",
       description: "Get app strings.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/app/get-app-strings/",
+      deprecated: "Use `driver.execute('mobile: getAppStrings', { ... })` instead",
       parameters: [
         {
           name: "language",
@@ -4179,6 +4273,7 @@ var appium_default = {
     POST: {
       command: "setValueImmediate",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
+      deprecated: "Use `driver.addValue(...)` or `driver.setValue(...)` instead",
       variables: [
         {
           name: "elementId",
@@ -4208,6 +4303,7 @@ var appium_default = {
       command: "replaceValue",
       description: "Replace the value to element directly.",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
+      deprecated: "Use `driver.addValue(...)` or `driver.setValue(...)` instead",
       variables: [
         {
           name: "elementId",
@@ -4236,8 +4332,8 @@ var appium_default = {
   "/session/:sessionId/appium/settings": {
     GET: {
       command: "getSettings",
-      description: "Retrieve the current settings on the device.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/session/settings/get-settings/",
+      description: "Retrieve the current session settings.",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#getsettings",
       parameters: [],
       returns: {
         type: "object",
@@ -4259,8 +4355,8 @@ var appium_default = {
     },
     POST: {
       command: "updateSettings",
-      description: "Update the current setting on the device.",
-      ref: "https://appium.github.io/appium.io/docs/en/commands/session/settings/update-settings/",
+      description: "Update the session settings.",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#updatesettings",
       parameters: [
         {
           name: "settings",
@@ -4288,6 +4384,7 @@ var appium_default = {
       command: "receiveAsyncResponse",
       description: "Callback url for asynchronous execution of JavaScript.",
       ref: "https://github.com/appium/appium-base-driver/blob/master/docs/mjsonwp/protocol-methods.md#appium-extension-endpoints",
+      deprecated: "Use `driver.executeAsyncScript(...)` instead",
       parameters: [
         {
           name: "response",
@@ -4309,6 +4406,7 @@ var appium_default = {
       command: "gsmCall",
       description: "Make GSM call (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-call/",
+      deprecated: "Use `driver.execute('mobile: gsmCall', { ... })` instead",
       parameters: [
         {
           name: "phoneNumber",
@@ -4335,6 +4433,7 @@ var appium_default = {
       command: "gsmSignal",
       description: "Set GSM signal strength (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-signal/",
+      deprecated: "Use `driver.execute('mobile: gsmSignal', { ... })` instead",
       parameters: [
         {
           name: "signalStrength",
@@ -4361,6 +4460,7 @@ var appium_default = {
       command: "powerCapacity",
       description: "Set the battery percentage (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_capacity/",
+      deprecated: "Use `driver.execute('mobile: powerCapacity', { ... })` instead",
       parameters: [
         {
           name: "percent",
@@ -4381,6 +4481,7 @@ var appium_default = {
       command: "powerAC",
       description: "Set the state of the battery charger to connected or not (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/emulator/power_ac/",
+      deprecated: "Use `driver.execute('mobile: powerAC', { ... })` instead",
       parameters: [
         {
           name: "state",
@@ -4401,6 +4502,7 @@ var appium_default = {
       command: "gsmVoice",
       description: "Set GSM voice state (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/gsm-voice/",
+      deprecated: "Use `driver.execute('mobile: gsmVoice', { ... })` instead",
       parameters: [
         {
           name: "state",
@@ -4421,6 +4523,7 @@ var appium_default = {
       command: "sendSms",
       description: "Simulate an SMS message (Emulator only).",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/network/send-sms/",
+      deprecated: "Use `driver.execute('mobile: sendSms', { ... })` instead",
       parameters: [
         {
           name: "phoneNumber",
@@ -4447,6 +4550,7 @@ var appium_default = {
       command: "fingerPrint",
       description: "Authenticate users by using their finger print scans on supported emulators.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/authentication/finger-print/",
+      deprecated: "Use `driver.execute('mobile: fingerPrint', { ... })` instead",
       parameters: [
         {
           name: "fingerprintId",
@@ -4467,6 +4571,7 @@ var appium_default = {
       command: "setClipboard",
       description: "Set the content of the system clipboard",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/set-clipboard/",
+      deprecated: "Use `driver.execute('mobile: setClipboard', { ... })` instead",
       parameters: [
         {
           name: "content",
@@ -4507,6 +4612,7 @@ var appium_default = {
       command: "getClipboard",
       description: "Get the content of the system clipboard",
       ref: "https://appium.github.io/appium.io/docs/en/commands/device/clipboard/get-clipboard/",
+      deprecated: "Use `driver.execute('mobile: getClipboard', { ... })` instead",
       parameters: [
         {
           name: "contentType",
@@ -4535,6 +4641,7 @@ var appium_default = {
       command: "touchPerform",
       description: "This functionality is only available from within a native context. 'Touch Perform' works similarly to the other singular touch interactions, except that this allows you to chain together more than one touch action as one command. This is useful because Appium commands are sent over the network and there's latency between commands. This latency can make certain touch interactions impossible because some interactions need to be performed in one sequence. Vertical, for example, requires pressing down, moving to a different y coordinate, and then releasing. For it to work, there can't be a delay between the interactions.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/touch-perform/",
+      deprecated: "Use `driver.performActions(...)` instead",
       parameters: [
         {
           name: "actions",
@@ -4601,6 +4708,7 @@ var appium_default = {
       command: "multiTouchPerform",
       description: "This functionality is only available from within a native context. Perform a multi touch action sequence.",
       ref: "https://appium.github.io/appium.io/docs/en/commands/interactions/touch/multi-touch-perform/",
+      deprecated: "Use `driver.performActions(...)` instead",
       parameters: [
         {
           name: "actions",
@@ -4626,8 +4734,8 @@ var appium_default = {
   "/session/:sessionId/appium/execute_driver": {
     POST: {
       command: "executeDriverScript",
-      description: "This command enables you to specify a WebdriverIO script as a string and transmit it to the Appium server for local execution on the server itself. This approach helps minimize potential latency associated with each command. ***To utilize this command with Appium 2.0, you must have the [`execute-driver-plugin`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin installed.***",
-      ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/execute-driver.md",
+      description: "Execute a script in a child process. This approach helps minimize potential latency associated with each command. ***Using this command in Appium 2 or later requires installing the [`execute-driver`](https://github.com/appium/appium/tree/master/packages/execute-driver-plugin) plugin.***",
+      ref: "https://appium.io/docs/en/latest/reference/api/plugins/#executedriverscript",
       parameters: [
         {
           name: "script",
@@ -4658,14 +4766,14 @@ var appium_default = {
   "/session/:sessionId/appium/events": {
     POST: {
       command: "getEvents",
-      description: "Get events stored in appium server.",
-      ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/get-events.md",
+      description: "Get events logged in the current session.",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#getlogevents",
       parameters: [
         {
           name: "type",
-          type: "string[]",
-          description: "Get events which are filtered with the type if the type is provided.",
-          required: true
+          type: "(string|string[])",
+          description: "One or more event types to filter the returned events",
+          required: false
         }
       ],
       returns: {
@@ -4686,19 +4794,19 @@ var appium_default = {
   "/session/:sessionId/appium/log_event": {
     POST: {
       command: "logEvent",
-      description: "Store a custom event.",
-      ref: "https://github.com/appium/appium/blob/master/docs/en/commands/session/events/log-event.md",
+      description: "Log a custom event.",
+      ref: "https://appium.io/docs/en/latest/reference/api/appium/#logcustomevent",
       parameters: [
         {
           name: "vendor",
           type: "string",
-          description: "The name of vendor. It will be `vendor` in `vendor:event`.",
+          description: "Name of the namespace (vendor) used to prefix the event",
           required: true
         },
         {
           name: "event",
           type: "string",
-          description: "The name of event. It will be `event` in `vendor:event`.",
+          description: "Name of the event",
           required: true
         }
       ],
@@ -4715,40 +4823,39 @@ var appium_default = {
   "/session/:sessionId/appium/compare_images": {
     POST: {
       command: "compareImages",
-      description: "This feature conducts image comparisons utilizing the capabilities of the OpenCV framework. Please note that for this functionality to work, both the OpenCV framework and the opencv4nodejs module must be installed on the machine where the Appium server is operational. ***Furthermore, you'll need to have the [`images-plugin`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin installed to use this feature with Appium 2.0.***",
-      ref: "https://github.com/appium/appium/blob/master/packages/images-plugin/docs/image-comparison.md",
+      description: "Compare two images using the specified mode of comparison. ***Using this command in Appium 2 or later requires installing the [`images`](https://github.com/appium/appium/tree/master/packages/images-plugin) plugin.***",
+      ref: "https://appium.io/docs/en/latest/reference/api/plugins/#compareimages",
       parameters: [
         {
           name: "mode",
           type: "string",
-          description: "One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'. 'matchFeatures' is by default.",
-          required: true,
-          default: "matchFeatures"
+          description: "One of possible comparison modes: 'matchFeatures', 'getSimilarity', 'matchTemplate'.",
+          required: true
         },
         {
           name: "firstImage",
           type: "string",
-          description: "An image data. All image formats, that OpenCV library itself accepts, are supported.",
+          description: "Base64-encoded image file.",
           required: true
         },
         {
           name: "secondImage",
           type: "string",
-          description: "An image data. All image formats, that OpenCV library itself accepts, are supported.",
+          description: "Base64-encoded image file.",
           required: true
         },
         {
           name: "options",
           type: "object",
-          description: "The content of this dictionary depends on the actual `mode` value. See the documentation on `appium-support` module for more details. ",
-          required: true,
+          description: "The supported values of this property depend on the `mode` value. See Appium documentation for more details.",
+          required: false,
           default: {}
         }
       ],
       returns: {
         type: "object",
         name: "result",
-        description: "The content of the resulting dictionary depends on the actual `mode` and `options` values. See the documentation on `appium-support` module for more details."
+        description: "The content of the resulting dictionary depends on the `mode` and `options` values. See Appium documentation for more details."
       }
     }
   },
@@ -4757,6 +4864,7 @@ var appium_default = {
       command: "implicitWait",
       description: "Set the amount of time the driver should wait when searching for elements. When searching for a single element, the driver should poll the page until an element is found or the timeout expires, whichever occurs first. When searching for multiple elements, the driver should poll the page until at least one element is found or the timeout expires, at which point it should return an empty list. If this command is never sent, the driver should default to an implicit wait of 0ms.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.setTimeouts(...)` instead",
       parameters: [
         {
           name: "ms",
@@ -4780,6 +4888,7 @@ var appium_default = {
       command: "getLocationInView",
       description: "Determine an element's location on the screen once it has been scrolled into view.<br /><br />__Note:__ This is considered an internal command and should only be used to determine an element's location for correctly generating native events.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.getElementRect(...)` or `element.getLocation()` instead",
       variables: [
         {
           name: "elementId",
@@ -4807,6 +4916,7 @@ var appium_default = {
       command: "sendKeys",
       description: "Send a sequence of key strokes to the active element",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with `keyUp` and `keyDown` actions instead",
       parameters: [
         {
           name: "value",
@@ -4828,8 +4938,8 @@ var appium_default = {
   "/session/:sessionId/ime/available_engines": {
     GET: {
       command: "availableIMEEngines",
-      description: "List all available engines on the machine. To use an engine, it has to be present in this list.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      description: "List all available IME engines on the device. To use an engine, it has to be present in this list.",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#availableimeengines",
       parameters: [],
       returns: {
         type: "String[]",
@@ -4847,7 +4957,7 @@ var appium_default = {
     GET: {
       command: "getActiveIMEEngine",
       description: "Get the name of the active IME engine. The name string is platform specific.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#getactiveimeengine",
       parameters: [],
       returns: {
         type: "String",
@@ -4865,7 +4975,7 @@ var appium_default = {
     GET: {
       command: "isIMEActivated",
       description: "Indicates whether IME input is active at the moment",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#isimeactivated",
       parameters: [],
       returns: {
         type: "Boolean",
@@ -4883,7 +4993,7 @@ var appium_default = {
     POST: {
       command: "deactivateIMEEngine",
       description: "De-activates the currently-active IME engine.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#deactivateimeengine",
       parameters: [],
       support: {
         android: {
@@ -4895,8 +5005,8 @@ var appium_default = {
   "/session/:sessionId/ime/activate": {
     POST: {
       command: "activateIMEEngine",
-      description: "Make an engines that is available",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      description: "Activates an IME engine.",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#activateimeengine",
       parameters: [
         {
           name: "engine",
@@ -4917,6 +5027,7 @@ var appium_default = {
       command: "asyncScriptTimeout",
       description: "Set the amount of time, in milliseconds, that asynchronous scripts executed by `/session/:sessionId/execute_async` are permitted to run before they are aborted and a `Timeout` error is returned to the client.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.setTimeouts(...)` instead",
       parameters: [
         {
           name: "ms",
@@ -4937,6 +5048,7 @@ var appium_default = {
       command: "submit",
       description: "Submit a form element.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Please explicitly find and click the submit element",
       variables: [
         {
           name: "elementId",
@@ -4956,6 +5068,7 @@ var appium_default = {
       command: "getElementSize",
       description: "Determine an element's size in pixels. The size will be returned as a JSON object with `width` and `height` properties.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.getElementRect(...)` or `element.getSize()` instead",
       variables: [
         {
           name: "elementId",
@@ -4983,6 +5096,7 @@ var appium_default = {
       command: "getElementLocation",
       description: "Determine an element's location on the page. The point `(0, 0)` refers to the upper-left corner of the page. The element's coordinates are returned as a JSON object with `x` and `y` properties.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.getElementRect(...)` or `element.getLocation()` instead",
       variables: [
         {
           name: "elementId",
@@ -5010,6 +5124,7 @@ var appium_default = {
       command: "touchClick",
       description: "Single tap on the touch enabled device.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with `pointerDown` and `pointerUp` actions instead",
       parameters: [
         {
           name: "element",
@@ -5033,6 +5148,7 @@ var appium_default = {
       command: "touchDown",
       description: "Finger down on the screen.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with a `pointerDown` action instead",
       parameters: [
         {
           name: "x",
@@ -5059,6 +5175,7 @@ var appium_default = {
       command: "touchUp",
       description: "Finger up on the screen.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with a `pointerUp` action instead",
       parameters: [
         {
           name: "x",
@@ -5085,6 +5202,7 @@ var appium_default = {
       command: "touchMove",
       description: "Finger move on the screen.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with a `pointerMove` action instead",
       parameters: [
         {
           name: "x",
@@ -5111,6 +5229,7 @@ var appium_default = {
       command: "touchLongClick",
       description: "Long press on the touch screen using finger motion events.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with `pointerDown`, `pause` and `pointerUp` actions instead",
       parameters: [
         {
           name: "element",
@@ -5131,6 +5250,7 @@ var appium_default = {
       command: "touchFlick",
       description: "Flick on the touch screen using finger motion events. This flick command starts at a particular screen location.",
       ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      deprecated: "Use `driver.performActions(...)` with `pointerDown`, `pointerMove` and `pointerUp` actions instead",
       parameters: [
         {
           name: "xoffset",
@@ -5180,7 +5300,7 @@ var appium_default = {
     GET: {
       command: "getOrientation",
       description: "Get the current device orientation.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#getorientation",
       parameters: [],
       returns: {
         type: "String",
@@ -5199,7 +5319,7 @@ var appium_default = {
     POST: {
       command: "setOrientation",
       description: "Set the device orientation",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#setorientation",
       parameters: [
         {
           name: "orientation",
@@ -5222,7 +5342,7 @@ var appium_default = {
     GET: {
       command: "getGeoLocation",
       description: "Get the current geo location.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#getgeolocation",
       parameters: [],
       returns: {
         type: "Object",
@@ -5233,7 +5353,7 @@ var appium_default = {
     POST: {
       command: "setGeoLocation",
       description: "Set the current geo location.",
-      ref: "https://github.com/appium/appium/blob/master/packages/base-driver/docs/mjsonwp/protocol-methods.md#webdriver-endpoints",
+      ref: "https://appium.io/docs/en/latest/reference/api/jsonwp/#setgeolocation",
       parameters: [
         {
           name: "location",