intercom-client 5.0.0 → 6.0.0-alpha1

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

@@ -0,0 +1,18 @@
+"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("./AiAgentSourceType"), exports);
+__exportStar(require("./AiAgent"), exports);

package/api/resources/aiContentSource/index.d.ts

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

package/api/resources/aiContentSource/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("./types"), exports);

package/api/resources/aiContentSource/types/ContentSource.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Intercom from "../../../index";
+/**
+ * The content source used by AI Agent in the conversation.
+ */
+export interface ContentSource {
+    /** The type of the content source. */
+    content_type?: Intercom.ContentSourceContentType;
+    /** The internal URL linking to the content source for teammates. */
+    url?: string;
+    /** The title of the content source. */
+    title?: string;
+    /** The ISO 639 language code of the content source. */
+    locale?: string;
+}

package/api/resources/aiContentSource/types/ContentSource.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/aiContentSource/types/ContentSourceContentType.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+/**
+ * The type of the content source.
+ */
+export declare type ContentSourceContentType = "file" | "article" | "external_content" | "content_snippet" | "workflow_connector_action";
+export declare const ContentSourceContentType: {
+    readonly File: "file";
+    readonly Article: "article";
+    readonly ExternalContent: "external_content";
+    readonly ContentSnippet: "content_snippet";
+    readonly WorkflowConnectorAction: "workflow_connector_action";
+};

package/api/resources/aiContentSource/types/ContentSourceContentType.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentSourceContentType = void 0;
+exports.ContentSourceContentType = {
+    File: "file",
+    Article: "article",
+    ExternalContent: "external_content",
+    ContentSnippet: "content_snippet",
+    WorkflowConnectorAction: "workflow_connector_action",
+};

package/api/resources/aiContentSource/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./ContentSourceContentType";
+export * from "./ContentSource";

package/api/resources/aiContentSource/types/index.js

@@ -0,0 +1,18 @@
+"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("./ContentSourceContentType"), exports);
+__exportStar(require("./ContentSource"), exports);

package/api/resources/articles/client/Client.d.ts

@@ -0,0 +1,142 @@
+/**
+ * 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 Articles {
+    interface Options {
+        environment?: core.Supplier<environments.IntercomEnvironment | 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;
+        /** 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";
+    }
+}
+/**
+ * Everything about your Articles
+ */
+export declare class Articles {
+    protected readonly _options: Articles.Options;
+    constructor(_options?: Articles.Options);
+    /**
+     * You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.
+     *
+     * > 📘 How are the articles sorted and ordered?
+     * >
+     * > Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.
+     *
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.articles.list()
+     */
+    list(requestOptions?: Articles.RequestOptions): Promise<Intercom.ArticleList>;
+    /**
+     * You can create a new article by making a POST request to `https://api.intercom.io/articles`.
+     *
+     * @param {Intercom.CreateArticleRequest} request
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.BadRequestError}
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.articles.create({
+     *         title: "Thanks for everything",
+     *         description: "Description of the Article",
+     *         body: "Body of the Article",
+     *         author_id: 991267407,
+     *         state: Intercom.CreateArticleRequestState.Published,
+     *         parent_id: 145,
+     *         parent_type: "collection",
+     *         translated_content: {
+     *             fr: {
+     *                 title: "Merci pour tout",
+     *                 description: "Description de l'article",
+     *                 body: "Corps de l'article",
+     *                 author_id: 991267407,
+     *                 state: Intercom.ArticleContentState.Published
+     *             }
+     *         }
+     *     })
+     *
+     * @example
+     *     await client.articles.create({
+     *         title: "Thanks for everything",
+     *         description: "Description of the Article",
+     *         body: "Body of the Article",
+     *         author_id: 1295,
+     *         state: Intercom.CreateArticleRequestState.Published
+     *     })
+     */
+    create(request?: Intercom.CreateArticleRequest, requestOptions?: Articles.RequestOptions): Promise<Intercom.Article>;
+    /**
+     * You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.
+     *
+     * @param {number} id - The unique identifier for the article which is given by Intercom.
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.articles.find(1)
+     */
+    find(id: number, requestOptions?: Articles.RequestOptions): Promise<Intercom.Article>;
+    /**
+     * You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`.
+     *
+     * @param {number} id - The unique identifier for the article which is given by Intercom.
+     * @param {Intercom.UpdateArticleRequest} request
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.articles.update(1, {
+     *         title: "Christmas is here!",
+     *         body: "<p>New gifts in store for the jolly season</p>"
+     *     })
+     */
+    update(id: number, request?: Intercom.UpdateArticleRequest, requestOptions?: Articles.RequestOptions): Promise<Intercom.Article>;
+    /**
+     * You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`.
+     *
+     * @param {number} id - The unique identifier for the article which is given by Intercom.
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     * @throws {@link Intercom.NotFoundError}
+     *
+     * @example
+     *     await client.articles.delete(1)
+     */
+    delete(id: number, requestOptions?: Articles.RequestOptions): Promise<Intercom.DeletedArticleObject>;
+    /**
+     * You can search for articles by making a GET request to `https://api.intercom.io/articles/search`.
+     *
+     * @param {Intercom.ArticlesSearchRequest} request
+     * @param {Articles.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Intercom.UnauthorizedError}
+     *
+     * @example
+     *     await client.articles.search()
+     */
+    search(request?: Intercom.ArticlesSearchRequest, requestOptions?: Articles.RequestOptions): Promise<Intercom.ArticleSearchResponse>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}