@capgo/capacitor-updater 6.14.26 → 6.14.29

package/dist/docs.json

@@ -253,6 +253,42 @@
         ],
         "slug": "delete"
       },
+      {
+        "name": "setBundleError",
+        "signature": "(options: BundleId) => Promise<BundleInfo>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "A {@link BundleId} object containing the bundle id to mark as errored.",
+            "type": "BundleId"
+          }
+        ],
+        "returns": "Promise<BundleInfo>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options A {@link BundleId} object containing the bundle id to mark as errored."
+          },
+          {
+            "name": "returns",
+            "text": "The updated {@link BundleInfo} for the bundle."
+          },
+          {
+            "name": "throws",
+            "text": "{Error} When the bundle does not exist or the feature is disabled."
+          },
+          {
+            "name": "since",
+            "text": "7.20.0"
+          }
+        ],
+        "docs": "Mark an installed bundle as errored. Only available when {@link PluginsConfig.CapacitorUpdater.allowManualBundleError} is true.",
+        "complexTypes": [
+          "BundleInfo",
+          "BundleId"
+        ],
+        "slug": "setbundleerror"
+      },
       {
         "name": "list",
         "signature": "(options?: ListOptions | undefined) => Promise<BundleListResult>",
@@ -484,7 +520,7 @@
             "text": "4.7.0"
           }
         ],
-        "docs": "Sets the channel for this device. The channel has to allow for self assignment for this to work.\nDo not use this method to set the channel at boot when `autoUpdate` is enabled in the {@link PluginsConfig}.\nThis method is to set the channel after the app is ready.\nThis methods send to Capgo backend a request to link the device ID to the channel. Capgo can accept or refuse depending of the setting of your channel.",
+        "docs": "Sets the channel for this device. The channel has to allow for self assignment for this to work.\nDo not use this method to set the channel at boot.\nThis method is to set the channel after the app is ready, and user interacted.\nIf you want to set the channel at boot, use the {@link PluginsConfig} to set the default channel.\nThis methods send to Capgo backend a request to link the device ID to the channel. Capgo can accept or refuse depending of the setting of your channel.",
         "complexTypes": [
           "ChannelRes",
           "SetChannelOptions"
@@ -547,6 +583,31 @@
         ],
         "slug": "getchannel"
       },
+      {
+        "name": "listChannels",
+        "signature": "() => Promise<ListChannelsResult>",
+        "parameters": [],
+        "returns": "Promise<ListChannelsResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "A Promise that resolves with the available channels"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "List all channels available for this device that allow self-assignment",
+        "complexTypes": [
+          "ListChannelsResult"
+        ],
+        "slug": "listchannels"
+      },
       {
         "name": "setCustomId",
         "signature": "(options: SetCustomIdOptions) => Promise<void>",
@@ -576,7 +637,7 @@
             "text": "4.9.0"
           }
         ],
-        "docs": "Set a custom ID for this device",
+        "docs": "Set a custom ID for this device\n\nWhen {@link PluginsConfig.CapacitorUpdater.persistCustomId} is true, the value will be stored natively and restored on the next app launch.\nPass an empty string to remove any previously stored customId.",
         "complexTypes": [
           "SetCustomIdOptions"
         ],
@@ -618,7 +679,7 @@
             "text": "{Error}"
           }
         ],
-        "docs": "Get unique ID used to identify device (sent to auto update server)",
+        "docs": "Get unique ID used to identify device (sent to auto update server), this ID is made following Apple and Google privacy best practices, and not persisted between installs",
         "complexTypes": [
           "DeviceId"
         ],
@@ -703,7 +764,7 @@
             "text": "2.0.11"
           }
         ],
