intercom-client 6.2.0 → 6.4.0

package/dist/api/resources/unstable/resources/aiAgent/types/AiAgent.d.ts

@@ -0,0 +1,35 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../../../index";
+/**
+ * Data related to AI Agent involvement in the conversation.
+ */
+export interface AiAgent {
+    /** The type of the source that triggered AI Agent involvement in the conversation. */
+    source_type?: AiAgent.SourceType;
+    /** The title of the source that triggered AI Agent involvement in the conversation. If this is `essentials_plan_setup` then it will return `null`. */
+    source_title?: string;
+    /** The type of the last answer delivered by AI Agent. If no answer was delivered then this will return `null` */
+    last_answer_type?: string;
+    /** The resolution state of AI Agent. If no AI or custom answer has been delivered then this will return `null`. */
+    resolution_state?: string;
+    /** The customer satisfaction rating given to AI Agent, from 1-5. */
+    rating?: number;
+    /** The customer satisfaction rating remark given to AI Agent. */
+    rating_remark?: string;
+    content_sources?: Intercom.unstable.ContentSourcesList;
+}
+export declare namespace AiAgent {
+    /**
+     * The type of the source that triggered AI Agent involvement in the conversation.
+     */
+    type SourceType = "essentials_plan_setup" | "profile" | "workflow" | "workflow_preview" | "fin_preview";
+    const SourceType: {
+        readonly EssentialsPlanSetup: "essentials_plan_setup";
+        readonly Profile: "profile";
+        readonly Workflow: "workflow";
+        readonly WorkflowPreview: "workflow_preview";
+        readonly FinPreview: "fin_preview";
+    };
+}

package/dist/api/resources/unstable/resources/aiAgent/types/AiAgent.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AiAgent = void 0;
+var AiAgent;
+(function (AiAgent) {
+    AiAgent.SourceType = {
+        EssentialsPlanSetup: "essentials_plan_setup",
+        Profile: "profile",
+        Workflow: "workflow",
+        WorkflowPreview: "workflow_preview",
+        FinPreview: "fin_preview",
+    };
+})(AiAgent || (exports.AiAgent = AiAgent = {}));

package/dist/api/resources/unstable/resources/aiAgent/types/index.d.ts

@@ -0,0 +1 @@
+export * from "./AiAgent";

package/dist/api/resources/unstable/resources/aiAgent/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./AiAgent"), exports);

package/dist/api/resources/unstable/resources/aiContent/client/Client.d.ts

@@ -0,0 +1,202 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as Intercom from "../../../../../index";
+export declare namespace AiContent {
+    interface Options {
+        environment?: core.Supplier<environments.IntercomEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+        /** Override the Intercom-Version header */
+        version?: "1.0" | "1.1" | "1.2" | "1.3" | "1.4" | "2.0" | "2.1" | "2.2" | "2.3" | "2.4" | "2.5" | "2.6" | "2.7" | "2.8" | "2.9" | "2.10" | "2.11" | "Unstable";
+    }
+}
+/**
+ * With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.
+ *
+ * &nbsp;
+ *
+ * *External Pages* are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.
+ *
+ * &nbsp;
+ *
+ * *Content Import Sources* are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.
+ *
+ * &nbsp;
+ *
+ * You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an *external_id* parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",
+ */
+export declare class AiContent {
+    protected readonly _options: AiContent.Options;
+    constructor(_options?: AiContent.Options);
+    /**
+     * You can retrieve a list of all content import sources for a workspace.
+     *
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.listContentImportSources()
+     */
+    listContentImportSources(requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ContentImportSourcesList>;
+    private __listContentImportSources;
+    /**
+     * You can create a new content import source by sending a POST request to this endpoint.
+     *
+     * @param {Intercom.unstable.CreateContentImportSourceRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.createContentImportSource({
+     *         url: "https://www.example.com"
+     *     })
+     */
+    createContentImportSource(request: Intercom.unstable.CreateContentImportSourceRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ContentImportSource>;
+    private __createContentImportSource;
+    /**
+     * @param {Intercom.unstable.GetContentImportSourceRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.getContentImportSource({
+     *         id: "id"
+     *     })
+     */
+    getContentImportSource(request: Intercom.unstable.GetContentImportSourceRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ContentImportSource>;
+    private __getContentImportSource;
+    /**
+     * You can update an existing content import source.
+     *
+     * @param {Intercom.unstable.UpdateContentImportSourceRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.updateContentImportSource({
+     *         id: "id",
+     *         sync_behavior: "api",
+     *         url: "https://www.example.com"
+     *     })
+     */
+    updateContentImportSource(request: Intercom.unstable.UpdateContentImportSourceRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ContentImportSource>;
+    private __updateContentImportSource;
+    /**
+     * You can delete a content import source by making a DELETE request this endpoint. This will also delete all external pages that were imported from this source.
+     *
+     * @param {Intercom.unstable.DeleteContentImportSourceRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.deleteContentImportSource({
+     *         id: "id"
+     *     })
+     */
+    deleteContentImportSource(request: Intercom.unstable.DeleteContentImportSourceRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<void>;
+    private __deleteContentImportSource;
+    /**
+     * You can retrieve a list of all external pages for a workspace.
+     *
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.listExternalPages()
+     */
+    listExternalPages(requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ExternalPagesList>;
+    private __listExternalPages;
+    /**
+     * You can create a new external page by sending a POST request to this endpoint. If an external page already exists with the specified source_id and external_id, it will be updated instead.
+     *
+     * @param {Intercom.unstable.CreateExternalPageRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.createExternalPage({
+     *         title: "Test",
+     *         html: "<html><body><h1>Test</h1></body></html>",
+     *         url: "https://www.example.com",
+     *         source_id: 44,
+     *         external_id: "abc1234"
+     *     })
+     */
+    createExternalPage(request: Intercom.unstable.CreateExternalPageRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ExternalPage>;
+    private __createExternalPage;
+    /**
+     * You can retrieve an external page.
+     *
+     * @param {Intercom.unstable.GetExternalPageRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.getExternalPage({
+     *         id: "id"
+     *     })
+     */
+    getExternalPage(request: Intercom.unstable.GetExternalPageRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ExternalPage>;
+    private __getExternalPage;
+    /**
+     * You can update an existing external page (if it was created via the API).
+     *
+     * @param {Intercom.unstable.UpdateExternalPageRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.updateExternalPage({
+     *         id: "id",
+     *         title: "Test",
+     *         html: "<html><body><h1>Test</h1></body></html>",
+     *         url: "https://www.example.com",
+     *         source_id: 47,
+     *         external_id: "5678"
+     *     })
+     */
+    updateExternalPage(request: Intercom.unstable.UpdateExternalPageRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ExternalPage>;
+    private __updateExternalPage;
+    /**
+     * Sending a DELETE request for an external page will remove it from the content library UI and from being used for AI answers.
+     *
+     * @param {Intercom.unstable.DeleteExternalPageRequest} request
+     * @param {AiContent.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.unstable.UnauthorizedError}
+     *
+     * @example
+     *     await client.unstable.aiContent.deleteExternalPage({
+     *         id: "id"
+     *     })
+     */
+    deleteExternalPage(request: Intercom.unstable.DeleteExternalPageRequest, requestOptions?: AiContent.RequestOptions): core.HttpResponsePromise<Intercom.unstable.ExternalPage>;
+    private __deleteExternalPage;
+    protected _getAuthorizationHeader(): Promise<string>;
+}