@capawesome/capacitor-intercom 0.0.1

package/dist/docs.json

@@ -0,0 +1,1345 @@
+{
+  "api": {
+    "name": "IntercomPlugin",
+    "slug": "intercomplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "getUnreadConversationCount",
+        "signature": "() => Promise<GetUnreadConversationCountResult>",
+        "parameters": [],
+        "returns": "Promise<GetUnreadConversationCountResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the number of unread conversations for the current user.",
+        "complexTypes": [
+          "GetUnreadConversationCountResult"
+        ],
+        "slug": "getunreadconversationcount"
+      },
+      {
+        "name": "handlePushNotification",
+        "signature": "(options: HandlePushNotificationOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "HandlePushNotificationOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Handle an incoming push notification that belongs to Intercom.\n\nUse `isIntercomPushNotification(...)` to check whether the notification\nbelongs to Intercom before calling this method.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "HandlePushNotificationOptions"
+        ],
+        "slug": "handlepushnotification"
+      },
+      {
+        "name": "hide",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Hide any currently presented Intercom UI (e.g. the Messenger).",
+        "complexTypes": [],
+        "slug": "hide"
+      },
+      {
+        "name": "initialize",
+        "signature": "(options: InitializeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "InitializeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Initialize the Intercom SDK with your app ID and API key.\n\nThis method must be called before any other method.",
+        "complexTypes": [
+          "InitializeOptions"
+        ],
+        "slug": "initialize"
+      },
+      {
+        "name": "isIntercomPushNotification",
+        "signature": "(options: IsIntercomPushNotificationOptions) => Promise<IsIntercomPushNotificationResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "IsIntercomPushNotificationOptions"
+          }
+        ],
+        "returns": "Promise<IsIntercomPushNotificationResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether an incoming push notification belongs to Intercom.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsIntercomPushNotificationResult",
+          "IsIntercomPushNotificationOptions"
+        ],
+        "slug": "isintercompushnotification"
+      },
+      {
+        "name": "logEvent",
+        "signature": "(options: LogEventOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LogEventOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Log an event with an optional set of metadata.",
+        "complexTypes": [
+          "LogEventOptions"
+        ],
+        "slug": "logevent"
+      },
+      {
+        "name": "loginUnidentifiedUser",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Log in an unidentified (anonymous) user.",
+        "complexTypes": [],
+        "slug": "loginunidentifieduser"
+      },
+      {
+        "name": "loginUser",
+        "signature": "(options: LoginUserOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "LoginUserOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Log in an identified user with a user ID and/or an email address.\n\nAt least one of `userId` or `email` must be provided.",
+        "complexTypes": [
+          "LoginUserOptions"
+        ],
+        "slug": "loginuser"
+      },
+      {
+        "name": "logout",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Log out the current user and clear the local Intercom data.",
+        "complexTypes": [],
+        "slug": "logout"
+      },
+      {
+        "name": "present",
+        "signature": "(options?: PresentOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PresentOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Present the Intercom Messenger with the given space.",
+        "complexTypes": [
+          "PresentOptions"
+        ],
+        "slug": "present"
+      },
+      {
+        "name": "presentContent",
+        "signature": "(options: PresentContentOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PresentContentOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Present a specific piece of Intercom content (e.g. an article, carousel,\nsurvey, or conversation).",
+        "complexTypes": [
+          "PresentContentOptions"
+        ],
+        "slug": "presentcontent"
+      },
+      {
+        "name": "presentMessageComposer",
+        "signature": "(options?: PresentMessageComposerOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "PresentMessageComposerOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Present the Intercom message composer, optionally pre-filled with an\ninitial message.",
+        "complexTypes": [
+          "PresentMessageComposerOptions"
+        ],
+        "slug": "presentmessagecomposer"
+      },
+      {
+        "name": "sendPushTokenToIntercom",
+        "signature": "(options: SendPushTokenToIntercomOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SendPushTokenToIntercomOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Forward a push notification token to Intercom.\n\nOn Android, pass the Firebase Cloud Messaging (FCM) token. On iOS, pass\nthe hexadecimal APNs device token.",
+        "complexTypes": [
+          "SendPushTokenToIntercomOptions"
+        ],
+        "slug": "sendpushtokentointercom"
+      },
+      {
+        "name": "setBottomPadding",
+        "signature": "(options: SetBottomPaddingOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetBottomPaddingOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the bottom padding of the Intercom UI (in-app messages and launcher).\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "SetBottomPaddingOptions"
+        ],
+        "slug": "setbottompadding"
+      },
+      {
+        "name": "setInAppMessagesVisible",
+        "signature": "(options: SetInAppMessagesVisibleOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetInAppMessagesVisibleOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set whether in-app messages are visible.",
+        "complexTypes": [
+          "SetInAppMessagesVisibleOptions"
+        ],
+        "slug": "setinappmessagesvisible"
+      },
+      {
+        "name": "setLauncherVisible",
+        "signature": "(options: SetLauncherVisibleOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetLauncherVisibleOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set whether the Intercom launcher is visible.",
+        "complexTypes": [
+          "SetLauncherVisibleOptions"
+        ],
+        "slug": "setlaunchervisible"
+      },
+      {
+        "name": "setUserHash",
+        "signature": "(options: SetUserHashOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetUserHashOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the user hash (HMAC) for identity verification.\n\nThis must be called before logging in the user.",
+        "complexTypes": [
+          "SetUserHashOptions"
+        ],
+        "slug": "setuserhash"
+      },
+      {
+        "name": "setUserJwt",
+        "signature": "(options: SetUserJwtOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetUserJwtOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the JSON Web Token (JWT) for identity verification.\n\nThis must be called before logging in the user.",
+        "complexTypes": [
+          "SetUserJwtOptions"
+        ],
+        "slug": "setuserjwt"
+      },
+      {
+        "name": "updateUser",
+        "signature": "(options: UpdateUserOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "UpdateUserOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Update the attributes of the current user.",
+        "complexTypes": [
+          "UpdateUserOptions"
+        ],
+        "slug": "updateuser"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'messengerHidden', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'messengerHidden'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the Intercom Messenger is hidden.\n\nOnly available on iOS and Web.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenermessengerhidden-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'messengerShown', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'messengerShown'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the Intercom Messenger is shown.\n\nOnly available on iOS and Web.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenermessengershown-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'unreadConversationCountChange', listenerFunc: (event: UnreadConversationCountChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'unreadConversationCountChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: UnreadConversationCountChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the number of unread conversations changes.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "UnreadConversationCountChangeEvent"
+        ],
+        "slug": "addlistenerunreadconversationcountchange-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "GetUnreadConversationCountResult",
+      "slug": "getunreadconversationcountresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "count",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number of unread conversations.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "HandlePushNotificationOptions",
+      "slug": "handlepushnotificationoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The data of the push notification.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "InitializeOptions",
+      "slug": "initializeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "androidApiKey",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The Android API key of your Intercom app.\n\nRequired to use the plugin on Android.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "appId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The app ID of your Intercom app.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "iosApiKey",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The iOS API key of your Intercom app.\n\nRequired to use the plugin on iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "IsIntercomPushNotificationResult",
+      "slug": "isintercompushnotificationresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "intercom",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the push notification belongs to Intercom.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "IsIntercomPushNotificationOptions",
+      "slug": "isintercompushnotificationoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The data of the push notification.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, unknown>"
+        }
+      ]
+    },
+    {
+      "name": "LogEventOptions",
+      "slug": "logeventoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "data",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The metadata of the event.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string | number | boolean>"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the event.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "LoginUserOptions",
+      "slug": "loginuseroptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "email",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The email address of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "userId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PresentOptions",
+      "slug": "presentoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "space",
+          "tags": [
+            {
+              "text": "'home'",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The space to present.",
+          "complexTypes": [
+            "IntercomSpace"
+          ],
+          "type": "IntercomSpace"
+        }
+      ]
+    },
+    {
+      "name": "PresentContentOptions",
+      "slug": "presentcontentoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifier of the content to present.\n\nRequired for the `article`, `carousel`, `survey`, and `conversation`\ncontent types.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "ids",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The identifiers of the content to present.\n\nRequired for the `help-center-collections` content type.",
+          "complexTypes": [],
+          "type": "string[] | undefined"
+        },
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The type of content to present.",
+          "complexTypes": [
+            "IntercomContentType"
+          ],
+          "type": "IntercomContentType"
+        }
+      ]
+    },
+    {
+      "name": "PresentMessageComposerOptions",
+      "slug": "presentmessagecomposeroptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "initialMessage",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The message to pre-fill the composer with.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "SendPushTokenToIntercomOptions",
+      "slug": "sendpushtokentointercomoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "token",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The push notification token.\n\nOn Android, this is the Firebase Cloud Messaging (FCM) token. On iOS,\nthis is the hexadecimal APNs device token.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SetBottomPaddingOptions",
+      "slug": "setbottompaddingoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "padding",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The bottom padding to set.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "SetInAppMessagesVisibleOptions",
+      "slug": "setinappmessagesvisibleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "visible",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether in-app messages should be visible.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SetLauncherVisibleOptions",
+      "slug": "setlaunchervisibleoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "visible",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the launcher should be visible.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SetUserHashOptions",
+      "slug": "setuserhashoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "userHash",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The user hash (HMAC) for identity verification.\n\nThe hash must be generated on your backend using your Intercom secret\nkey. Never expose the secret key in your app.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "SetUserJwtOptions",
+      "slug": "setuserjwtoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "jwt",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The JSON Web Token (JWT) for identity verification.\n\nThe token must be generated on your backend using your Intercom secret\nkey. Never expose the secret key in your app.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "UpdateUserOptions",
+      "slug": "updateuseroptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "companies",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The companies the user belongs to.",
+          "complexTypes": [
+            "UpdateUserCompany"
+          ],
+          "type": "UpdateUserCompany[] | undefined"
+        },
+        {
+          "name": "customAttributes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The custom attributes of the user.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string | number | boolean>"
+        },
+        {
+          "name": "email",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The email address of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "languageOverride",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'en'",
+              "name": "example"
+            }
+          ],
+          "docs": "The preferred language of the user as an ISO 639-1 code.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "phone",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The phone number of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "signedUpAt",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "1704067200",
+              "name": "example"
+            }
+          ],
+          "docs": "The date the user signed up as a Unix timestamp in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "unsubscribedFromEmails",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the user is unsubscribed from emails.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "userId",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the user.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "UpdateUserCompany",
+      "slug": "updateusercompany",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "createdAt",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "1704067200",
+              "name": "example"
+            }
+          ],
+          "docs": "The date the company was created as a Unix timestamp in seconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "customAttributes",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The custom attributes of the company.",
+          "complexTypes": [
+            "Record"
+          ],
+          "type": "Record<string, string | number | boolean>"
+        },
+        {
+          "name": "id",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The unique identifier of the company.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "monthlySpend",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The monthly spend of the company.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The name of the company.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "plan",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The plan of the company.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "UnreadConversationCountChangeEvent",
+      "slug": "unreadconversationcountchangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "count",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The number of unread conversations.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "IntercomSpace",
+      "slug": "intercomspace",
+      "docs": "A space of the Intercom Messenger.",
+      "types": [
+        {
+          "text": "'home'",
+          "complexTypes": []
+        },
+        {
+          "text": "'messages'",
+          "complexTypes": []
+        },
+        {
+          "text": "'help-center'",
+          "complexTypes": []
+        },
+        {
+          "text": "'tickets'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "IntercomContentType",
+      "slug": "intercomcontenttype",
+      "docs": "A type of Intercom content that can be presented.",
+      "types": [
+        {
+          "text": "'article'",
+          "complexTypes": []
+        },
+        {
+          "text": "'carousel'",
+          "complexTypes": []
+        },
+        {
+          "text": "'conversation'",
+          "complexTypes": []
+        },
+        {
+          "text": "'help-center-collections'",
+          "complexTypes": []
+        },
+        {
+          "text": "'survey'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}