-        "docs": "Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.",
+        "docs": "Listen for bundle download event in the App. Fires once a download has started, during downloading and when finished.\nThis will return you all download percent during the download",
         "complexTypes": [
           "PluginListenerHandle",
           "DownloadEvent"
@@ -797,6 +858,35 @@
         ],
         "slug": "addlistenerdownloadcomplete-"
       },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'breakingAvailable', listenerFunc: (state: BreakingAvailableEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'breakingAvailable'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(state: MajorAvailableEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "7.22.0"
+          }
+        ],
+        "docs": "Listen for breaking update events when the backend flags an update as incompatible with the current app.\nEmits the same payload as the legacy `majorAvailable` listener.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "BreakingAvailableEvent"
+        ],
+        "slug": "addlistenerbreakingavailable-"
+      },
       {
         "name": "addListener",
         "signature": "(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>",
@@ -814,6 +904,10 @@
         ],
         "returns": "Promise<PluginListenerHandle>",
         "tags": [
+          {
+            "name": "deprecated",
+            "text": "Deprecated alias for {@link addListener} with `breakingAvailable`. Emits the same payload. will be removed in v8"
+          },
           {
             "name": "since",
             "text": "2.3.0"
@@ -934,7 +1028,7 @@
             "text": "5.1.0"
           }
         ],
-        "docs": "Listen for app ready event in the App, let you know when app is ready to use",
+        "docs": "Listen for app ready event in the App, let you know when app is ready to use, this event is retain till consumed.",
         "complexTypes": [
           "PluginListenerHandle",
           "AppReadyEvent"
@@ -986,6 +1080,149 @@
           "BundleInfo"
         ],
         "slug": "getnextbundle"
+      },
+      {
+        "name": "getFailedUpdate",
+        "signature": "() => Promise<UpdateFailedEvent | null>",
+        "parameters": [],
+        "returns": "Promise<UpdateFailedEvent | null>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The last failed update or null when no failure has been recorded. Value is cleared after it is returned once."
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.22.0"
+          }
+        ],
+        "docs": "Get the most recent update that failed to install, if any. The stored value is cleared after it is retrieved once.",
+        "complexTypes": [
+          "UpdateFailedEvent"
+        ],
+        "slug": "getfailedupdate"
+      },
+      {
+        "name": "setShakeMenu",
+        "signature": "(options: SetShakeMenuOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Contains enabled boolean to enable or disable shake menu",
+            "type": "SetShakeMenuOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Contains enabled boolean to enable or disable shake menu"
+          },
+          {
+            "name": "returns"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "Enable or disable the shake menu for debugging/testing purposes",
+        "complexTypes": [
+          "SetShakeMenuOptions"
+        ],
+        "slug": "setshakemenu"
+      },
+      {
+        "name": "isShakeMenuEnabled",
+        "signature": "() => Promise<ShakeMenuEnabled>",
+        "parameters": [],
+        "returns": "Promise<ShakeMenuEnabled>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The current state of shake menu"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.5.0"
+          }
+        ],
+        "docs": "Get the current state of the shake menu",
+        "complexTypes": [
+          "ShakeMenuEnabled"
+        ],
+        "slug": "isshakemenuenabled"
+      },
+      {
+        "name": "getAppId",
+        "signature": "() => Promise<GetAppIdRes>",
+        "parameters": [],
+        "returns": "Promise<GetAppIdRes>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "The current App ID"
+          },
+          {
+            "name": "throws",
+            "text": "{Error}"
+          },
+          {
+            "name": "since",
+            "text": "7.14.0"
+          }
+        ],
+        "docs": "Get the configured App ID",
+        "complexTypes": [
+          "GetAppIdRes"
+        ],
+        "slug": "getappid"
+      },
+      {
+        "name": "setAppId",
+        "signature": "(options: SetAppIdOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "The new App ID to set",
+            "type": "SetAppIdOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options The new App ID to set"
+          },
+          {
+            "name": "returns"
+          },
+          {
+            "name": "throws",
+            "text": "{Error} If allowModifyAppId is false or if the operation fails"
+          },
+          {
+            "name": "since",
+            "text": "7.14.0"
+          }
+        ],
+        "docs": "Set the App ID for the app (requires allowModifyAppId to be true in config)",
+        "complexTypes": [
+          "SetAppIdOptions"
+        ],
+        "slug": "setappid"
       }
     ],
     "properties": []
