From 6b4b5870b436baa64508ddf9ec9e131f8a67fd0e Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 10:44:42 +0000
Subject: [PATCH 1/7] Add startChecklist method

---
 packages/react-use-intercom/src/provider.tsx | 11 +++++++++++
 packages/react-use-intercom/src/types.ts     | 16 +++++++++++++++-
 2 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/packages/react-use-intercom/src/provider.tsx b/packages/react-use-intercom/src/provider.tsx
index d2e87bf..c6cd7cd 100644
--- a/packages/react-use-intercom/src/provider.tsx
+++ b/packages/react-use-intercom/src/provider.tsx
@@ -209,6 +209,15 @@ export const IntercomProvider: React.FC<
     [ensureIntercom],
   );
 
+  const startChecklist = React.useCallback(
+    (checklistId: number) => {
+      ensureIntercom('startChecklist', () => {
+        IntercomAPI('startChecklist', checklistId);
+      });
+    },
+    [ensureIntercom],
+  );
+
   const trackEvent = React.useCallback(
     (event: string, metaData?: object) => {
       ensureIntercom('trackEvent', () => {
@@ -260,6 +269,7 @@ export const IntercomProvider: React.FC<
       showNewMessage,
       getVisitorId,
       startTour,
+      startChecklist,
       trackEvent,
       showArticle,
       startSurvey,
@@ -277,6 +287,7 @@ export const IntercomProvider: React.FC<
     showNewMessage,
     getVisitorId,
     startTour,
+    startChecklist,
     trackEvent,
     showArticle,
     startSurvey,
diff --git a/packages/react-use-intercom/src/types.ts b/packages/react-use-intercom/src/types.ts
index 0adc5fe..aa6c38f 100644
--- a/packages/react-use-intercom/src/types.ts
+++ b/packages/react-use-intercom/src/types.ts
@@ -244,6 +244,7 @@ export type IntercomMethod =
   | 'trackEvent'
   | 'getVisitorId'
   | 'startTour'
+  | 'startChecklist'
   | 'showArticle'
   | 'showSpace';
 
@@ -365,9 +366,22 @@ export type IntercomContextValues = {
    * the “Use tour everywhere” section must be turned on.
    * If you're calling this API using an invalid tour id, nothing will happen.
    *
-   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#section-intercomstarttour-tourid}
+   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomstarttour-tourid}
    */
   startTour: (tourId: number) => void;
+   /**
+   * Triggers a checklist based on an action a user or visitor takes in your site or application,
+   * You need to call this method with the id of the checklist you wish to show.
+   *
+   * The id of the checklist can be found in the “Aditional ways to share your checklist” section
+   * of the tour editor.
+   *
+   * @remarks Please note that checklists shown via this API must be published.
+   * If you're calling this API using an invalid tour id, nothing will happen.
+   *
+   * @see {@link https://developers.intercom.com/installing-intercom/web/methods/#intercomstartchecklist-checklistid}
+   */
+   startChecklist: (checklistId: number) => void;
   /**
    * Submits an event, this will associate the event with the currently
    * tracked visitor, lead or user and send it to Intercom

From 1505878cc6e193cde7402e569bd62bf3f2fba7ee Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 10:46:07 +0000
Subject: [PATCH 2/7] Add start checklist to README.md

---
 README.md                             | 4 ++++
 packages/react-use-intercom/README.md | 4 ++++
 2 files changed, 8 insertions(+)

diff --git a/README.md b/README.md
index b95c2f2..7c34d69 100644
--- a/README.md
+++ b/README.md
@@ -144,6 +144,7 @@ Used to retrieve all methods bundled with Intercom. These are based on the offic
 | showNewMessage  | (content?: string) => void                 | shows the Messenger as if a new conversation was just created. If `content` is passed, it will fill in the message composer         |
 | getVisitorId    | () => string                               | gets the visitor id                                                                                                                 |
 | startTour       | (tourId: number) => void                   | starts a tour based on the `tourId`                                                                                                 |
+| startChecklist       | (checklistId: number) => void                   | starts a checklist based on the `checklistId`                                                                                                 |
 | trackEvent      | (event: string, metaData?: object) => void | submits an `event` with optional `metaData`      
 | showArticle      | (articleId: string) => void | opens the Messenger with the specified article by `articleId`
 | startSurvey      | (surveyId: number) => void | Trigger a survey in the Messenger by `surveyId`
@@ -175,6 +176,7 @@ const HomePage = () => {
     showNewMessage,
     getVisitorId,
     startTour,
+    startChecklist,
     trackEvent,
     showArticle,
     startSurvey,
@@ -187,6 +189,7 @@ const HomePage = () => {
   const handleNewMessagesWithContent = () => showNewMessage('content');
   const handleGetVisitorId = () => console.log(getVisitorId());
   const handleStartTour = () => startTour(123);
+  const handleStartChecklist= () => startChecklist(456);
   const handleTrackEvent = () => trackEvent('invited-friend');
   const handleTrackEventWithMetaData = () =>
     trackEvent('invited-frind', {
@@ -213,6 +216,7 @@ const HomePage = () => {
       </button>
       <button onClick={handleGetVisitorId}>Get visitor id</button>
       <button onClick={handleStartTour}>Start tour</button>
+      <button onClick={handleStartChecklist}>Start checklist</button>
       <button onClick={handleTrackEvent}>Track event</button>
       <button onClick={handleTrackEventWithMetaData}>
         Track event with metadata
diff --git a/packages/react-use-intercom/README.md b/packages/react-use-intercom/README.md
index b95c2f2..6de20b7 100644
--- a/packages/react-use-intercom/README.md
+++ b/packages/react-use-intercom/README.md
@@ -144,6 +144,7 @@ Used to retrieve all methods bundled with Intercom. These are based on the offic
 | showNewMessage  | (content?: string) => void                 | shows the Messenger as if a new conversation was just created. If `content` is passed, it will fill in the message composer         |
 | getVisitorId    | () => string                               | gets the visitor id                                                                                                                 |
 | startTour       | (tourId: number) => void                   | starts a tour based on the `tourId`                                                                                                 |
+| startChecklist       | (checklistId: number) => void                   | starts a checklist based on the `checklistId`                                                                                                 |
 | trackEvent      | (event: string, metaData?: object) => void | submits an `event` with optional `metaData`      
 | showArticle      | (articleId: string) => void | opens the Messenger with the specified article by `articleId`
 | startSurvey      | (surveyId: number) => void | Trigger a survey in the Messenger by `surveyId`
@@ -175,6 +176,7 @@ const HomePage = () => {
     showNewMessage,
     getVisitorId,
     startTour,
+    startChecklist,
     trackEvent,
     showArticle,
     startSurvey,
@@ -187,6 +189,7 @@ const HomePage = () => {
   const handleNewMessagesWithContent = () => showNewMessage('content');
   const handleGetVisitorId = () => console.log(getVisitorId());
   const handleStartTour = () => startTour(123);
+  const handleStartChecklist = () => startChecklist(456);
   const handleTrackEvent = () => trackEvent('invited-friend');
   const handleTrackEventWithMetaData = () =>
     trackEvent('invited-frind', {
@@ -213,6 +216,7 @@ const HomePage = () => {
       </button>
       <button onClick={handleGetVisitorId}>Get visitor id</button>
       <button onClick={handleStartTour}>Start tour</button>
+      <button onClick={handleStartChecklist}>Start checklist</button>
       <button onClick={handleTrackEvent}>Track event</button>
       <button onClick={handleTrackEventWithMetaData}>
         Track event with metadata

From 07465f45d45dd40f4ecf92b1b932b0d09dd248c4 Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 15:32:09 +0000
Subject: [PATCH 3/7] Minor fix

---
 packages/react-use-intercom/src/types.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/react-use-intercom/src/types.ts b/packages/react-use-intercom/src/types.ts
index aa6c38f..2833be7 100644
--- a/packages/react-use-intercom/src/types.ts
+++ b/packages/react-use-intercom/src/types.ts
@@ -377,7 +377,7 @@ export type IntercomContextValues = {
    * of the tour editor.
    *
    * @remarks Please note that checklists shown via this API must be published.
-   * If you're calling this API using an invalid tour id, nothing will happen.
+   * If you're calling this API using an invalid checklist id, nothing will happen.
    *
    * @see {@link https://developers.intercom.com/installing-intercom/web/methods/#intercomstartchecklist-checklistid}
    */

From f5b8983960a8637ace07ccb7798498f6dfe6c051 Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 15:37:37 +0000
Subject: [PATCH 4/7] Run lint --fix

---
 packages/react-use-intercom/src/types.ts | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/react-use-intercom/src/types.ts b/packages/react-use-intercom/src/types.ts
index 2833be7..2f12c90 100644
--- a/packages/react-use-intercom/src/types.ts
+++ b/packages/react-use-intercom/src/types.ts
@@ -369,7 +369,7 @@ export type IntercomContextValues = {
    * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomstarttour-tourid}
    */
   startTour: (tourId: number) => void;
-   /**
+  /**
    * Triggers a checklist based on an action a user or visitor takes in your site or application,
    * You need to call this method with the id of the checklist you wish to show.
    *
@@ -381,7 +381,7 @@ export type IntercomContextValues = {
    *
    * @see {@link https://developers.intercom.com/installing-intercom/web/methods/#intercomstartchecklist-checklistid}
    */
-   startChecklist: (checklistId: number) => void;
+  startChecklist: (checklistId: number) => void;
   /**
    * Submits an event, this will associate the event with the currently
    * tracked visitor, lead or user and send it to Intercom

From 4aac5a9911b5a177a5abc800175698aa029ea33f Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 15:42:35 +0000
Subject: [PATCH 5/7] Changeset

---
 .changeset/lazy-countries-obey.md | 5 +++++
 1 file changed, 5 insertions(+)
 create mode 100644 .changeset/lazy-countries-obey.md

diff --git a/.changeset/lazy-countries-obey.md b/.changeset/lazy-countries-obey.md
new file mode 100644
index 0000000..8995b33
--- /dev/null
+++ b/.changeset/lazy-countries-obey.md
@@ -0,0 +1,5 @@
+---
+'react-use-intercom': minor
+---
+
+Expose startChecklist method in useIntercom hook

From b5a1e7ab1fb70fd94ea91d12546abf779a4e9ffa Mon Sep 17 00:00:00 2001
From: Jose10go <49805918+Jose10go@users.noreply.github.com>
Date: Mon, 18 Dec 2023 15:51:27 +0000
Subject: [PATCH 6/7] Revert change

---
 packages/react-use-intercom/src/types.ts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/packages/react-use-intercom/src/types.ts b/packages/react-use-intercom/src/types.ts
index 2f12c90..5330146 100644
--- a/packages/react-use-intercom/src/types.ts
+++ b/packages/react-use-intercom/src/types.ts
@@ -366,7 +366,7 @@ export type IntercomContextValues = {
    * the “Use tour everywhere” section must be turned on.
    * If you're calling this API using an invalid tour id, nothing will happen.
    *
-   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomstarttour-tourid}
+   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#section-intercomstarttour-tourid}
    */
   startTour: (tourId: number) => void;
   /**

From 37de9620a22bc80b1ca048c7ba3defaf7145b718 Mon Sep 17 00:00:00 2001
From: devrnt <devrient.jonas@gmail.com>
Date: Mon, 18 Dec 2023 17:29:34 +0100
Subject: [PATCH 7/7] Format jsdoc

---
 packages/react-use-intercom/src/types.ts | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/packages/react-use-intercom/src/types.ts b/packages/react-use-intercom/src/types.ts
index 5330146..f1286b8 100644
--- a/packages/react-use-intercom/src/types.ts
+++ b/packages/react-use-intercom/src/types.ts
@@ -366,7 +366,7 @@ export type IntercomContextValues = {
    * the “Use tour everywhere” section must be turned on.
    * If you're calling this API using an invalid tour id, nothing will happen.
    *
-   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#section-intercomstarttour-tourid}
+   * @see {@link https://developers.intercom.com/installing-intercom/docs/intercom-javascript#intercomstarttour-tourid}
    */
   startTour: (tourId: number) => void;
   /**
@@ -377,7 +377,7 @@ export type IntercomContextValues = {
    * of the tour editor.
    *
    * @remarks Please note that checklists shown via this API must be published.
-   * If you're calling this API using an invalid checklist id, nothing will happen.
+   * If you're calling this API using an invalid tour id, nothing will happen.
    *
    * @see {@link https://developers.intercom.com/installing-intercom/web/methods/#intercomstartchecklist-checklistid}
    */