Add agent availability fields to Preview API spec

descriptions/0/api.intercom.io.yaml

@@ -2629,6 +2629,9 @@ paths:
                       audience_ids:
                       - 1
                       - 2
+                      ai_chatbot_availability: true
+                      ai_copilot_availability: true
+                      ai_sales_agent_availability: true
               schema:
                 "$ref": "#/components/schemas/internal_article_list"
         '401':
@@ -2674,6 +2677,9 @@ paths:
                     audience_ids:
                     - 1
                     - 2
+                    ai_chatbot_availability: true
+                    ai_copilot_availability: true
+                    ai_sales_agent_availability: true
               schema:
                 "$ref": "#/components/schemas/internal_article"
         '400':
@@ -2777,6 +2783,9 @@ paths:
                     audience_ids:
                     - 1
                     - 2
+                    ai_chatbot_availability: true
+                    ai_copilot_availability: true
+                    ai_sales_agent_availability: true
               schema:
                 "$ref": "#/components/schemas/internal_article"
         '404':
@@ -2843,6 +2852,9 @@ paths:
                     audience_ids:
                     - 1
                     - 2
+                    ai_chatbot_availability: true
+                    ai_copilot_availability: true
+                    ai_sales_agent_availability: true
               schema:
                 "$ref": "#/components/schemas/internal_article"
         '404':
@@ -21286,6 +21298,18 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the internal article is available for AI Chatbot (Fin).
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the internal article is available for AI Copilot.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the internal article is available for AI Sales Agent.
+          example: true
     article_search_highlights:
       title: Article Search Highlights
       type: object
@@ -23192,24 +23216,27 @@ components:
           example: "# How to reset your password\n\nNavigate to Settings > Security > Reset password.\n"
         chatbot_availability:
           type: integer
-          description: Whether this snippet is available for Fin (1 = on, 0 = off).
+          deprecated: true
+          description: Deprecated. Use ai_chatbot_availability instead. Whether this
+            snippet is available for Fin (1 = on, 0 = off).
           example: 1
         copilot_availability:
           type: integer
-          description: Whether this snippet is available for Copilot (1 = on, 0 =
-            off).
+          deprecated: true
+          description: Deprecated. Use ai_copilot_availability instead. Whether this
+            snippet is available for Copilot (1 = on, 0 = off).
           example: 1
         ai_chatbot_availability:
           type: boolean
-          description: Whether this snippet is available for AI Chatbot.
+          description: Whether the content snippet is available for AI Chatbot (Fin).
           example: true
         ai_copilot_availability:
           type: boolean
-          description: Whether this snippet is available for AI Copilot.
+          description: Whether the content snippet is available for AI Copilot.
           example: true
         ai_sales_agent_availability:
           type: boolean
-          description: Whether this snippet is available for AI Sales Agent.
+          description: Whether the content snippet is available for AI Sales Agent.
           example: true
         created_at:
           type: integer
@@ -23309,6 +23336,24 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Chatbot
+            (Fin). Defaults to false.
+          default: false
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Copilot.
+            Defaults to false.
+          default: false
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Sales
+            Agent. Defaults to false.
+          default: false
+          example: true
     content_snippet_update_request:
       title: Update Content Snippet Request
       type: object
@@ -23354,6 +23399,20 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Chatbot
+            (Fin).
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Copilot.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the content snippet should be available for AI Sales
+            Agent.
+          example: true
     conversation_list_item:
       title: Conversation List Item
       type: object
@@ -24375,6 +24434,21 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the article should be available for AI Chatbot (Fin).
+            For multilingual articles, this sets the default language's availability.
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the article should be available for AI Copilot. For
+            multilingual articles, this sets the default language's availability.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the article should be available for AI Sales Agent.
+            For multilingual articles, this sets the default language's availability.
+          example: true
       required:
       - title
       - author_id
@@ -24422,6 +24496,24 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Chatbot
+            (Fin). Defaults to false.
+          default: false
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Copilot.
+            Defaults to false.
+          default: false
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Sales
+            Agent. Defaults to false.
+          default: false
+          example: true
       required:
       - title
       - owner_id
@@ -24831,6 +24923,12 @@ components:
             by AI Copilot. Will not default when updating an existing external page.
           default: false
           example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the external page should be used to answer questions
+            by AI Sales Agent. Will not default when updating an existing external page.
+          default: false
+          example: true
         locale:
           type: string
           description: Always en
@@ -27916,8 +28014,8 @@ components:
           example: true
         fin_availability:
           type: boolean
-          description: Deprecated. Use ai_agent_availability and ai_copilot_availability
-            instead.
+          description: Deprecated. Use ai_agent_availability, ai_copilot_availability,
+            and ai_sales_agent_availability instead.
           example: true
         locale:
           type: string
@@ -31242,6 +31340,21 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the article should be available for AI Chatbot (Fin).
+            For multilingual articles, this sets the default language's availability.
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the article should be available for AI Copilot. For
+            multilingual articles, this sets the default language's availability.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the article should be available for AI Sales Agent.
+            For multilingual articles, this sets the default language's availability.
+          example: true
     update_internal_article_request:
       description: You can Update an Internal Article
       type: object
@@ -31286,6 +31399,20 @@ components:
           example:
           - 1
           - 2
+        ai_chatbot_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Chatbot
+            (Fin).
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Copilot.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the internal article should be available for AI Sales
+            Agent.
+          example: true
     update_collection_request:
       description: You can update a collection
       type: object
@@ -31496,11 +31623,25 @@ components:
           description: The URL of the external page. This will be used by Fin to link
             end users to the page it based its answer on.
           example: https://help.example.com/en/articles/1234-getting-started
-        fin_availability:
+        ai_agent_availability:
           type: boolean
           description: Whether the external page should be used to answer questions
-            by Fin.
-          default: true
+            by AI Agent.
+          example: true
+        ai_copilot_availability:
+          type: boolean
+          description: Whether the external page should be used to answer questions
+            by AI Copilot.
+          example: true
+        ai_sales_agent_availability:
+          type: boolean
+          description: Whether the external page should be used to answer questions
+            by AI Sales Agent.
+          example: true
+        fin_availability:
+          type: boolean
+          description: Deprecated. Use ai_agent_availability, ai_copilot_availability,
+            and ai_sales_agent_availability instead.
           example: true
         locale:
           type: string