@@ -1106,7 +1343,7 @@
     {
       "name": "DownloadOptions",
       "slug": "downloadoptions",
-      "docs": "",
+      "docs": "This URL and versions are used to download the bundle from the server, If you use backend all information will be gived by the method getLatest.\nIf you don't use backend, you need to provide the URL and version of the bundle. Checksum and sessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.",
       "tags": [],
       "methods": [],
       "properties": [
@@ -1115,7 +1352,7 @@
           "tags": [],
           "docs": "The URL of the bundle zip file (e.g: dist.zip) to be downloaded. (This can be any URL. E.g: Amazon S3, a GitHub tag, any other place you've hosted your bundle.)",
           "complexTypes": [],
-          "type": "string | undefined"
+          "type": "string"
         },
         {
           "name": "version",
@@ -1136,7 +1373,7 @@
               "name": "default"
             }
           ],
-          "docs": "The session key for the update",
+          "docs": "The session key for the update, when the bundle is encrypted with a session key",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -1152,9 +1389,57 @@
               "name": "default"
             }
           ],
-          "docs": "The checksum for the update",
+          "docs": "The checksum for the update, it should be in sha256 and encrypted with private key if the bundle is encrypted",
           "complexTypes": [],
           "type": "string | undefined"
+        },
+        {
+          "name": "manifest",
+          "tags": [
+            {
+              "text": "6.1.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "The manifest for multi-file downloads",
+          "complexTypes": [
+            "ManifestEntry"
+          ],
+          "type": "ManifestEntry[] | undefined"
+        }
+      ]
+    },
+    {
+      "name": "ManifestEntry",
+      "slug": "manifestentry",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "file_name",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "file_hash",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
+        },
+        {
+          "name": "download_url",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | null"
         }
       ]
     },
@@ -1341,9 +1626,26 @@
           "complexTypes": [],
           "type": "string | undefined"
         },
+        {
+          "name": "breaking",
+          "tags": [
+            {
+              "text": "7.22.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Indicates whether the update was flagged as breaking by the backend.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "major",
-          "tags": [],
+          "tags": [
+            {
+              "text": "Use {@link LatestVersion.breaking} instead.",
+              "name": "deprecated"
+            }
+          ],
           "docs": "",
           "complexTypes": [],
           "type": "boolean | undefined"
@@ -1400,55 +1702,25 @@
       ]
     },
     {
-      "name": "ManifestEntry",
-      "slug": "manifestentry",
+      "name": "GetLatestOptions",
+      "slug": "getlatestoptions",
       "docs": "",
       "tags": [],
       "methods": [],
       "properties": [
         {
-          "name": "file_name",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        },
-        {
-          "name": "file_hash",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        },
-        {
-          "name": "download_url",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | null"
-        }
-      ]
-    },
-    {
-      "name": "GetLatestOptions",
-      "slug": "getlatestoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "channel",
-          "tags": [
-            {
-              "text": "6.8.0",
-              "name": "since"
-            },
-            {
-              "text": "undefined",
-              "name": "default"
-            }
-          ],
-          "docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
+          "name": "channel",
+          "tags": [
+            {
+              "text": "6.8.0",
+              "name": "since"
+            },
+            {
+              "text": "undefined",
+              "name": "default"
+            }
+          ],
+          "docs": "The channel to get the latest version for\nThe channel must allow 'self_assign' for this to work",
           "complexTypes": [],
           "type": "string | undefined"
         }
@@ -1577,6 +1849,86 @@
         }
       ]
     },
+    {
+      "name": "ListChannelsResult",
+      "slug": "listchannelsresult",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "channels",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "List of available channels",
+          "complexTypes": [
+            "ChannelInfo"
+          ],
+          "type": "ChannelInfo[]"
+        }
+      ]
+    },
+    {
+      "name": "ChannelInfo",
+      "slug": "channelinfo",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The channel ID",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The channel name",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "public",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether this is a public channel",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "allow_self_set",
+          "tags": [
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether devices can self-assign to this channel",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
     {
       "name": "SetCustomIdOptions",
       "slug": "setcustomidoptions",
@@ -1587,7 +1939,7 @@
         {
           "name": "customId",
           "tags": [],
-          "docs": "",
+          "docs": "Custom identifier to associate with the device. Use an empty string to clear any saved value.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1782,12 +2134,16 @@
         {
           "name": "version",
           "tags": [
+            {
+              "text": "Deprecated alias for {@link BreakingAvailableEvent}. Receives the same payload.",
+              "name": "deprecated"
+            },
             {
               "text": "4.0.0",
               "name": "since"
             }
           ],
-          "docs": "Emit when a new major bundle is available.",
+          "docs": "Emit when a breaking update is available.",
           "complexTypes": [],
           "type": "string"
         }
@@ -1882,6 +2238,70 @@
           "type": "boolean"
         }
       ]
+    },
+    {
+      "name": "SetShakeMenuOptions",
+      "slug": "setshakemenuoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "ShakeMenuEnabled",
+      "slug": "shakemenuenabled",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "enabled",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "GetAppIdRes",
+      "slug": "getappidres",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SetAppIdOptions",
+      "slug": "setappidoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "appId",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
     }
   ],
   "enums": [],
@@ -1889,7 +2309,7 @@
     {
       "name": "BundleStatus",
       "slug": "bundlestatus",
-      "docs": "",
+      "docs": "pending: The bundle is pending to be **SET** as the next bundle.\ndownloading: The bundle is being downloaded.\nsuccess: The bundle has been downloaded and is ready to be **SET** as the next bundle.\nerror: The bundle has failed to download.",
       "types": [
         {
           "text": "'success'",
@@ -1931,6 +2351,19 @@
           "complexTypes": []
         }
       ]
+    },
+    {
+      "name": "BreakingAvailableEvent",
+      "slug": "breakingavailableevent",
+      "docs": "Payload emitted by {@link CapacitorUpdaterPlugin.addListener} with `breakingAvailable`.",
+      "types": [
+        {
+          "text": "MajorAvailableEvent",
+          "complexTypes": [
+            "MajorAvailableEvent"
+          ]
+        }
+      ]
     }
   ],
   "pluginConfigs": [
@@ -1966,7 +2399,7 @@
               "name": "example"
             }
           ],
-          "docs": "Configure the number of milliseconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
+          "docs": "Configure the number of seconds the native plugin should wait before considering API timeout.\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "number | undefined"
         },
@@ -2088,9 +2521,13 @@
             {
               "text": "undefined",
               "name": "default"
+            },
+            {
+              "text": "Use publicKey instead",
+              "name": "deprecated"
             }
           ],
-          "docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS. Deprecated in version 6.2.0. will be removed in version 7.0.0.",
+          "docs": "Configure the private key for end to end live update encryption.\n\nOnly available for Android and iOS. Deprecated in version 6.2.0 in favor of publicKey.\nStill supported for backwards compatibility.",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -2130,7 +2567,7 @@
           "name": "directUpdate",
           "tags": [
             {
-              "text": "undefined",
+              "text": "false",
               "name": "default"
             },
             {
@@ -2138,16 +2575,72 @@
               "name": "since"
             }
           ],
-          "docs": "Make the plugin direct install the update when the app what just updated/installed. Only for autoUpdate mode.\n\nOnly available for Android and iOS.",
+          "docs": "Configure when the plugin should direct install updates. Only for autoUpdate mode.\nWorks well for apps less than 10MB and with uploads done using --partial flag.\nZip or apps more than 10MB will be relatively slow for users to update.\n- false: Never do direct updates (default behavior)\n- atInstall: Direct update only when app is installed/updated from store, otherwise use normal background update\n- always: Always do direct updates immediately when available\n- true: (deprecated) Same as \"always\" for backward compatibility\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | 'always' | 'atInstall' | undefined"
+        },
+        {
+          "name": "autoSplashscreen",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.6.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Automatically handle splashscreen hiding when using directUpdate. When enabled, the plugin will automatically hide the splashscreen after updates are applied or when no update is needed.\nThis removes the need to manually listen for appReady events and call SplashScreen.hide().\nOnly works when directUpdate is set to \"atInstall\", \"always\", or true.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\nRequires autoUpdate and directUpdate to be enabled.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "autoSplashscreenLoader",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.19.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Display a native loading indicator on top of the splashscreen while automatic direct updates are running.\nOnly takes effect when {@link autoSplashscreen} is enabled.\nRequires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false.\n\nOnly available for Android and iOS.",
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "autoSplashscreenTimeout",
+          "tags": [
+            {
+              "text": "10000 // (10 seconds)",
+              "name": "default"
+            },
+            {
+              "text": "7.19.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Automatically hide the splashscreen after the specified number of milliseconds when using automatic direct updates.\nIf the timeout elapses, the update continues to download in the background while the splashscreen is dismissed.\nSet to `0` (zero) to disable the timeout.\nWhen the timeout fires, the direct update flow is skipped and the downloaded bundle is installed on the next background/launch.\nRequires {@link autoSplashscreen} to be enabled.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
         {
           "name": "periodCheckDelay",
           "tags": [
             {
-              "text": "600 // (10 minutes)",
+              "text": "0 (disabled)",
               "name": "default"
+            },
+            {
+              "text": "3600 (1 hour)",
+              "name": "example"
+            },
+            {
+              "text": "86400 (24 hours)",
+              "name": "example"
             }
           ],
           "docs": "Configure the delay period for period update check. the unit is in seconds.\n\nOnly available for Android and iOS.\nCannot be less than 600 seconds (10 minutes).",
@@ -2282,6 +2775,70 @@
           "complexTypes": [],
           "type": "boolean | undefined"
         },
+        {
+          "name": "allowModifyAppId",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.14.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow the plugin to modify the appId dynamically from the JavaScript side.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "allowManualBundleError",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.20.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Allow marking bundles as errored from JavaScript while using manual update flows.\nWhen enabled, {@link CapacitorUpdaterPlugin.setBundleError} can change a bundle status to `error`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "persistCustomId",
+          "tags": [
+            {
+              "text": "false (will be true by default in a future major release v8.x.x)",
+              "name": "default"
+            },
+            {
+              "text": "7.17.3",
+              "name": "since"
+            }
+          ],
+          "docs": "Persist the customId set through {@link CapacitorUpdaterPlugin.setCustomId} across app restarts.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "persistModifyUrl",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.20.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Persist the updateUrl, statsUrl and channelUrl set through {@link CapacitorUpdaterPlugin.setUpdateUrl},\n{@link CapacitorUpdaterPlugin.setStatsUrl} and {@link CapacitorUpdaterPlugin.setChannelUrl} across app restarts.\n\nOnly available for Android and iOS.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
         {
           "name": "defaultChannel",
           "tags": [
@@ -2294,7 +2851,7 @@
               "name": "since"
             }
           ],
-          "docs": "Set the default channel for the app in the config.",
+          "docs": "Set the default channel for the app in the config. Case sensitive.\nThis will setting will override the default channel set in the cloud, but will still respect overrides made in the cloud.\nThis requires the channel to allow devices to self dissociate/associate in the channel settings. https://capgo.app/docs/public-api/channels/#channel-configuration-options",
           "complexTypes": [],
           "type": "string | undefined"
         },
@@ -2329,6 +2886,38 @@
           "docs": "Configure the plugin to keep the URL path after a reload.\nWARNING: When a reload is triggered, 'window.history' will be cleared.",
           "complexTypes": [],
           "type": "boolean | undefined"
+        },
+        {
+          "name": "disableJSLogging",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.3.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Disable the JavaScript logging of the plugin. if true, the plugin will not log to the JavaScript console. only the native log will be done",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "shakeMenu",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "7.5.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Enable shake gesture to show update menu for debugging/testing purposes",
+          "complexTypes": [],
+          "type": "boolean | undefined"
         }
       ],
       "docs": "CapacitorUpdater can be configured with these options:"